TcxCustomFilterControl.Criteria Property

Provides access to the filter criteria defined by a filter control.

Declaration

property Criteria: TcxFilterControlCriteria read;

Property Value

Type
TcxFilterControlCriteria

Remarks

For the TcxFilterControl object, which is destined to operate with any IcxFilterControl-supported objects (typically, grid table views), the Criteria property is of great importance. When applying filtering with the help of the ApplyFilter method, the value of the Criteria property is assigned to the Criteria property of the object linked to the filter control via the LinkComponent property. As a result, the filter conditions defined in a filter control are automatically applied to data of the linked object. Also, when calling the UpdateFilter method, the Criteria property value is updated – it takes the value of the linked object’s Criteria property.

As for the TcxDBFilterControl object, the Criteria property represents an implementation of the Criteria property declared by the IcxFilterControl interface. The TcxDBFilterControl object is forced to support this interface itself, since a dataset object to which a data bound filter control is linked via the DataSet property does not provide native means for this purpose.

Note

Call the BuildFromCriteria method to update filter conditions displayed by the filter control when the Criteria property is modified in code.