GridRowLayout.getList (Method)
Returns a query of zero or more rows describing the defined grid row layouts for the site.
Returns:
GridRowLayout_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ClassOptions | PlainTextList_EmptyString | List of optional classes that are commonly used and contributors can apply to this row. |
| ColumnCount | NonNegativeInteger | Number of columns in the row. |
| DateLastModified | Datetime | Date and time when the row was last modified. |
| Description | String | Description of a row. |
| GridRowID | GridLayoutRowID | ID of a row defined in the grid layout. |
| InnerClassOptions | PlainTextList_EmptyString | List of optional classes that are commonly used and contributors can apply to this inner row. |
| InnerRowClasses | PlainTextList_EmptyString | List of classes that should be applied for the current inner row. |
| InnerRowClasses_AllowOverride | Boolean | Boolean flag when true, contributor can override the class values defined for this inner row. |
| InnerRowTag | GridLayoutTag_EmptyString | Tag for the inner row. |
| InnerRowTag_AllowOverride | Boolean | Boolean flag when true, contributor can override the value of rowtag defined for this inner row. |
| isActive | Boolean | Boolean flag when true means the row is active. |
| IsDefault | Boolean | Boolean flag if true mans the row is designated as default row for containers where no row layouts are defined. |
| isFactory | Boolean | Boolean flag if true mans the row is a factory inserted row. |
| Name | NonNullString_255 | Name of the row. |
| RowClasses | PlainTextList_EmptyString | List of classes that should be applied for the current row. |
| RowClasses_AllowOverride | Boolean | Boolean flag when true, contributor can override the class values defined for this row. |
| RowTag | GridLayoutTag | Tag for the row. |
| RowTag_AllowOverride | Boolean | Boolean flag when true, contributor can override the value of rowtag defined for this row. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to 'Begins With'. | A search operator or an empty string. Values for this argument can be 'Begins With', 'Contains', 'Ends With', or 'Equals'. |
| searchString | PlainText | Optional. Defaults to an empty string. | The value CommonSpot searches for. This value is usually a row title, description. |
| columnCount | NonNegativeInteger | Optional. Defaults to '0'. | Rows with given number of column count. |
| state | ActiveFilter | Optional. Defaults to 'All'. | Filter limiting a list of rows in a grid layout. All returns everything and Active will return only active rows. |
| rowType | GridRowType | Optional. Defaults to 'All'. | Type of grid rows to return. 'Factory' for factory rows, 'all' for all and 'userDefined' for grid rows created by user. |
| includeRowsWithNoColumns | Boolean | Optional. Defaults to '1'. | Boolean flag when true query returns the layout rows whose configuration is not complete yet. |
Context:
| License Requirements | None |
| 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