Skip to main content

TcxDataControllerSearch Class

Provides methods enabling you to perform incremental searching programmatically.

Declaration

TcxDataControllerSearch = class(
    TcxDataControllerObject
)

Remarks

Most Developer Express controls support the incremental search feature that allows end-users to locate records by typing the desired field values. Each control has its own set of options controlling whether incremental search feature is available. At the same time, the options set is similar for all controls and includes an option at the control’s level allowing you to prohibit incremental searching for the entire control and options at the level of objects representing dataset fields that allow you to prohibit incremental searching for particular fields. (Note, that the control’s level is the grid view’s level if using the ExpressQuantumGrid.)

Regardless of the options described, you can perform incremental searching programmatically, if needed. This allows you to provide greater control over the searching process. For instance, you may skip found records that don’t satisfy to your custom conditions, etc. To provide programmatic incremental searching, use the TcxDataControllerSearch object’s methods. This object can be accessed via the Search property of your control’s data controller.

The main methods you will use are the Locate, LocateNext and Cancel. These methods allow you to start searching, locate the next record satisfying to the search text and cancel searching respectively.

Note

some controls do not support incremental searching performed via the TcxDataControllerSearch object due to complex data representation structures. An example of such a control is a tree list. This control provides its own methods that enable programmatic incremental searching.

Inheritance

TObject
TcxDataControllerObject
TcxDataControllerSearch
See Also