PivotSummaryFilter Class

Contains summary filter settings.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

public class PivotSummaryFilter :
    ISummaryFilter,
    IXtraSupportShouldSerialize,
    IPivotGridSummaryFilterItem

VB.NET

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 aggregation 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.

  PivotSummaryFilter.StartValue	Gets or sets the minimum summary value to be displayed.
  PivotSummaryFilter.EndValue	Gets or sets the maximum summary value to be displayed.
  PivotSummaryFilter.Mode	Gets or sets whether summary filtering should be applied to the last aggregation level or to the specified one.
  PivotSummaryFilter.ColumnField	Gets or sets a column field used to identify an aggregation level to which the filtering is applied.
  PivotSummaryFilter.RowField	Gets or sets the row field used to identify an aggregation level to which the filtering is applied.

  To avoid unnecessary control updates while customizing these properties, wrap the code in the PivotGridControl.BeginUpdate and PivotGridControl.EndUpdate method calls. To ensure that the PivotGridControl.EndUpdate method is executed even if an exception occurs, you can also wrap calls to the PivotGridControl.BeginUpdate and PivotGridControl.EndUpdate methods in a try…finally statement.

See Filtering by Summaries for more information.

Inheritance

Object

PivotSummaryFilter