Element (Component)

The Element object manages elements that you place on a page when special processing needs occur. For example, Element methods let you manage ghost text, insert XML publications, use render handlers, and so on.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Methods marked below with [C] may be customized at the site level

Methods:

allowNewXMLPublication [L] [C]	Returns a Boolean flag which when true indicates that users can add new XML Publications for an element.
changeXMLPublicationState [L] [C]	Changes the XML publication state of an element on a page to 'Active' or 'Inactive'.
checkPropertiesForCloneLayout [C]	Returns an structure describing the properties which can be cloned for the specified element.
cloneLayout [L] [C]	Clones the specified layout.
deleteLayout [L] [C]	Deletes the specified layout.
deleteSavedElement [L] [C]	Deletes a saved element. CommonSpot does not remove any elements created from this element. It only removes the element's definition.
deleteXMLPublication [L] [C]	Deletes an XML Publication.
getDisplayTemplateName [C]
getFieldMappings [C]	Returns one or more structures, each containing information about mapping of the custom element's field to the render handler.
getGhostText [C]	Returns a structure containing information about ghost text; for example, the text, its module path, and so on.
getGhostTextModules [C]	Returns one or more structures, each containing information for a GhostText module (.cfm file). These modules reside within the 'renderhandlers/nodata/' directory.
getInfo [C]	Returns a structure containing information about type and layout properties for the element.
getLayout [C]	Returns the selected layout type which will either be the ID of a render handler, the ID of a display template, or -1 for the Standard Rendering.
getLayoutList [C]	Returns one or more structures, each containing information about the display templates/render handlers registered for an element.
getLayoutUsage [C]	Returns a query specifying the pages and templates on which the specified layout is used.
getList [C]	Returns one or more structures, each containing information about each element type; for example, 'Name', 'Description'.'CategoryName', 'CategoryID', and so on.
getRenderHandlerModules [C]	Returns zero or more structures, each containing information about render handler modules. The results are filtered by this method's 'type' argument.
getRenderHandlerName [C]	Returns the name for the given elementType/module combination.
getResourceDependencies [C]	Returns a structure whose members contain resource dependencies information for the provided module.
getResourceDependenciesFromFile [C]	Returns a structure whose members contain resource dependencies information for the provided module path.
getStandardElementMappingFields [C]	Returns zero or more structures, each containing information about a standard element's fields available for mapping.
getUsageInfo [C]	Returns zero or more structures, each containing information on each instance of an element type.
getUsageSummary [C]
getXMLPublicationDetail [C]	Returns a structure containing information about an XML publication definition; for example, 'Description', 'FeedCategoryName', 'KeywordList', and so on.
getXMLPublications [C]	Returns zero or more structures containing information describing the XML publications associated with an element; for example, 'Description', 'Name', 'State', and so on.
saveAsElement [L] [C]	Creates a new saved element from a source element.
saveFieldMappings [L] [C]	Creates or updates an element's render handler's field mappings.
saveGhostText [L] [C]	Either creates new ghost text or updates existing ghost text. Most of this information describes the renderer used to display this text.
saveRenderHandler [L] [C]	Creates or updates an element's render handler.
setDefaultLayout [L] [C]	Sets the specified layout as the default layout for the specified element type.
setLayout [L] [C]	Saves the selected layout type for an element.
setLayoutActivateState [L] [C]	Sets the Active/Inactive state for a layout.
updateElementInfo [L] [C]	Updates an element's name, description and categorization.
updateSavedLayout [L] [C]	Updates the specified layout.