Range Selector List Properties

DefaultPolicy.None

Indicates how the default selection is determined.

None - No item(s) is selected by default.

LastUsedItem - The last item(s) used within the context is the default. The context is specified by the view’s SelectorLastUsedItemContext setting.

FirstItem - The first item in the list is the default.

AllItems - All items in the list are automatically selected. This option only applies when multiple selections are allowed.

SpecifiedString - The DefaultSelectionString value, which can be tokenized, is the default.

Today - Today’s date. This option only applies to Date selectors and Generic selectors that use the SelectorComboBox SelectorControlObjectTypeID.

The semi-colon delimited list of values that represents the default selection when the DefaultSelectionPolicy is SpecifiedString. The string can be tokenized.

The DefaultSelectionString is only applicable when the DefaultSelectionPolicy is set to SpecifiedString.

See also: DefaultSelectionPolicy

The string that represents the item value(s) used as the default when the DefaultSelectionPolicy is LastUsedItem and no last used item exists. The value can be tokenized.

false

Determines whether the default selection is validated.

Typically, the best runtime performance is achieved by setting the ValidateDefaultSelection to false and the DefaultSelectionPolicy to LastUsedItem.

A semi-colon delimited list of ID’s of the other selectors that affect this selector list. At runtime, when a selection changes for any of the specified selectors, this selector list is automatically re-generated.

The text displayed by the selector when no item(s) is selected. The setting is often used to display a prompt. The value can be tokenized.

The text assigned to the token when no item(s) is selected. The value can be tokenized.

NullSelectionTokenValue is typically used to specify the token value for a selector that is configured as optional, but still needs to be represented by a token.

The ID and version number of the binary artifact that contains the Excel file, which contains the range specified as the RangeName.

Controls whether each cell or each pair of cells in the range represents a selector item.

Each selector list item has a value and display text. The display text is presented in the selector control. When an item is selected, the value is assigned to the selector’s token.

EachCellAsSelectorItem - Each cell represents a selector item. The value and display text are the same as the cell’s value.

CellPairsAsSelectorItemValueAndDisplayText - Each pair of cells in a row within the range represents a selector item. The first cell’s value is used as the selector item’s value and the second cell’s value is used as the display text.

The name of the sheet range in which the value of each non-blank cell represents a selector item.

If the range is a sheet-level range, the range name should be qualified with the sheet name.

The RangeName can be tokenized.

Indicates whether the Excel file that contains the range is the view’s Excel template binary artifact or the specified ExcelBinaryArtifact.

true

Controls whether the list of selector items generated by the selector list are added to the session cache.

By default, the items are cached for the Range selector list, since the cell values are not likely to change during the session.

In general, session caching should be disabled when the items represented by the selector list change frequently and are likely to change over the course of a session. Performance can be improved when session caching is enabled.

This setting is only applicable when the application’s SessionCachingEnabled setting is true.

;

When the user is allowed to select multiple items, the token value is a delimited list of substrings in which each substring represents a selected item. The TokenValueDelimiter defines the character(s) used to delimit the substrings within the token value. By default, the delimiter is a semi-colon.

See also: TokenValueFormat, TokenValueItemFormat

The format used to create the value that is assigned to the token.

By default, the token value is a semi-colon delimited list of substrings in which each substring represents a selected item. If the token value needs to contain additional text prepended and/or appended to the text representing the selected item(s), you can use the TokenValueFormat to specify the text.

The format must contain the format item {0}, which is replaced with the selected item(s) string.

See also: TokenValueDelimiter, TokenValueItemFormat

false

Controls whether a single quotation mark within the token item value is automatically escaped with another single quote.

For example, if TokenValueItemEscapeSingleQuote is True and the selected item is Ville De’anjou, the item value assigned to the token is Ville De''anjou. This setting is intended for use when the token is used within a relational query.

When the user is allowed to select multiple items, the token value is a delimited list of substrings in which each substring represents a selected item. If each substring needs to be prepended and/or appended with additional text, you can use the TokenValueItemFormat to specify the text.

The format must contain the format item {0}, which is replaced with the selected item string.

For example, to enclose each item string in single quotes, the TokenValueItemFormat can be set to '{0}'

See also: TokenValueDelimiter, TokenValueFormat