Element.getGhostText (Method)
Returns a structure containing information about ghost text; for example, the text, its module path, and so on.
Returns:
Element_GetGhostText_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| GhostText | String_NonNull_NoCFML_255 | The ghost text to be displayed for the element. |
| ModulePath | ModulePath_EmptyString | The full path of the module. This includes the file name. |
| ModuleType | GhostTextModuleType_EmptyString | A string describing the type of module if 'RenderingMode' is 'Custom Module'. |
| RenderingMode | GhostTextRenderingMode | A string indicating the ghost text's rendering mode, as follows: 'Standard' or 'Custom Module'. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| elementID | ElementTypeID | Required | An element's ID. |
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 |
|---|---|
| 15018 | The specified element does not support ghost text. |
Notes:
None