AX1393
StringList refresh variable
StringList refresh variables prompt users to make a selection from a predefined list. This list is manually defined within the current file—either in the RefreshVariables data source itself, or in a range of cells that are then referenced in the data source.
Variable behavior
In the Desktop Client, the variable displays as a drop-down list. The user must use the drop-down to select a value.
Desktop Client: Example StringList variable
In the Web Client, 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.
Web Client: Example StringList variable
Variable properties
This section explains how to complete a variable row in the RefreshVariables data source when defining a StringList 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 StringList 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 StringList 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) |
|
[ClearSelectedValueonSave] |
(missing or bad snippet) |
|
[ClearSelectedValueonOpen] |
(missing or bad snippet) |
|
[DefaultValueonOpen] |
(missing or bad snippet) |
|
[GroupName] |
(missing or bad snippet) |
|
[CollapseOnOpen] |
(missing or bad snippet) |
Variable-specific properties
(missing or bad snippet)Example data source
The following screenshot shows a couple of StringList refresh variable examples. The first example reads the list from a cell range, while the second example uses a comma-separated list.
