PivotGridField.FilterValues Property

Gets or sets the filter values for the current field.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

Declaration

C#

[XtraSerializablePropertyId(0)]
[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Content)]
public FieldFilterValues FilterValues { get; }

VB.NET

<XtraSerializablePropertyId(0)>
<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Content)>
Public ReadOnly Property FilterValues As FieldFilterValues

Property Value

Type	Description
FieldFilterValues	A FieldFilterValues object which contains filter values for the current field.

Remarks

The FilterValues property can be used to specify which of the records in the data source should be displayed and used to calculate summaries within the DXPivotGrid control. The PivotGridFieldFilterValues.Values property defines an array of filter values.

If the FieldFilterValues.FilterType property is set to FieldFilterType.Excluded the records in the data source which contain filter values in the current field are not processed by the DXPivotGrid control.

If the FieldFilterValues.FilterType property is set to FieldFilterType.Included only the records which contain filter values in the current field are processed by the DXPivotGrid control.

An end-user automatically modifies the filter values collection when checking/unchecking specific items via the field's filter dropdown.