User Guide
1178 TextArea component
Using the TextArea component
You can use a TextArea component wherever you need a multiline text field. If you need a
single-line text field, use the Text I n pu t com pon e nt . For example, you could use a TextArea
component as a comment field in a form. You could set up a listener that checks if the field is
empty when a user tabs out of the field. That listener could display an error message
indicating that a comment must be entered in the field.
TextArea parameters
You can set the following authoring parameters for each TextArea component instance in the
Property inspector or the Component inspector (Window > Component Inspector menu
option):
editable indicates whether the TextArea component is editable (true) or not (false). The
default value is
true.
html indicates whether the text is formatted with HTML (true) or not (false). If HTML is
set to
true, you can format the text using the font tag. The default value is false.
text indicates the contents of the TextArea component. You cannot enter carriage returns in
the Property inspector or the Component inspector. The default value is "" (an empty string).
wordWrap indicates whether the text wraps (true) or not (false). The default value is true.
You can set the following additional parameters for each TextArea component instance in the
Component inspector (Window > Component Inspector):
maxChars is the maximum number of characters that the text area can contain. The default
value is
null (meaning unlimited).
restrict indicates the set of characters that a user can enter in the text area. The default value is
undefined. See “TextArea.restrict” on page 1199.
enabled is a Boolean value that indicates whether the component can receive focus and input.
The default value is
true.
password is a Boolean value that indicates whether the input is a password or other text that
should be hidden from view as it is typed. Flash hides the input characters with asterisks. The
default value is
false.
NOTE
If you create a TextArea using the createClassObject() method, the default value for
wordWrap is false.