TcxGridFilterValueList.ApplyFilter(TcxCustomGridTableItem,Integer,TcxFilterCriteriaItemList,Boolean,Boolean) Method

Applies the AFilterList filter to AItem.

Declaration

procedure ApplyFilter(AItem: TcxCustomGridTableItem; AIndex: Integer; AFilterList: TcxFilterCriteriaItemList; AReplaceExistent: Boolean; AAddToMRUItemsList: Boolean);

Parameters

Name	Type
AItem	TcxCustomGridTableItem
AIndex	Integer
AFilterList	TcxFilterCriteriaItemList
AReplaceExistent	Boolean
AAddToMRUItemsList	Boolean

Remarks

The AItem parameter specifies an item whose values are to be filtered;

The AIndex parameter specifies an index of the filter condition in the filter dropdown;

The AFilterList parameter specifies the list of filter criteria. To add the specified filter item to the root filter list (see the Filter.Root property), set the AFilterList parameter to nil;

The AReplaceExistent parameter specifies whether to clear the AFilterList list before a new criterion is added. Set the AReplaceExistent to True, to remove existing filter items. Otherwise, a new filter item will be added to the existing list;

The AAddToMRUItemsList parameter specifies whether the AIndex filter item will be added to the list of most recently used filter items. The most recently used filter items are shown at the top of the filter dropdown. Set the AAddToMRUItemsList to True to add the AIndex filter item to that list.

Note

Before calling the ApplyFilter method, call the Load method to populate the filter list.