This text area field uses the same editor as iCM uses to edit article text. It is, therefore, better suited to contributing article text than the standard Text Area - WYSIWYG field.
Note this field is currently only available for use on forms rendered in iCM, for example via iCM form shortcuts.
Properties
| Label | Description | Type Name |
|---|---|---|
| Label | The label for the field | LABEL |
| Show Label | Whether the label for this field will be visible on the form. Set to false to hide the field's label | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Required | Whether or not the field is required to have a value to pass validation | REQUIRED |
| Default | Set any content that should be displayed in the editor when it is first displayed. This may include HTML markup that is supported by this field's formatting options | DEFAULT |
| Error Message | The error message that will be displayed if this field fails its validation | ERRMSG |
| Error Message Function | A function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field can be used by adding the field's name between # characters. See Error Message Functions for more information. This field has the following error types:
| ERRMSGFUNC |
| Width | The editor's display width in pixels. Leave blank to set the width to "auto" ie to fill the available space | WIDTH |
| Height | The editor's display height in pixels. Leave blank to set the height to "auto" | HEIGHT |
| Searchable | Whether this field's value should be indexed by the search (the object collection if using the database save action and/or workflow process collection if starting a workflow process). This property is ignored if an External Type is specified for the form. In this case, the ability to search is determined by the searchable property of the type itself | SEARCHABLE |
| Content CSS | URL of the stylesheet that is used to style the editor content | CSS |
| Validation Function | A JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed browser-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| 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 |
| Read Only | Display the field as read only | READONLY |
| 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 26 February 2024
Share this page
