TcxPivotGridFieldFilter Class
Contains filter values for a specific field.
Declaration
TcxPivotGridFieldFilter = class(
TPersistent
)Remarks
A field’s Filter property of the TcxPivotGridFieldFilter type allows a filter to be applied to a field, i.e. specify which of the records should be processed by the ExpressPivotGrid control. A filtering condition is in effect for filter fields, column fields and row fields.
The TcxPivotGridFieldFilter class stores filter values for a specific field. A filtering condition can be specified using the Values and FilterType properties which correspond to a list of field values and a clause that indicates whether the resulting set of values includes the specified field values or excludes them from the set as if it contains all the field values by default. If the FilterType property is set to the ftIncluded value, only the records which contain field values from the Values collection are displayed by the pivot grid. Otherwise, if the FilterType property is set to the ftExcluded value, only the records that do not contain values from this collection are displayed.
To add values to and remove them from the filter value collection, use the Add and Remove methods.
An end-user can apply a filter to a field via the filter dropdown which can be activated by clicking the field’s Filter Button. By checking/unchecking items within the filter dropdown, an end-user is able to modify the filter value collection.