Element.getLayoutUsage (Method)
Returns a query specifying the pages and templates on which the specified layout is used.
Returns:
Element_GetLayoutUsage_Results (rowlimitedquery)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
layoutID | ID | Required | The unique ID of the layout. |
elementState | ActiveDeleted | Optional. Defaults to an empty string. | |
limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting. |
subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites. |
includeChildSubsites | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true tells CommonSpot to include all of a subsite's children when searching for usage information. |
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