Function: a!integerField()
Displays and allows entry of a single integer number.
When working with a decimal number, use a decimal component. To display a number using a custom format, use a text component.
Parameters
Name | Keyword | Type | Description |
---|---|---|---|
Label | label | Text | Optional text to display as the field label. |
Label Position | labelPosition | Text | Optional text to determine where the label appears. Valid values include
|
Instructions | instructions | Text | Optional text displayed below the field's value. |
Help Tooltip | helpTooltip | 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 "COLLAPSED" . |
Placeholder | placeholder | Text | Optional text to display in the field when it is empty. Does not show if the field is read only. |
Display Value | value | Integer | The value to display in the integer number field. |
Save Input To | saveInto | Save Array | One or more variables that are updated with the integer when the user changes it. Use a!save() to save a modified or alternative value to a variable. |
Refresh After | refreshAfter | Text | Determines when the interface is refreshed with the saved value from the integer field. Valid values are "KEYPRESS" to refresh after every character typed into the field and "UNFOCUS" (the default value) to refresh when the user deselects the field after changing its value. |
Required | required | Boolean | Determines if a value is required to submit the form. Default is false . |
Required Message | requiredMessage | Text | Custom message to be displayed when the field's value is required and not provided. |
Read-only | readOnly | Text | If set to 'true', prohibits users from editing the *value*. Default is false . |
Disabled | disabled | Boolean | Determines if the user is prevented from changing the value. Default is false . |
Masked | masked | Boolean | Determines if the value is obscured from view. Default is false . |
Validations | validations | Text Array | Validation errors to be displayed below the field when the value is not null. |
Validation Group | validationGroup | Text | When present, this field is only validated when a button in the same validation group is clicked. |
Alignment | align | Text | Alignment of the integer number (except on mobile devices). Valid values are "LEFT" , "CENTER" , and "RIGHT" . Appian recommends setting the alignment when used in an editable grid component only. |
Visibility | showWhen | 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
.Examples
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Collect an Integer Value from a User
1
2
3
4
5
=a!integerField(
label: "Reference Number",
value: local!referenceNumber,
saveInto: local!referenceNumber
)
Integer with Only a Label
1
2
3
4
5
=a!integerField(
label: "Reference Number",
value: 12345,
readOnly: true
)
Displays the following:
Integer with a Validation
1
2
3
4
5
6
7
8
9
10
11
12
13
=load(
local!storedValue,
a!integerField(
label: "Number of Items",
value: local!storedValue,
saveInto: local!storedValue,
validations: if(
local!storedValue < 1,
"You must enter at least one item",
""
)
)
)
Displays the following:
On This Page