Generic Text Selector List Properties

The following properties are available for Generic Text Selector List objects, grouped by the categories shown in the Selectors and Selector Lists editors.

Default Selection

Property Type Default Description

DefaultSelectionString
displayed as DefaultTextString

string

DefaultTextPolicy.None

The text that represents the default when the DefaultTextPolicy is SpecifiedString. The string can be tokenized.

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

See also: DefaultTextPolicy

DefaultTextPolicy

DefaultTextPolicy

DefaultTextPolicy.None

Indicates how the default text is determined.

None - No default is set.

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

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

NullLastUsedItemString

string

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.

Dependencies

Property Type Default Description

DependentOnSelectorIDs

string

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.

Null Selection

Property Type Default Description

NullSelectionText

string

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.

NullSelectionTokenValue

string

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.

Token Value

Property Type Default Description

TokenValueFormat

string

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

TokenValueItemEscapeSingleQuote

bool

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.