Skip to main content

TcxDataControllerOption Enum

Enumerates the various options affecting a data controller’s behavior.

Declaration

TcxDataControllerOption = (
    dcoAnsiSort,
    dcoCaseInsensitive,
    dcoAssignGroupingValues,
    dcoAssignMasterDetailKeys,
    dcoSaveExpanding,
    dcoSortByDisplayText,
    dcoFocusTopRowAfterSorting,
    dcoGroupsAlwaysExpanded,
    dcoImmediatePost,
    dcoInsertOnNewItemRowFocusing,
    dcoMultiSelectionSyncGroupWithChildren
);

Members

Name
dcoAnsiSort
dcoCaseInsensitive
dcoAssignGroupingValues
dcoAssignMasterDetailKeys
dcoSaveExpanding
dcoSortByDisplayText
dcoFocusTopRowAfterSorting
dcoGroupsAlwaysExpanded
dcoImmediatePost
dcoInsertOnNewItemRowFocusing
dcoMultiSelectionSyncGroupWithChildren

Remarks

Options include:

Value

Description

dcoAnsiSort

If active, a grid control uses Windows locale settings to sort records. This option is useful when grid cells contain native language text.

Otherwise, strings are compared based on the 8-bit ordinal value of each character.

dcoCaseInsensitive

If set, sorting is case-insensitive.

dcoAssignGroupingValues

When a new record is inserted, this flag allows you to automatically assign the values of fields by which grouping, if any, is currently applied. Values for these fields are obtained from the focused record.

Grouping fields are not assigned if the flag is not set.

dcoAssignMasterDetailKeys

This flag is applied when inserting a new record within a detail dataset. If active, it makes the data controller automatically assign the record fields specified by the DetailKeyFieldNames property. The DetailKeyFieldNames property identifies the key fields in a detail dataset used to establish a master-detail relationship with a master dataset.

dcoSaveExpanding

If active, keeps the current expansion state of rows when dataset records are reloaded. This also keeps the current selection of records in the current data controller when grouping is applied.

Reloading dataset records clears the current expansion state and selection of rows if the flag is inactive.

dcoSortByDisplayText

Records are sorted by field values (edit values) by default. The dcoSortByDisplayText flag allows you to activate sorting by display text (the text displayed in item cells). This can be useful when items are assigned to Lookup or ComboBox editors, for instance, when the edit value and text are different.

dcoFocusTopRowAfterSorting

If active, the topmost record gets focus after sorting. Otherwise, the focus remains at its prior position.

dcoGroupsAlwaysExpanded

If active, grouped records always appear expanded.

dcoImmediatePost

If active, the changes to a field value (edit value) are immediately posted to a dataset.

dcoInsertOnNewItemRowFocusing

If active, a new record is inserted into the dataset as soon as the new item row receives focus.

dcoMultiSelectionSyncGroupWithChildren

If active, group rows synchronize their selected state with child rows. Use this option to help users make their selection with fewer mouse clicks.

The option is in effect if a data controller’s MultiSelect property is set to True.

The options of the data controller are set via its Options property.

See Also