AX1477
RadioButton refresh variable
RadioButton refresh variables prompt users to select a value from two or more radio buttons. There are three ways to define the list of values to be displayed as radio buttons. These are the same three options supported by ComboBox variables:
- ComboBox data source
- Table column
- Axiom query
The RadioButton refresh variable should only be used for small lists of values. Large lists are difficult for users to read in radio button format, and take up too much space in the refresh dialog or filter panel. If the list is too large to display effectively in radio button format, then you should use a different variable type, such as StringList, Grid, or ComboBox.
Unlike ComboBox variables, RadioButton refresh variables do not support use of associated RelatedColumnValue variables. This is because the kind of data displayed as radio buttons typically does not have related column values that need to be brought into the spreadsheet. Although ComboBox variables and RadioButton variables use the same data options, the kind of data they use is very different.
Variable behavior
The variable displays as a vertical list of radio buttons. The user can select one of the radio buttons to use that value. The following example shows three different radio button variables, where the first variable is optional and the second two are required.
Desktop Client: Example RadioButton refresh variable
Web Client: Example RadioButton refresh variable
If the variable is not required, the user can select (No Selection). This means that the selected value for the variable will be blank. The (No Selection) option is automatically added to the top of optional variables; you do not need to manually add this value to your list of values. The variable will start out at this value if the variable is not required and no "default value" has been defined.
If the variable is required, then the user must select one of the radio buttons. The (No Selection) option is not available.
The radio button values are presented in the following order, depending on the source data:
- 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.
- 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 RadioButton 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 RadioButton 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 RadioButton 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) If the variable is not required, then Axiom Financial Institutions Suite automatically places an option of (No Selection) at the top of the radio button list. This value is used to indicate that no selection has been made for the variable, meaning that |
|
[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, or an Axiom query. Because RadioButton variables use small lists of values, the most common way to define the list of values is to use a ComboBox data source. If you use a table column or an Axiom query to define the list of values, you must ensure that the returned list of values is small.
Variable-specific properties (ComboBox data source)
(missing or bad snippet)Variable-specific properties (table column)
(missing or bad snippet)Variable-specific properties (Axiom query)
(missing or bad snippet)Example data source
The following screenshot shows examples of RadioButton variables, one of each type (data source, Axiom query, and column value).
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 ComboBox 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 radio button labeled "Consolidated", then the value "All" will be placed in the [SelectedValue] column.
Setting up an Axiom query for the variable
When the RadioButton variable is rendered in the refresh dialog or filter panel, the specified Axiom query is run in memory only (meaning, no values are populated within the sheet where the query is configured). The results of the query are used to generate the list of radio buttons.
(missing or bad snippet)