AX1468
ComboBox refresh variable
ComboBox refresh variables prompt users to select a value from a searchable drop-down list (the combo box). There are several different options to define the list of values for the combo box:
-
Using a ComboBox data source defined within the file. ComboBox data sources support defining separate labels and values. This means that what displays to end users in the combo box can be different than what is placed in the
[SelectedValue]column for use in impacting the data query. For example, end users might select "friendly" country names (the labels) but the corresponding country code (the values) is placed in the[SelectedValue]column. -
Using a table column. You can specify a table column to display the values from that column in the drop-down list.
-
Using a picklist table. You can specify a picklist table to display the values from that picklist in the drop-down list. This option provides special support to automatically display the picklist value to users, but write back the corresponding code as the selected value.
-
Using an Axiom Query. You can define an Axiom query in the file, and designate this query as the source for the combo box. The values returned by the query display in the drop-down list. The query runs "in the background" when the user interacts with the combo box.
When using a ComboBox with a table column or an Axiom query, you can also use RelatedColumnValue variables. These are special variables that do not display to users. Instead, they are used to return values from related columns so that these values can be referenced in titles and other areas of the file. For example, if you are prompting users to select an account, then you can use a RelatedColumnValue variable to return the description of that account from the Acct.Description column. For more information, see RelatedColumnValue refresh variable.
Variable behavior
The variable displays as a drop-down list with a searchable entry box. The user can scroll the list and select the value directly, or type into the box to find a particular value.
Desktop Client: Example ComboBox refresh variable
Web Client: Example ComboBox refresh variable
The drop-down lists may be limited to displaying some number of values (the specific display limit depends on the source of data and the client environment). For example, in some cases the drop-down list will only display the first 100 values. However, all values can be found by using the search box. The search matches on the primary value, any description columns, and any additional columns included in the display format.
The values in the drop-down list are sorted as follows:
- ComboBox data source: Values are presented in the same order as the data source.
- Table column: Values are sorted based on the display format if defined, otherwise based on the value column.
- Picklist table: Values are sorted based on the string value of the picklist by default. If a display format is defined, values are sorted based on the display format.
- Axiom query: Values are sorted according to the Axiom query Data Sort setting.
Variable properties
This section explains how to complete a variable row in the RefreshVariables data source when defining a ComboBox variable. Some data source columns do not apply in this case and are not discussed here. If any inapplicable columns are present in the data source, they should be left blank on rows that define ComboBox variable types. If you are using the Data Source Assistant to complete the variable properties, then only the applicable columns will be shown in the task pane.
For more information on the RefreshVariables data source in general, see Defining refresh variables.
General variable properties
All refresh variables use a common set of general properties such as the variable name, display name, and whether the variable is enabled or required. Any special considerations for ComboBox variables are noted.
| Column Tag | Description |
|---|---|
|
[Name] |
(missing or bad snippet) |
|
[DisplayName] |
(missing or bad snippet) |
|
[VariableType] |
Specifies the variable type. Enter |
|
[IsEnabled] |
(missing or bad snippet) |
|
[SelectedValue] |
The user's selected value for the variable will be placed in this cell. When setting up the file to use the variable value, point your formulas to this cell. (missing or bad snippet) |
|
[IsRequired] |
(missing or bad snippet) |
|
[DependsOn] |
(missing or bad snippet) |
|
[DefaultValueonOpen] |
(missing or bad snippet) |
|
[ClearSelectedValueonSave] |
(missing or bad snippet) |
|
[ClearSelectedValueonOpen] |
(missing or bad snippet) |
|
[GroupName] |
(missing or bad snippet) |
|
[CollapseOnOpen] |
(missing or bad snippet) |
The remaining columns depend on whether you are using a ComboBox data source, a table column, a picklist table, or an Axiom query.
NOTE: The [AllowMultiSelect] property cannot be used with ComboBox variables. Only Grid variables support selection of multiple values.
Variable-specific properties (ComboBox data source)
The following additional properties apply to ComboBox variable types, when using a ComboBox data source:
| Column Tag | Description |
|---|---|
|
[DataSourceName] |
(missing or bad snippet) For more information, see Creating a ComboBox data source for the variable. |
|
[PlaceholderText] |
Optional. Specifies placeholder text to display within the combo box until a value is selected. If blank, then the default text "Choose a value" is used. |
|
[AutoQuoteString] |
(missing or bad snippet) NOTE: The values in the ComboBox data source are always considered to be strings and will be quoted if this option is enabled, even if the values are actually numbers. |
The following properties do not apply to ComboBox variables when using a ComboBox data source: ListChoices, ColumnName, AdditionalColumns, ColumnFilter, AllowMultiSelect, DisplayFormat, Hierarchies, UseAsQuickFilter, MinDate, MaxDate, TooltipColumn, PrimaryTable, LimitColumn, MinValue, MaxValue, StepFrequency.
Variable-specific properties (table column)
The following additional properties apply to ComboBox variable types, when using a table column:
| Column Tag | Description |
|---|---|
|
[ColumnName] |
(missing or bad snippet)(missing or bad snippet) If the value column is a key column or a validated column, then the corresponding descriptions automatically display with the column values in the drop-down list, unless a display format is defined. |
|
[ColumnFilter] |
Optional. Specifies a filter criteria statement to limit the list of values displayed to the user. You can type in the filter statement manually, or right-click the cell and use Axiom Wizards > Filter Wizard. If the value column uses a lookup, then the column in the filter criteria statement must be resolvable from the primary table, or must use a fully qualified path from the starting table. |
|
[PlaceholderText] |
Optional. Specifies placeholder text to display within the combo box until a value is selected. If blank, then the default text "Choose a value for ColumnName" is used. |
|
[DisplayFormat] |
(missing or bad snippet)(missing or bad snippet) If a display format is defined, the items in the list are sorted based on the display format instead of the value column. NOTE: This is the only way to display additional columns in the list. The |
|
[TooltipColumn] |
(missing or bad snippet) |
|
[AutoQuoteString] |
(missing or bad snippet) NOTE: This option only applies if the value column is a string column. |
The following properties do not apply to ComboBox variables when using a table column: ListChoices, AllowMultiSelect, DataSourceName, DisplayFormat, Hierarchies, UseAsQuickFilter, MinDate, MaxDate, PrimaryTable, LimitColumn, MinValue, MaxValue, StepFrequency.
Variable-specific properties (Picklist table)
(missing or bad snippet)The following properties do not apply to ComboBox variables when using a picklist table: ListChoices, AdditionalColumns, AllowMultiSelect, Hierarchies, UseAsQuickFilter, MinDate, MaxDate, AutoQuoteString, PrimaryTable, LimitColumn, MinValue, MaxValue, StepFrequency.
Variable-specific properties (Axiom query)
The following additional properties apply to ComboBox variable types, when using an Axiom query:
| Column Tag | Description |
|---|---|
[DataSourceName] | (missing or bad snippet) |
[ColumnFilter] | (missing or bad snippet) This property can be used in addition to (or instead of) the Data Filter on the Axiom query itself. |
[PlaceholderText] | Optional. Specifies placeholder text to display within the combo box until a value is selected. If blank, then the default text "Choose a value for ColumnName" is used (where ColumnName is the first column in the Axiom query's field definition). |
[DisplayFormat] | (missing or bad snippet) Any additional columns included here must also be in the field definition of the Axiom query. NOTE: This is the only way to display additional columns in the combo box. The |
[TooltipColumn] | Optional. Specifies a column that defines tooltip text for each value shown in the list. When a user hovers over a value in the list, the corresponding text from this column is shown in a tooltip. The specified column must also be present in the Axiom query field definition. |
[AutoQuoteString] | (missing or bad snippet) NOTE: This option only applies if the value column of the Axiom query (the first column in the field definition) is a string column. |
The following properties do not apply to ComboBox variables when using an Axiom query: ListChoices, ColumnName, AdditionalColumns, AllowMultiSelect, Hierarchies, UseAsQuickFilter, MinDate, MaxDate, PrimaryTable, LimitColumn, MinValue, MaxValue, StepFrequency.
Example data source
The following screenshot shows examples of ComboBox variables, one of each type.
Creating a ComboBox data source for the variable
If you are defining refresh variables for use in a form-enabled file, then you can use the data source wizard to add the data source. Right-click in the cell where you want to start the data source, then select Create Axiom Form Data Source > Combo Box.
If you are defining refresh variables for use in a spreadsheet Axiom file, then you must manually create the data source.
The tags for the Combo Box data source are as follows:
(missing or bad snippet)The following example shows how a ComboBox data source might look in a file:
In this example, if the user selects the label "Consolidated" from the combo box, the value "All" will be placed in the [SelectedValue] column.
