Function: a!paragraphField()
Displays and allows entry of multiple lines of text. For a single line of text, use a text component.
| Name | Keyword | Types | Description |
|---|---|---|---|
|
Label |
|
Text |
Text to display as the field label. |
|
Instructions |
|
Text |
Supplemental text about this field. |
|
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
|
Read-only |
|
Boolean |
Determines if the field should display as not editable. Default: false. |
|
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
|
Display Value |
|
Text |
Text to display in the field. |
|
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
|
Save Input To |
|
List of Save |
One or more variables that are updated with the text when the user changes it. Use a!save() to save a modified or alternative value to a variable. |
|
Refresh After |
|
Text |
Determines when the interface is refreshed with the saved value from the barcode field. Valid values are |
|
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
|
Validation Group |
|
Text |
When present, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups. |
|
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
|
Height |
|
Text |
Determines the field height. Valid values: |
|
Placeholder |
|
Text |
Text to display in the field when it is empty. Does not show if the field is read only. |
|
Help Tooltip |
|
Text |
Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is |
|
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
|
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Notes
"ADJACENT" or "ABOVE", but do not give a value for Label, a space still displays to the left-side or above, respectively, of the component as if there was a label displayed. To ensure the component appears to the far left when Label has no value, use "COLLAPSED" for Label Position.true, the Display Value displays without a box around it.false, you can use the user's input into the component to modify the interface.Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Paragraph with Only a Label Displayed Adjacent
1
2
3
4
5
6
=a!paragraphField(
label: "Description",
labelPosition: "ADJACENT",
value: "Expenses could not be submitted. When " & char(10) & " I click on the expenses link, I see an error page.",
readOnly: true
)
Displays the following:
Editable Paragraph with Label and Instructions
1
2
3
4
5
=a!paragraphField(
label: "Description",
instructions: "The description must include the problem statement",
value: "Expenses could not be submitted. When " & char(10) & " I click on the expenses link, I see an error page."
)
Displays the following:
Paragraph with a Length Validation
To validate that a value enter by the user meets a particular character limit:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
=a!localVariables(
local!storedQuote,
a!paragraphField(
label: "Favorite Quote from a Book",
instructions: "Number of characters " & len(local!storedValue) & "/4000",
refreshAfter: "KEYPRESS",
value: local!storedQuote,
saveInto: local!storedQuote,
validations: if(
len(local!storedQuote) >= 4000,
"Limit your entry to 4000 characters",
""
)
)
)
Displays the following:
