PivotGroupFilterValues.Values Property

Gets the collection of filter values.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

public PivotGroupFilterValuesCollection Values { get; set; }
Public Property Values As PivotGroupFilterValuesCollection

Property Value

Type Description
PivotGroupFilterValuesCollection

A PivotGroupFilterValuesCollection object representing the collection of filter values.

Remarks

The group filter values are used to define which data source records should be processed by the pivot grid control.

Similar to the field values of grouped fields, the group filter values are hierarchically arranged. The Values collection contains values from the first field in the group (first-level values). Each of the first-level values holds a collection of values from the second field in the group (child values), etc.

A group filter value corresponds to a data source record if the following conditions are met:

  • The data source record contains the group filter value in the respective field.
  • The data source record contains the group filter value's parent values in the respective fields.
  • The group filter value does not contain child values.

If the PivotGroupFilterValues.FilterType property is set to PivotFilterType.Included, only the data source records that correspond to one of the filter values will be processed. Otherwise, if the PivotGroupFilterValues.FilterType property is set to PivotFilterType.Excluded, only the data source records that do not correspond to any filter value will be processed.

Use the PivotGroupFilterValues.Count property to get the number of elements in the filter values collection. To obtain whether the collection is empty, use the PivotGroupFilterValues.IsEmpty property.

To learn more, see Group Filtering.

Implements

DevExpress.XtraPivotGrid.Data.IGroupFilter.Values
See Also