The guidance text field adds text to your form. HTML markup can be used, and basic field value substitution (using # characters) is also supported. Updating the value of a guidance text field in the handler function of another field lets you completely change the text that is displayed.
Don't use this field type to inject additional layout HTML, blank lines or extra spacing. The layout and styling should always be left to your site's style sheet.
Properties
| Label | Description | Type Name |
|---|---|---|
| Text | The guidance text to be displayed. This is the field's value. By default, plain text is assumed. If you want to include HTML markup set the Allow HTML setting below to true. The value of another field can be used by adding the field's name between # characters. The referenced field should have a value at the time the guidance text field is rendered | TEXT |
| Label | A label for the guidance text | LABEL |
| Justification | The justification of the guidance text. Either left, right, centred or fully justified | JUSTIFICATION |
| Show | Determines when the guidance text should be output. The following options are available: Always - the HTML will be displayed on your site and in read-only modes Form - the HTML will only be output when the form is being rendered on the site (in "standard" mode) Summary (Email) - the HTML will only be output when the form is rendered in read only mode, without controls, for example in emails | SHOW |
| Allow HTML | Whether HTML markup should be allowed. By default the guidance text is treated as plain text | ALLOWHTML |
| Default Function | A JavaScript function you can use to calculate the starting field value. This function is executed server-side when the field HTML is generated. See Common Field Properties for an example | DEFFUNC |
| Handlers | A JavaScript function that is executed browser-side whenever the page loads or the field value changes. See Common Field Properties for an example | HANDLERS |
| Additional Styling Modifier | An optional CSS modifier for the field. See Common Field Properties for an example | ADDITIONALSTYLINGMODIFIER |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
Last modified on 21 October 2024
Share this page
