Data.DB.TDataSet.Filtered

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Filtered: Boolean read FFiltered write SetFiltered default False;

C++

__property bool Filtered = {read=FFiltered, write=SetFiltered, default=0};

Properties

Type Visibility Source Unit Parent
property public
Data.DB.pas
Data.DB.hpp
Data.DB TDataSet

Description

Specifies whether or not filtering is active for a dataset.

Check Filtered to determine whether or not dataset filtering is in effect. If Filtered is true, then filtering is active. To apply filter conditions specified in the Filter property or the OnFilterRecord event handler, set Filtered to true. Because unidirectional datasets do not support filters, when you set Filtered to true on a unidirectional dataset, it raises an exception.

Note: When filtering is enabled, user edits to a record may mean that the record no longer meets a filter's test condition. The next time an attempt is made to the read the record from the dataset while the filter is in effect, the record is not visible. If that happens, the next record that passes the filter condition becomes the active record.

See Also