Multiline text

The Multiline text component is an input field where you can enter multiple lines of plain text. This field is intended to capture longer text elements, such as the description of a defect. The field size will expand with the amount of text entered. The validation for this component is more limited than the other data entry fields, since a longer text does not usually follow a specific pattern.

Use the Text component to capture shorter text elements.

Attributes: General

Attribute	Description
ID	The unique ID of the component.
Label	The label of the component.
Label tooltip	Used to provide additional help or information to the user. When it is defined, a question mark icon appears in the component label. The text displays when the user hovers their pointer over the icon. The tooltip supports plain text only.
Value	The binding for the component. Use an expression to bind the component to its value and specify where the value is saved. For example, use {{myVariableName}} to store the value of the component in a variable named myVariableName. Use prefixes to define the scope of the value, for example, root. for referencing the root case to store the value in or parent. to store the value in the parent work item of the current one. For example, {{root.foo}} stores the value in the root case using a variable named foo.
Default Value	If a Value is not set, such as on Initialization forms, then this value will be used.
Description	Adds a description to the component.
Ignored	Determines if the component should be hidden and the value excluded from any payload.
Visible	Determines whether the component is visible or hidden. You can also use this expression to only show or hide the component based on another component. For example, if this component is bound to a checkbox component, you can use this expression to show or hide this component based on the checkbox selection made by the user. This is enabled by default.
Enabled	Determines whether the component is enabled or disabled. This is enabled by default.

Attributes: Validation

Attribute	Description
Required	Used to determine if the user must enter a value for this component.
Custom validations	List of additional validations you can apply.
Minimum length	Determines the minimum number of characters required for this component.
Maximum length	Determines the maximum number of characters required for this component.

Attributes: Error messages

Attribute	Description
Minimum length	Determines the error message that displays if the minimum length defined for the component has not been reached.
Maximum length	Determines the error message that displays if the maximum length defined for the component has been exceeded.

Attributes: Documentation

Attribute	Description
Documentation	Allows you to explain concepts of the component's use for future reference.