Skip to main content

PivotGridFieldOptions.GroupFilterMode Property

Gets or sets the filtering mode used for the field’s owner group.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v22.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Dashboard.Design


public PivotGroupFilterMode? GroupFilterMode { get; set; }

Property Value

Type Default Description
Nullable<PivotGroupFilterMode> null

A PivotGroupFilterMode enumeration member that specifies the filtering mode used for the field’s owner group.

Available values:

Name Description




Property Paths

You can access this nested property as listed below:

Library Object Type Path to GroupFilterMode
Cross-Platform Class Library PivotGridFieldBase
WinForms Controls PivotGridField
Reporting XRPivotGridField
ASP.NET MVC Extensions MVCxPivotGridField
ASP.NET Web Forms Controls PivotGridField


The filtering mode used for a field group is defined by its first field. The GroupFilterMode property values of other fields are ignored.

If the GroupFilterMode property is set to PivotGroupFilterMode.Tree, the group filter is used to filter data against the group’s fields.


If the GroupFilterMode property is set to PivotGroupFilterMode.List, data is filtered against each of the group’s fields separately.


Otherwise, if the GroupFilterMode property is set to null, the filtering mode is defined by the PivotGridOptionsFilterBase.GroupFilterMode property.

Regardless of the currently selected group filter mode, you can customize both group and field filters in code. The customizations of the currently unused filter will take effect after switching the group filter mode.

To learn more, see Group Filtering.

See Also