TcxCustomGridTableOptionsBehavior.IncSearchItem Property

Specifies the item against which an incremental search is performed when cell focusing is disabled.

Declaration

property IncSearchItem: TcxCustomGridTableItem read; write;

Property Value

Type
TcxCustomGridTableItem

Remarks

The incremental search feature allows users to locate the required record by the value of a specific data item. To enable an incremental search, set the View’s OptionsBehavior.IncSearch property to True. The item’s Options.IncSearch property must be True as well. An end-user can then find the desired record by focusing the item against which the search is to be performed followed by typing the start of the required value. The cell containing the typed value will be located within the item and the corresponding record will be focused.

However, if the View’s OptionsSelection.CellSelect property is set to False, the user is unable to focus the required item. In this case, use the IncSearchItem property to specify the search item explicitly. Setting the OptionsSelection.CellSelect property to False can be useful, for instance, when you want to disable editing data within the View, but still provide the user with the ability to do the search. Note that IncSearchItem is effective only if focusing is disabled via setting the OptionsSelection.CellSelect property to False.

Use the View’s Controller.IncSearchingText property to start the search programmatically. The View’s DataController.Search.LocateNext method allows you to continue the search in the required direction. To cancel the search, see the Controller.CancelIncSearching method.