TcxCustomTextEditProperties.IncrementalFiltering Property

Specifies whether incremental filtering is enabled.

Declaration

property IncrementalFiltering: Boolean read; write; default False;

Property Value

Type	Default	Description
Boolean	False	Specifies if incremental filtering is enabled for the current editor with a drop-down item list: False Default. The editor always displays a complete item list in a drop-down window. The IncrementalFilteringOptions property is ignored. True The editor filters out items in a drop-down window according to user input and the IncrementalFilteringOptions property value.

Remarks

Incremental filtering allows users to quickly select items that include or start with an input string. Each added or removed input string character updates filter criteria.

End-User Editor Functionality in Different Editors

If the editor has an editable text box, the text box autocompletes user input to the value selected in a drop-down window.

If the editor has no editable text box and allows users to select options from a predefined list, the drop-down window displays a dedicated search/filter for user input.

Available Options

Set the IncrementalFiltering property to True or False to disable or enable incremental filtering in a supported editor.

Incremental Filtering Customization

When the IncrementalFiltering property is enabled, you can add/remove the following flags to/from the IncrementalFilteringOptions property to modify incremental filtering behavior:

ifoHighlightSearchText

Search terms are highlighted wherever they appear in the results.

ifoUseContainsOperator

Applies the CONTAINS filter condition operator to incremental filtering operations instead of the BEGINS WITH operator. The displayed list contains all items that contain the specified character sequence.

Note

If the ifoUseContainsOperator flag is omitted, incremental filtering operations use the BEGINS WITH operator. This option often reduces result list size.

Supported Editors

You can enable incremental filtering for the following editors that allow users to select options from a list displayed in a drop-down window:

TcxCheckComboBox | TcxDBCheckComboBox

A hybrid editor that combines combo box and check box functionality. A check combo box is designed to select multiple values simultaneously.

TcxColorComboBox | TcxDBColorComboBox

A combo box designed for color selection.

TcxComboBox | TcxDBComboBox

A simple combo box editor.

TcxFontNameComboBox | TcxDBFontNameComboBox

A combo box designed for font typeface selection.

TcxImageComboBox | TcxDBImageComboBox

A combo box designed to display images in addition to text descriptions in all items available for selection.

TcxLookupComboBox | TcxExtLookupComboBox | TcxDBExtLookupComboBox

A lookup combo box designed to display a table with multiple columns in a drop-down window instead of a simple item list.

Tip

Incremental filtering is initially enabled for lookup combo box editors.

Default Value

The IncrementalFiltering property’s default value is False.

Note

TcxLookupComboBoxProperties and TcxExtLookupComboBoxProperties classes change the default IncrementalFiltering property value to True.

Incremental Filtering in Other Products

TcxCustomGridTableItemOptions.FilteringPopupIncrementalFiltering

Enables the incremental filtering functionality for the data item’s filter drop-down window.

TcxPivotGridFieldOptions.FilteringPopupIncrementalFiltering

Enables the incremental filtering feature for the field’s filter dropdown.