This page contains information related to an old version of the Dropdown Component.
To take advantage of the latest features and improvements, we always recommend you use the latest version whenever possible. See the latest version's page for information about what's been changed.
Function: a!dropdownField_20r2()
Displays a limited set of exclusive choices from which the user must select one item and saves a value based on the selected choice. To save the index of the choice instead of a value, use dropdown by index.
If the user may select none, one, or many of the choices, then consider using checkboxes or a multiple dropdown.
If there aren't many choices and users would benefit from easily seeing them all at once, consider using radio buttons.
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. |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
Choice Labels |
|
List of Text String |
Array of options for the user to select. |
Choice Values |
|
List of Variant |
Array of values associated with the available choices. |
Placeholder Label |
|
Text |
Text to display when nothing is selected and the value is null. |
Display Value |
|
Any Type |
Value of the choice to display as selected. |
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 choice value when the user changes the selection. Use a!save() to save a modified or alternative value to a variable. |
Validation Group |
|
Text |
When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, |
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
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 |
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
"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.Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Disabled Dropdown with Label Displayed Above
Use the interactive editor below to test out your code:
Editable Dropdown with the First Choice Selected by Default
Use the interactive editor below to test out your code:
Dropdown with a Blank Choice Selected by Default
Use the interactive editor below to test out your code:
Feature | Compatibility | Note |
---|---|---|
Portals | Compatible | |
Offline Mobile | Compatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
a!dropdownField_20r2 Component