DatasheetElement.getFormColumns (Method)
Returns zero or more structures, each containing information about the columns in a simple form, custom element, or page result. If the 'formID' argument is set to 0, CommonSpot returns columns for a page result datasheet.
Returns:
DatasheetElement_GetColumns_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
ColumnID | PlainText_NonNull | The column's ID. If this is a simple form or a custom element, this is the field's numeric ID. Otherwise, this is a string that is the same as the 'Name' member. |
ColumnType | DatasheetColumnType | The column's type, which is 'Standard' or 'Action'. |
HeaderName | PlainText_255 | The column's header text. |
Name | PlainText_NonNull | The column's name. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
formID | CustomElement_SimpleForm_ID_0 | Required | The ID of a custom element of simple form. If this value is 0, CommonSpot retrieves information for all of a custom element or simple form's columns. |
Context:
License Requirements | Datasheet |
Permission Requirements | (none) |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None