FieldFilterValues Class

Contains filter values for a specific field.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v20.1.dll

Declaration

public class FieldFilterValues :
    PivotGridFieldFilterValues
Public Class FieldFilterValues
    Inherits PivotGridFieldFilterValues

Related API Members

The following members accept/return FieldFilterValues objects:

Remarks

A field's PivotGridField.FilterValues property of the FieldFilterValues class gives the ability to apply a filter to a field, i.e. select which of the records should be processed by the PivotGrid control. A filter specified by the PivotGridField.FilterValues property is in effect for filter fields, column fields and row fields.

The FieldFilterValues class stores filter values for a specific field. The filtering functionality is dependant upon the FieldFilterValues.FilterType property's value. It specifies whether the filter values should be displayed in or removed from the PivotGrid control.

If the FieldFilterValues.FilterType property is set to FieldFilterType.Included, the FieldFilterValues class stores the values which should be displayed within the control. In this instance, the PivotGrid control will only process those records that contain filter values in the corresponding field.

If the FieldFilterValues.FilterType property is set to FieldFilterType.Excluded, the FieldFilterValues class stores the values which will not be displayed within the control. In this instance, the PivotGrid control will only process those records that do not contain filter values in the corresponding field.

To add values to and remove them from the filter value list use the PivotGridFieldFilterValues.Add and PivotGridFieldFilterValues.Remove methods.

Specific fields can contain Null (or DBNull) values. The PivotGridFieldFilterValues.ShowBlanks property determines whether the records which contain Null values should be processed by the control. If this property is set to false summaries are not calculated against such records.

An end-user can apply a filter to a field via the filter dropdown. It can be activated by clicking the field's Filter Button. When an end-user checks/unchecks items within the filter dropdown this automatically modifies the filter value collection.

Examples

This example shows how to apply a filter to a field.

The first filter selects records which contain UK in the fieldCountry field, the second filter selects four categories in the fieldCategoryName field: Beverages, Condiments, Seafood, and Produce.

NOTE

A complete sample project is available at How to Apply a Filter to a Field.

    fieldCountry.SetFilterValues(new string[] { "UK" }, FieldFilterType.Included, true);
    fieldCategoryName.SetFilterValues(new string[] { "Beverages", "Condiments", "Seafood", "Produce" }, FieldFilterType.Included, true);

Inheritance

See Also