ContainerElement.getList (Method)
Returns a query describing the elements contained within the specified Container element.
Returns:
ContainerElement_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Action | NonNegativeInteger | The code for action of the element. |
| ActionGif | String_NoHTML | The icon name for action of the element. |
| ActionText | ActionState_EmptyString | The text for action of the element (i.e. 'Added'), or an empty string if the element is WIP or pending approval. |
| ColumnNumber | NonNegativeInteger | Index of the grid layout column in which this element should be displayed. |
| ElementInstanceID | ControlID | The ID of the element instance. |
| ElementInstanceName | PlainText_255 | The name given to the instance of the element, or an empty string if no name given. |
| ElementTypeID | ElementTypeID_0 | The ID of the element type (i.e. 36 for PageIndex). |
| ElementTypeName | PlainText_NonNull_255 | The type of the element (i.e. 'Page Index'). |
| ItemID | NonNegativeInteger | The ID of the item. |
| ItemPos | PositiveInteger | The position of the element. |
| RowNumber | NonNegativeInteger | Index of the grid layout row in which this element should be displayed. |
| VersionID | VersionID_0 | The version ID of the item. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_NonBaseTemplate | Required | The ID of the page or soft template on which the container element resides. |
| containerInstanceID | ContainerElementInstanceID | Required | A container element's instance ID. |
| rowNumber | NonNegativeInteger | Optional. Defaults to '0'. | Index of the row whose elements are to be returned. |
| columnNumber | NonNegativeInteger | Optional. Defaults to '0'. | Index of the column in the container. |
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:
| Code | Error Message |
|---|---|
| 1000301 | The element $1 does not exist on the specified page. |
Notes:
None