TcxCustomGridTableController.IncSearchingText Property

Specifies the text being searched.

Declaration

property IncSearchingText: string read; write;

Property Value

Type
string

Remarks

You can use the IncSearchingText property to specify the text for the incremental search. Assigning a non-empty string to the property starts the search from the currently focused record to the bottom. The View’s DataController.Search.LocateNext method allows you to continue the search in the required direction. To cancel the search, see the CancelIncSearching method. An empty string assigned to IncSearchingText also stops the search.

The search is performed on the item (a column in a (Banded) Table View and row in a Card View) being focused. However, if cell focusing is disabled by setting the View’s OptionsSelection.CellSelect property to False, you can specify the search item explicitly with the help of the View’s OptionsBehavior.IncSearchItem property. In other cases, OptionsBehavior.IncSearchItem is not effective.

To start an incremental search, focus a View item against which the search will be performed (the focused item cell must not be in edit mode) or specify the search item via the View’s OptionsBehavior.IncSearchItem property (see notes above). Then type in the text to search for and this locates the first record whose item value matches the text. Modifying the search text locates another record with a corresponding item value.

To enable an incremental search, set the View’s OptionsBehavior.IncSearch property to True. In addition, make certain, that the item’s Options.IncSearch property is also set to True.