Element.saveRenderHandler (Method)
Creates or updates an element's render handler.
Returns:
RenderHandlerID (integer)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| elementID | ElementTypeID | Required | An element's ID. |
| moduleID | RenderHandlerID_0 | Required | Updates a render handler. If this value is 0, CommonSpot creates a new render handler. |
| name | PlainText_NonNull_255 | Required | The render handler's name. |
| description | PlainText_2000 | Required | The render handler's description. |
| type | RenderHandlerType | Required | The render handler's type, which is either 'CFML', 'HTML', 'URL' or 'XSLT'. |
| renderingModule | ModulePath | Required | The render handler module's full path name. |
| useCache | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that the render handler can be cached. |
| isXMLAware | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that the render handler is XML aware. |
| showLayoutPropertiesMenu | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot shows the Layout Properties menu when this element's render handler is enabled. |
| showFontColorPropertiesMenu | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot can display the Font & Color Properties menu when this element's render handler is enabled. |
| showStylePropertiesMenu | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot can display the Style Properties menu when this element's render handler is enabled. |
| previewImageID | ImageID_0 | Optional. Defaults to '0'. | The ID of an existing image to use as the preview image, or 0 for the default. |
| callsStandardRenderModule | Boolean | Optional. Defaults to '0'. | Boolean flag when set as true indicates that the render handler calls standard render module to render the element. |
| defaultDisplayTemplateID | DisplayTemplateID_0 | Optional. Defaults to '0'. | The ID of the default DisplayTemplate. This argument is ignored, and should be set to zero, if callsStandardRenderModule = 0. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 15000 | A render handler with the name '$1' already exists for this element type. |
| 15001 | The selected $1 module '$2' is not valid. |
| 15012 | The render handler module is not valid. |
| 15013 | The element you specified does not support render handlers. |
Notes:
None