TcxCustomFilterControl.ApplyFilter Method

Applies stated filter conditions to the linked object.

Declaration

procedure ApplyFilter;

Remarks

The ApplyFilter method applies filtering to the linked object based upon filter conditions stated in a filter control and then raises the OnApplyFilter event.

For the TcxFilterControl object, which is destined to operate with any IcxFilterControl-supported objects (typically, grid table views), the ApplyFilter method automatically applies the specified filter conditions to the linked object. When the ApplyFilter method is called, the value of the Criteria property is assigned to the Criteria property of the target 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.

For filter controls of the TcxDBFilterControl type, you should manually apply filter conditions to the underlying dataset based upon the FilterText property setting. The suitable place to perform this task is a handler for the OnApplyFilter event.