PivotGridFieldBase.SummaryFilter Property

Gets summary filtering settings.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

[Browsable(false)]
public PivotSummaryFilter SummaryFilter { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property SummaryFilter As PivotSummaryFilter

Property Value

Type	Description
PivotSummaryFilter	A PivotSummaryFilter object that encapsulates summary filtering settings.

Remarks

PivotGridControl allows you to filter its data by summary values. Use the SummaryFilter property to configure filtering by summary values calculated against the current data field.

Use the returned PivotSummaryFilter object to access summary filtering settings.

Note

You cannot use the CalculationBindingBase descendants to apply summary filter when Pivot Grid operates with Optimized calculation engine.

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

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 detail level or to the specified one.
  PivotSummaryFilter.ColumnField	Gets or sets a column field used to identify a detail level to which the filtering is applied.
  PivotSummaryFilter.RowField	Gets or sets the row field used to identify a detail level to which the filtering is applied.

For more information, see Filter by Summaries.