Element.getLayoutList (Method)
Returns one or more structures, each containing information about the display templates/render handlers registered for an element.
Returns:
Element_GetLayoutList_Results (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ActiveUsageCount | NonNegativeInteger | The count of active element instances that use this layout, 0 for standard layout. |
| BaseLayoutType | LayoutType_EmptyString | The base layout type from which this layout is derived. Either 'Standard', 'Render Handler', 'Display Template' or empty string. |
| BoundMetadataForms | MetadataFormIDList_EmptyString | A list of metadata formIDs bound to this render handler or empty string if none or is a display template. |
| CallsStandardRenderModule | Boolean | A boollean flag which when set to true indicates that this render handler calls the standard render handler. |
| DefaultDisplayTemplateID | DisplayTemplateID_0 | The ID of the display template which will be called by default by this render handler, or 0. |
| DeletedUsageCount | NonNegativeInteger | The count of deleted element instances that use this layout, 0 for standard layout. |
| Description | PlainText | The name of the display template/render handler. |
| HasFieldMappings | Boolean | Boolean flag which when set to true indicates that the layout has field mappings. |
| ID | ID_NEG1_NEG2 | ID of the render handler/display template. -1 for 'Standard Rendering ' and -2 for 'Default Rendering'. |
| IsActive | Boolean | Boolean flag which when set to true indicates that the render handler is active. Defaults to 1 for a display template. |
| IsDefault | Boolean | Boolean flag which when set to true indicates that this display template/render handler is the default. |
| IsFactory | Boolean | A boolean flag which when set to true indicates that this is a render handler that ships with CommonSpot. |
| IsLocked | Boolean | Boolean flag which when set to true indicates that this display template/render handler is locked. |
| IsPrivate | Boolean | Boolean flag which when set to true indicates that this display template is private to the current user. Defaults to 0 for a render handler. |
| IsXMLAware | Boolean | Boolean flag which when set to true indicates the render handler is XML aware. If it is XML aware, it can output its result in XML. Defaults to 0 for a display template. |
| LayoutType | LayoutType | The type of the layout. Either 'Standard', 'Render Handler', 'Display Template' or 'Saved layout'. |
| Name | PlainText_NonNull | The name of the display template/render handler. |
| PreviewImageHeight | NonNegativeInteger | The preview image's height in pixels. |
| PreviewImageID | ImageID_0 | The ID of the preview image. |
| PreviewImageServerURL | ServerRelativeURL_EmptyString | The url to the preview image or an empty string. |
| PreviewImageURL | ServerRelativeURL_EmptyString | The url to the preview image or an empty string. |
| PreviewImageWebPRenderFlag | Boolean | Boolean flag indicating if webP rendering is enabled or not for the preview image if provided. |
| PreviewImageWidth | NonNegativeInteger | The preview image's width in pixels. |
| RenderingModule | PlainText | The file name or full path to the render handler's module. Defaults to empty string for a display template. |
| RenderingModuleType | RenderHandlerModuleType_EmptyString | String identifying a render handler's module type, either 'Existing' or 'Explicit'. Defaults to empty string for a display template. |
| SavedLayoutFontProperties | Boolean | A boolean flag which when set to true indicates that Layout and Font properties are saved with the layout. Only applicable for saved layout. |
| SavedMetadataProperties | Boolean | A boolean flag which when set to true indicates that Metadata properties are saved with the layout. Only applicable for saved layout. |
| SavedStyleProperties | Boolean | A boolean flag which when set to true indicates that Style properties are saved with the layout. Only applicable for saved layout. |
| ShowFontColorPropertiesMenu | Boolean | Boolean flag which when set to true indicates that the Font & Color Properties menu is shown if this render handler is applied. Defaults to false for a display template. |
| ShowLayoutPropertiesMenu | Boolean | Boolean flag which when set to true indicates that the Layout Properties menu is shown if this render handler is applied. Defaults to true for a display template. |
| ShowMetadataPropertiesMenu | Boolean | A boolean flag which when set to true indicates that the Custom Metadata properties menu should be shown. |
| ShowStylePropertiesMenu | Boolean | Boolean flag which when set to true indicates that the Style Properties menu is shown if this render handler is applied. Defaults to true for a display template. |
| Type | RenderHandlerType_EmptyString | String identifying a render handler's type, as follows: 'CFML', 'URL' or 'XSLT'. Defaults to empty string for a display template. |
| UseCache | Boolean | Boolean flag which when set to true indicates that the cache is used. Defaults to false for a display template. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| elementTypeID | ElementTypeID | Required | ID of an element. |
| layoutID | ID_0_NEG1 | Optional. Defaults to '0'. | The unique ID of the layout to filter by, or negative one (-1) for the standard Rendering, or 0 for all layouts. |
| showInactive | Boolean | Optional. Defaults to '0'. | A boolean flag which when set to true indicates that inactive render handlers should be returned in the results. |
| layoutTypeFilter | LayoutType_All | Optional. Defaults to 'All'. | The type of layout ('Standard','RenderHandler','DisplayTemplate',or 'SavedLayout'),to filter by, or 'All' to return all layouts. |
| pageID | PageID_0 | Optional. Defaults to '0'. | |
| controlID | ControlID_0 | Optional. Defaults to '0'. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| 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 |
|---|---|
| 15026 | The specified layout is not valid for the specified element. |
Notes:
None