This input field lets users enter text across multiple lines. Basic HTML formatting options are provided in a customisable toolbar. This field makes use of the browser's inbuilt rich-text editing.
If using this field to contribute article text via the iCM API, the HTML will automatically get cleaned up and unsupported elements removed when the form is submitted. This is intended to safeguard against poorly generated HTML being saved as article text. There's more information about the rules used when tidying text in the Text Editor Configuration article.
Properties
| Label | Description | Type Name |
|---|---|---|
| Label | The label for this field | LABEL |
| Show Label | Whether to show the label for this field or not. This property adds/removes a class on the field's label element. The styling itself is controlled by the site's stylesheet | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user in completing it. 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 | A default value for the field | DEFAULT |
| Placeholder | Any value entered into this property is used as an HTML 5 placeholder. This is a value that will appear in the field but will be cleared when a user enters something in the field. Unlike a default value, it will not be submitted as a value for the field. If a default value is supplied, the placeholder will not be seen unless the user clears the default value | PLACEHOLDER |
| 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 display width of the field. The value matches a CSS class, which actually sets the width | WIDTH |
| Height | The height of the field 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 |
| Controls | A space-separated list of controls to include in the toolbar. The full list is: bold, italic, underline, strikethrough, subscript, superscript, font, size, style, color, highlight, removeformat, bullets, numbering, outdent, indent, alignleft, center, alignright, justify, undo, redo, rule, image, link, unlink, cut, copy, paste, pastetext, print, source Use the pipe symbol | to separate controls in the editor toolbar. If you want to allow the user to paste into the field you must include 'pastetext' | CONTROLS |
| Styles | Block formatting options to be made available in the 'style' toolbar drop-down. Use the popup editor provided to specify one or more of the following pairs: Paragraph, p Code, pre Heading 1, H1 Heading 2, H2 Heading 3, H3 Heading 4, H4 Heading 5, H5 Heading 6, H6 | STYLES |
| Editor Stylesheet | An optional URL of a stylesheet that can be applied to the content. The example below uses this site's default CSS, eg /themes/chill/css/chill.css | CSS |
| Colours | A space separated list of the colours to be included in the colour popup used by the 'highlight' and 'color' toolbar items | COLOURS |
| Fonts | A comma separated list of font names | FONTS |
| Font Sizes | A comma separated list of numbers to include as font sizes | SIZES |
| 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 client-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| Default Function | A JavaScript function that can be used to calculate the default field value. This function is executed server-side when the field HTML is generated and is useful when the DEFAULT property is insufficient | DEFFUNC |
| Handlers | A JavaScript function that is executed client-side whenever the page loads, or the field value changes. This function is useful for modifying the values of other fields based on an entered value | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| 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 |
Share this page
