Function: a!textField()
Displays and allows entry of a single line of text. For a multiple line of text, use a paragraph 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 text 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 |
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. |
Alignment |
|
Text |
Determines alignment of the text value. Appian recommends this setting only be used inside the Grid Layout component. Valid values: |
Label Position |
|
Text |
Determines where the label appears. 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 |
Masked |
|
Boolean |
Determines if the value is obscured from view. Default: false. |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
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. |
Notes
true
, the component's value displays without a box around it.false
, you can use the user's input into the component to modify the interface, such as filtering a grid.Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Text with Only a Label
1
2
3
4
5
=a!textField(
label: "Title",
value: "Expenses could not be submitted",
readOnly: true
)
Displays the following:
Text with Label and Instructions
1
2
3
4
5
6
=a!textField(
label: "Title",
instructions: "The ticket title is exactly as entered by the creator",
value: "Expenses could not be submitted",
readOnly: true
)
Displays the following:
Time with Special Formatting
For example, to show the time in 24-hour format:
1
2
3
4
5
=a!textField(
label: "Daily Meeting Time",
value: text(time(13, 20), "hh:mm"),
readOnly: true
)
Displays the following:
Integer with no Formatting or with Special Formatting
For example, to show an integer with no thousand separators:
1
2
3
4
5
=a!textField(
label: "Reference Number",
value: 12345,
readOnly: true
)
Displays the following:
To show an integer as a currency:
1
2
3
4
5
=a!textField(
label: "Amount",
value: dollar(12345),
readOnly: true
)
Displays the following:
Date with Special Formatting
For example, to show the date in m/dd/yy format:
1
2
3
4
5
=a!textField(
label: "Created On",
value: text(date(2013,1,12), "m/dd/yy"),
readOnly: true
)
Displays the following:
Date and Time with Special Formatting
To show the date and time in "m/dd/yy h:mm a" format, excluding the time zone:
1
2
3
4
5
=a!textField(
label: "Created On",
value: text(datetime(2013,1,12, 11, 20), "m/dd/yy h:mm a"),
readOnly: true
)
Text 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
=a!localVariables(
local!storedPhoneNumber: "555-456-7890-876",
a!textField(
label: "Phone Number",
instructions: "Include only dashes and numbers. For example, 555-456-7890.",
value: local!storedPhoneNumber,
saveInto: local!storedPhoneNumber,
validations: if(
len(local!storedPhoneNumber) > 12,
"Limit your entry to 12 characters",
""
)
)
)
The following patterns include usage of the Text Component.
Add Multiple Text Components Dynamically (Looping): Show a dynamic number of text components to simulate a multi-text input box. A new text box is shown as soon as the user starts typing into the last input box.
Define a Simple Currency Component (Formatting): Show a text field that allows the user to enter dollar amounts including the dollar symbol and thousand separators, but save the value as a decimal rather than text. Additionally, always show the dollar amount with the dollar symbol.
Format the User's Input (Formatting): Format the user's input as a telephone number in the US and save the formatted value, not the user's input.
Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.