TcxCustomGridTableController.IncSearchingItem Property

Returns the item targeted by an incremental search operation.

Declaration

property IncSearchingItem: TcxCustomGridTableItem read;

Property Value

Type
TcxCustomGridTableItem

Remarks

ExpressQuantumGrid supports an incremental search feature with which a user can locate a required record by a specific item value (an item stands for a column in a (Banded) Table View and row in a Card View).

To start an incremental search, focus the View item against which the search is to be performed (the focused item cell must not be in edit mode). Then type 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.

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 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.

The IncSearchingItem property refers to the item on which an incremental search is being performed. When no search is being performed (the IsIncSearching property returns False), IncSearchingItem returns nil.

To get/set the text for the search, see the IncSearchingText property. Assigning a non-empty string to IncSearchingText 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, call the CancelIncSearching method.