Function: a!barcodeField()
Displays a field that allows entry of a barcode value using a barcode scanner or manual input.
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Instructions |
|
Text |
Supplemental text about this field. |
Accepted Types |
|
List of Text String |
Determines the types of barcodes that are accepted in the field. Null results in all types being accepted. Valid values: |
Display Value |
|
Text |
Text to display in the field. |
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 |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
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. |
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
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. |
Alignment |
|
Text |
Determines alignment of the text value. 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
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Without Masking
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:
With Masking
1
2
3
4
5
=a!barcodeField(
label: "Product Barcode",
instructions: "Scan a barcode from a product box",
masked: true
)
Displays the following on Appian's web user interfaces:
And the following on iOS:
And the following on Android: