Skip to main content

PivotSummaryFilter.Mode Property

Gets or sets whether summary filtering should be applied to the last detail level or to the specified one.

Namespace: DevExpress.XtraPivotGrid

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

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

Declaration

[DefaultValue(PivotSummaryFilterMode.LastLevel)]
public PivotSummaryFilterMode Mode { get; set; }

Property Value

Type Default Description
PivotSummaryFilterMode LastLevel

A PivotSummaryFilterMode enumeration member that specifies whether summary filtering should be applied to the last detail level or to the specified one.

Available values:

Name Description
LastLevel

Summary filtering is applied to cells that belong to the lowest detail level (the one identified by the innermost column and row fields).

SpecificLevel

Summary filtering is applied to cells that belong to a detail level specified by an end-user or in code via the PivotSummaryFilter.ColumnField and PivotSummaryFilter.RowField properties.

Remarks

Summary filtering cannot be simultaneously enabled for Totals, Grand Totals and data cells calculated against the same data field. It can only be applied to cells that belong to the same detail level.

By default, the Mode property is set to PivotSummaryFilterMode.LastLevel and summary filtering is applied to cells that belong to the lowest detail level (a level identified by the innermost column and row fields).

You can use the PivotSummaryFilter.ColumnField and PivotSummaryFilter.RowField properties to specify other levels, except for the (Grand Total, Grand Total) level that consists of only one cell. To enable filtering at a specified level, set the Mode property to PivotSummaryFilterMode.SpecificLevel.

As an alternative to specifying summary filter settings using properties exposed by the PivotSummaryFilter object, you can call an appropriate overload of the PivotSummaryFilter.Apply method and pass these settings as parameters.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Mode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also