PivotSummaryFilter Class

Contains summary filter settings.

Namespace : DevExpress.XtraPivotGrid

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

NuGet Packages : DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

• C#
• VB.NET

public class PivotSummaryFilter :
    ISummaryFilter,
    IXtraSupportShouldSerialize,
    IPivotGridSummaryFilterItem

Public Class PivotSummaryFilter
    Implements ISummaryFilter,
               IXtraSupportShouldSerialize,
               IPivotGridSummaryFilterItem

Related API Members

The following members return PivotSummaryFilter objects:

• PivotGridFieldBase.SummaryFilter

Remarks

A PivotSummaryFilter object can be accessed using the PivotGridFieldBase.SummaryFilter property. This object allows you to configure and apply filtering by summaries.

To configure a summary filter, you should specify the range of summary values that should be included into the pivot grid. If you wish to apply filtering to Total or Grand Total values, additionally provide column and row fields that identify the target data detail level.

Note

Use null ( Nothing in Visual Basic) values to identify Grand Totals when specifying the target level. Note that if you specify null values for both fields (which identifies the degenerate (Grand Total, Grand Total) level), filtering will be disabled.

To apply summary filtering, use one of the following approaches.

• Call the PivotSummaryFilter.Apply method and pass summary filter settings as its parameters.
• Assign summary filter settings to the following properties.

See Filtering by Summaries for more information.

Inheritance

Object PivotSummaryFilter

See Also

PivotSummaryFilter Members

DevExpress.XtraPivotGrid Namespace