ContainerElement.getContainerLayout (Method)

Returns structure with two rows arrays that contain information about the grid layout rows defined and elements.

Returns:

ContainerElement_GetContainerLayout_Result (struct)

Each row of the returned query results has the following fields:

Field Name Type Description
elementRows ContainerElement_GetContainerElementRows_Rows Elements of container arranged in rows based on their data_scheduled_items rownumber and columnnumber values.
layoutRows ContainerElement_GetGridRows Array of rows defined for the container.
unassignedElements ContainerElement_GetContainerElementRows_Rows Elements that are having rownumber and columnnumber beyond the number of grid rows defined for the Container element.

Arguments:

Name Type Required Description
pageID PageID Required ID of the page on which the container is placed.
containerInstanceID ContainerElementInstanceID Required A container element's instance ID.
includeUnAssigned Boolean Optional. Defaults to '0'. Boolean flag when true, the command returns the elements that are not rendered on page due to the removal of the row to which they initially belonged to.
commandContext CommandContext Optional. Defaults to 'layout'. Context in which the command is called.

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