GridRowLayout.getColumnInfo (Method)
Returns a query of zero or more rows describing the properties of a column defined in the grid layout row.
Returns:
GridRowLayout_GetColumns_Result_Row (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| AllowedElementTypes | ElementTypeIDList_EmptyString | List of element types that can be rendered in this column. |
| ClassOptions | PlainTextList_EmptyString | Commonly used classes that a contributor may apply for this columb. eg: margins, background etc attributes. |
| ColumnClasses | PlainTextList_EmptyString | List of class names to be used for this column. These classes control the width and offset of the column. |
| ColumnClasses_AllowOverride | Boolean | Boolean flag when true allows contributor to override the class definitions defined for this column. |
| ColumnID | GridLayoutColumnID | ID of the column defined for the row. |
| ColumnNumber | NonNegativeInteger | Order for this column in the row. |
| ColumnTag | GridLayoutTag | Tag for this column. |
| ColumnTag_AllowOverride | Boolean | Boolean flag when true allows contributor to override the tag defined for this column. |
| DateLastModified | Datetime | Date and time when the column was last modified. |
| GridRowID | GridLayoutRowID | ID of the row to which this column belong. |
| isFactory | Boolean | Boolean flag when true means this column is a factory row's column. |
| RowName | PlainText_255 | Name of the row to which current column belongs to. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| columnID | GridLayoutColumnID_0 | Optional. Defaults to '0'. | ID of the column whose details should be returned. |
| gridRowID | GridLayoutRowID_0 | Optional. Defaults to '0'. | ID of the grid row layout to which the column belongs. |
| columnNumber | NonNegativeInteger | Optional. Defaults to '0'. | Order for this column in the row. |
| ignoreWarnings | Boolean | Optional. Defaults to '0'. | Boolean flag when true, any error getting the row information results in command refusal throw. |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| 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