PivotGroupFilterValues.FilterType Property

Gets or sets the filter type.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

[DefaultValue(PivotFilterType.Excluded)]
public PivotFilterType FilterType { get; set; }

Property Value

Type Default Description
PivotFilterType

Excluded

A PivotFilterType enumeration member that specifies the filter type.

Available values:

Name Description
Excluded

Specifies that the XtraPivotGrid control should not display the filter values. All the other values will be displayed.

Included

Specifies that the XtraPivotGrid control should display only the filter values.

Remarks

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

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.

To learn more, see Group Filtering.

See Also