Toggle menu

Text Area - Basic

The Text Area field lets users enter plain text across multiple lines.

Properties

LabelDescriptionType Name
LabelThe label for this fieldLABEL
Show LabelWhether 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 stylesheetSHOWLABEL
HintAdditional 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 informationHINT
RequiredWhether or not the field is required to have a value to pass validationREQUIRED
DefaultA default value for the fieldDEFAULT
PlaceholderAny 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 valuePLACEHOLDER
AutocompleteAdds a HTML autocomplete attribute to the field, which may prompt the browser to suggest relevant values for the filed, based on past or preconfigured (in the browser) values for the field. See Common Field Properties for more informationAUTOCOMPLETE
Error MessageThe error message that will be displayed if this field fails its validationERRMSG
WidthThe display width of the field. The value matches a CSS class, which actually sets the widthWIDTH
SearchableWhether 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
Maximum LengthThe maximum number of characters that can be entered into the fieldMAXLENGTH
Maximum WordsThe maximum number of words that can be entered into the fieldMAXLENGTHWORDS
Show Count MessageWhether or not to show the character count. The field must also have a Maximum Length or Maximum Words set.

The character count properties below are handlebars templates. {{count}} will be either the number of characters or words remaining or over the limit, {{maxLength}} is the maximum length, and {{type}} will either be the words or characters - if both words and character maximums are set, the count message will display information about the word limit, but the field validation checks that both the character and word limits are met.

Note that new lines count as two characters
SHOWMAXLENGTHCOUNT
Count No JavaScript MessageA static message that will be displayed if JavaScript is disabled

You can enter up to <strong>{{maxLength}}</strong> {{type}}s
MAXLENGTHNOJSTEMPLATE
Count Within Limit MessageThe countdown message

You have <strong>{{count}}</strong> {{type}}{{#isnt count 1}}s{{/isnt}} remaining
MAXLENGTHWITHINLIMITTEMPLATE
Count Over Limit MessageThe message displayed if you are over the limit

You have <strong>{{count}}</strong> {{type}}{{#isnt count 1}}s{{/isnt}} too many
MAXLENGTHOVERLIMITTEMPLATE
RowsThe height in rows of the fieldROWS
Regular ExpressionA regular expression that will be used to validate the field. If the value does not match this expression, the field validation will fail.

Note that line feeds within the text area get converted (URL encoded) by the browser from \n (LF) to \r\n (CR + LF) on form submission
REGEX
Validation FunctionA 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-sideVALFUNC
Default FunctionA 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 insufficientDEFFUNC
HandlersA 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 valueHANDLERS
Read OnlyDisplay the field as read onlyREADONLY
Additional Styling ModifierAn optional CSS modifier for the field. See Common Field Properties for an exampleADDITIONALSTYLINGMODIFIER
DocumentationAdd 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 exampleDOCUMENTATION

Share this page

Facebook icon Twitter icon email icon

Print

print icon