TcxGridFilterValueList.Load(TcxCustomGridTableItem,Boolean,Boolean,Boolean) Method

Populates the filter list with filter items.

Declaration

procedure Load(AItem: TcxCustomGridTableItem; AInitSortByDisplayText: Boolean = True; AUseFilteredValues: Boolean = False; AAddValueItems: Boolean = True); reintroduce; overload; virtual;

Parameters

Name	Type
AItem	TcxCustomGridTableItem
AInitSortByDisplayText	Boolean
AUseFilteredValues	Boolean
AAddValueItems	Boolean

Remarks

A filter dropdown is populated with filter items from the list (see TcxFilterValueList) created by the Load method.

Filter items are also used by the ApplyFilter method. The ApplyFilter method is designed to programmatically apply filtering to AItem as an end-user does through the filter dropdown.

The AItem parameter specifies the item whose values are used to populate the filter list.

The AInitSortByDisplayText parameter specifies whether filter items in the filter list are ordered by the display text or by value (see the SortByDisplayText property). Set the AInitSortByDisplayText parameter to True to sort filter items by display text.

The AUseFilteredValues parameter specifies whether all filter items, or only those that were used in the filter prior to the call, are added to the filter list. Set the AUseFilteredValues parameter to True to add only filter items from the previously used filter.

The AAddValueItems parameter specifies whether values (fviValue filter items) are added to the list. When the list is populated with values from a large dataset, obtaining these values may take time. To improve performance, pass False as the AAddValueItems parameter to prohibit adding fviValue filter items to the list. You can always manually extend the list with required values by handling the View’s DataController.Filter.OnGetValueList event.