DatasheetElement.getViewColumns (Method)
Returns one or more structures, each containing information for how a column is used within a datasheet's view.
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 |
---|---|---|---|
pageID | RealPageID_NonBaseTemplate | Required | A page's ID. |
elementID | ControlID | Required | The datasheet element's control ID. |
viewName | PlainText_NonNull | Required | The name of the view for which CommonSpot retrieves information. |
versionID | VersionID_NEG1_NEG2 | Optional. Defaults to '-1'. | A datasheet element's version ID. |
filter | DatasheetElementGetViewColumnFilter | Optional. Defaults to 'Used'. | String identifying a view's usage; for example, used, unused, or all. |
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:
Code | Error Message |
---|---|
78000 | The specified view does not exist in the specified datasheet element. |
Notes:
None