DocumentTemplateTokenInfo
Information about a token found in a document template,
including metadata from custom token definitions when available.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | The token key used for form values (e.g. "Title", "Custom.InvoiceRef") |
The token key used for form values (e.g. "Title", "Custom.InvoiceRef") | ||
| label | string | Human-readable display label for the token (e.g. "Invoice Ref"). |
Human-readable display label for the token (e.g. "Invoice Ref"). | ||
| description | string | Optional description/prompt text for the token (from custom token definition) |
Optional description/prompt text for the token (from custom token definition) | ||
| defaultValue | string | Optional default value for the token (from custom token definition) |
Optional default value for the token (from custom token definition) | ||
| isCustomToken | boolean | Whether this token is a user-defined custom token (Custom.* prefix) |
Whether this token is a user-defined custom token (Custom.* prefix) | ||
| displayWidth | string | Preset display width for the input (from custom token definition). Null defaults to Full. |
Preset display width for the input (from custom token definition). Null defaults to Full. | ||
| lines | integer | Number of visible text lines (from custom token definition). Null renders a single-line input. |
Number of visible text lines (from custom token definition). Null renders a single-line input. | ||
| isRichText | boolean | When true, the input renders as a rich text editor. The value will contain HTML. |
When true, the input renders as a rich text editor. The value will contain HTML. | ||
JSON Example
{
"name": "string",
"label": "string",
"description": "string",
"defaultValue": "string",
"isCustomToken": false
}