Text Area Screen Component

Introduction

The Text Area is an area into which the user can enter text using the keyboard. It allows multi-paragraph text, unlike the Text Field Screen Component.

Configuration Properties

Properties tab:

Rows ⁠— Vertical size of this Text Area (i.e. the number of visible text lines)
Columns ⁠— Horizontal size of this Text Area (i.e. the number of visible characters) based on the average width of characters.
Allow resizing ⁠— If this checkbox is selected, the text area can be resized on the screen.

Consider that the Allow resizing feature:n- is not supported in Internet Explorer/Edge browsers.n- is not available if the Use legacy Styles check box is selected.

Text If Disabled ⁠— If this checkbox is selected, and the Text Area is disabled, its content is shown as text only, with no frame.
Placeholder ⁠— Enter the text to be displayed on the Text Area if no value has been set.

If no value is entered into the Text Area, an empty string is submitted to the server.

Converter and Validators tab For information on converters, see the Converters and Validators section in the Screen Component: Configuration Properties article.

Actions tab For complete information on Actions, see the Events and Actions article.

Text Area Style Business Object

The Text Area Style Business Object allows applying consistent styling to all Text Area Screen Components.

States

The Text Area List Style Business Object has five different states:

Focused
Disabled
Error
ReadOnly

Styling Properties

These are the styling properties for the Text Area Style Business Object:

Text ⁠— Sets the style of the text to be displayed (font style, size, color and spacing between characters and lines).
Background ⁠— Sets the background color for the text area.
Border ⁠— Sets the color, thickness and type of line (dotted, dashed, and so on) for the text area frame. It also sets border roundings. See Property Connectors and Border styling property for more information.
Inner Spacing ⁠— Defines the space between the text inside the area and the border.
Outer Spacing ⁠— Defines the space between element outside the Text Area and the border.
Size ⁠— Sets both the width and height of the Text Area.
Error Box (virtual) ⁠— Refers to an ErrorBox (virtual) Style Business Object to define the style of the Text Area component and error message when in Error state.

For more information:

On styling properties, see the Style Business Object: Styling Properties section.
On virtual components, see the Style Business Objects Referencing Virtual Components section.