SQL Passthrough DataSet Hierarchy Selector List Properties

HierarchyPolicy.ParentIdBased

The policy that controls how the hierarchy is constructed from the returned SQLPassthroughDataSet.

ColumnBased - The hierarchy is constructed from the sequence of ListItemDisplayNameColumns and ListItemValueColumns properties, where the generation of each item is derived from the position in the list. For example, if the columns listed are root, child, grandchild, the tree will be built with three generations.

ParentIDBased - The hierarchy is constructed on the basis of the ItemIDColumnName, ItemParentIDColumnName, and ListRootNodeIDs properties, where the generation of each item is derived from the parents, starting with the optionally specified root nodes.

See also: SQLPassthroughDataSetID

IDType.Long

The data type of the ID and ParentID columns returned by the SQLPassthroughDataSet. This property maps the column’s data type to a compatible, sortable, data type that is used in the construction of the hierarchy.

See also: SQLPassthroughDataSetID, ItemIDColumnName, ItemParentIDColumnName

The name of the data table column returned by the SQLPassthroughDataSet that contains the display name for the returned selector items.

This setting is optional. If no display name column is specified, the ItemIDColumnName will be used.

See also: SQLPassthroughDataSetID, ItemIDColumnName, ItemValueColumnName

The name of the data table column returned by the SQLPassthroughDataSet that contains the ID for the returned selector items.

This setting is required. If no ID column is specified, the hieararchy will not be constructed successfully.

See also: SQLPassthroughDataSetID, ItemDisplayNameColumnName, ItemValueColumnName

The name of the data table column returned by the SQLPassthroughDataSet that contains the Parent ID for the returned selector items.

This setting is required. If no Parent ID column is specified, the hieararchy will not be constructed successfully.

See also: SQLPassthroughDataSetID, ItemParentDisplayNameColumnName, ItemIDColumnName

The name of the data table column returned by the SQLPassthroughDataSet that contains the value for the returned selector items.

This setting is optional. If no display name column is specified, the ItemIDColumnName will be used.

See also: SQLPassthroughDataSetID, ItemIDColumnName, ItemDisplayNameColumnName

,

The ListDelimiter defines the character(s) used to delimit the substrings within "list" properties of the Selector List.

The list of the IDs returned by the SQLPassthroughDataSet whose associated selector items will be used as root nodes in the hierarchy.

This setting is optional. The ListRootNodeIDs property can be used to isolate specified data table records and use them as the root nodes in the hierarchy. If no root node IDs are specified, the items in the data table that lack Parent IDs are used as root nodes.

See also: SQLPassthroughDataSetID, ListDelimiter, ItemParentIDColumnName

The ID of the SQLPassthroughDataSet metadata instance that defines the query or queries used to generate the list items. If multiple queries are defined by the SQLPassthroughDataSet, each query is executed and the combined results are used as the list items.

See also: ItemDisplayNameColumnName, ItemIDColumnName, ItemParentIDColumnName, ItemValueColumnName

SortOrder.Ascending

The sort order of selector list items in the hierarchy.

Ascending - Selector list items under each node will be sorted in ascending alphabetical order by DisplayName. AscendingValue - Selector list items under each node will be sorted in ascending alphabetical order by Value. Descending - Selector list items under each node will be sorted in descending alphabetical order by DisplayName. DescendingValue - Selector list items under each node will be sorted in descending alphabetical order by Value. DataSetOrder - Selector list items under each node will be sorted in the order that they are returned by the SQLPassthroughDataSet. SortColumn - Selector list items under each node will be sorted in ascending alphabetical order by the value of the sort order column. The SortOrderColumnName property is only available when using the ParentIDBased HierarchyPolicy.

See also: SQLPassthroughDataSetID, SortOrderColumnName.

The name of the data table column returned by the SQLPassthroughDataSet that contains the value for the sort order of the returned selector items.

This property is available only when the SortOrder property is set to SortColumn and the HierarchyPolicy property is set to ParentIDBased.

See also: SortOrder, HierarchyPolicy.

The data table columns returned by the SQLPassthroughDataSet that contain the detail items used in the ItemToolTip or ItemSelection/ExpansionFilters.

This setting is optional. It is used when the SelectorControlProperties specify that ItemToolTipContentOptions: Details should be shown or to leverage filters on the basis of a DetailsColumnValue.

See also: ItemToolTipContentOptions, ItemSelectionFilters, ItemExpansionFilters

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.

false

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

By default, the items are not cached. 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 one of the following format items, which are replaced with the corresponding selected item string:

{0}, which is replaced with the selected item value. {ID}, which is replaced with the selected item ID. {DisplayName}, which is replaced with the selected item display name. {ParentID}, which is replaced with the selected item parent ID. {ParentDisplayName}, which is replaced with the selected item parent display name.

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

See also: TokenValueDelimiter, TokenValueFormat