PivotGridOptionsFilterBase.GroupFilterMode Property

Gets or sets the filtering mode used for field groups.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

[DefaultValue(PivotGroupFilterMode.Tree)]
public PivotGroupFilterMode GroupFilterMode { get; set; }
<DefaultValue(PivotGroupFilterMode.Tree)>
Public Property GroupFilterMode As PivotGroupFilterMode

Property Value

Type Default Description
PivotGroupFilterMode

Tree

A PivotGroupFilterMode enumeration member that specifies the filtering mode used for field groups.

Property Paths

You can access this nested property as listed below:

Library Object Type Path to GroupFilterMode
WinForms Controls PivotGridControl
.OptionsFilterPopup.GroupFilterMode
ASP.NET Controls and MVC Extensions ASPxPivotGrid
.OptionsFilter.GroupFilterMode
MVCxPivotGrid
.OptionsFilter.GroupFilterMode
PivotGridSettings
.OptionsFilter.GroupFilterMode

Remarks

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

pivotgrid_GroupFilterMode_GroupFilterDropdown

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

pivotgrid_GroupFilterMode_FieldFilterDropdown

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 specify filtering mode for an individual field group, assign the appropriate value to the PivotGridFieldOptions.GroupFilterMode property of the first field in the group.

To learn more, see Group Filtering.

NOTE

When the GroupFilterMode property is set to PivotGroupFilterMode.Tree, the PivotGridOptionsFilterBase.ShowOnlyAvailableItems property is not in effect.

See Also