Function: a!barcodeField()
Displays a field that allows entry of a barcode value using a barcode scanner or manual input.
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 to display 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. |
Accepted Types | acceptedTypes | Text Array | Determines the types of barcodes that are accepted in the field. If no types are specified, then all types are accepted. Null results are accepted for all types. Valid values:
|
Display Value | value | Text | Text to display in the field. |
Save Input To | saveInto | Save Array | 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 | refreshAfter | Text | Determines when the interface is refreshed with the saved value from the barcode 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 | Boolean | 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 . |
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 value. Valid values are "LEFT" , "CENTER" , and "RIGHT" . Appian recommends setting the alignment when used in an editable grid 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
Examples
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
1
2
3
4
=a!barcodeField(
label: "Product Barcode",
instructions: "Scan a barcode from a product box"
)
Displays the following on Appian's web user interfaces:
And the following on iOS:
And the following on Android:
On This Page