PivotGridGroup.FilterValues Property

Gets the group filter condition.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

[Browsable(false)]
public GroupFilterValues FilterValues { get; }
<Browsable(False)>
Public ReadOnly Property FilterValues As GroupFilterValues

Property Value

Type Description
GroupFilterValues

A GroupFilterValues object that represents the group filter condition.

Remarks

The group filter condition is used to filter data against the values of grouped fields, and identified by the collection of group filter values and the filter type.

Similar to the field values of grouped fields, the group filter values are hierarchically arranged. The PivotGroupFilterValues.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.

The group filter values are used to define which data source records should be processed by the pivot grid control. 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 GroupFilterValues.FilterType property is set to FieldFilterType.Included, only the data source records that correspond to one of the filter values will be processed. Otherwise, if the GroupFilterValues.FilterType property is set to FieldFilterType.Excluded, only the data source records that do not correspond to any filter value will be processed.

The filter values collection is automatically modified when an end-user checks/unchecks specific items via the group filter drop-down.

To learn more, see Group Filtering.

See Also