[Expand]General Information
[Collapse]WinForms Controls
  .NET Core Support
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications, and Dialogs
  [Expand]Editors and Simple Controls
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Property Grid
  [Collapse]Pivot Grid
   [Expand]Getting Started
   [Expand]Binding to Data
   [Collapse]Data Shaping
      Filtering Overview
      Group Filtering
     [Collapse]Filtering by Summaries
       Filtering by Summaries Overview
       Using Summary Filters
     [Expand]OLAP Filtering Specifics
     Data Formatting
   [Expand]Data Analysis
   [Expand]Focus and Navigation
   [Expand]Printing and Exporting
   [Expand]Design-Time Features
   [Expand]UI Elements
   [Expand]End-User Capabilities
   [Expand]Member Tables
  [Expand]Tree List
  [Expand]Gantt Control
  [Expand]Chart Control
  [Expand]Map Control
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Sunburst Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Using Summary Filters

Pivot Grid Control provides a comprehensive UI to enable end-users to configure summary filtering with ease. The pivot grid also allows you to keep full control over summary filter settings in code via an extensive API.

Expanded End-User Capabilities

End-users can configure summary filters via a Summary Filter Popup Window. To invoke this window, click the filter button displayed within the header of a Data Field.

Use the PivotGridOptionsCustomization.AllowFilterBySummary property (or the PivotGridFieldOptions.AllowFilterBySummary property for individual fields) to specify whether or not end-users are allowed to invoke a Summary Filter Popup Window.

To learn how to use summary filter popup windows, see Filtering by Summary Values in the End-User Capabilities section.

For more information about visual elements displayed within these windows, see Summary Filter Popup Window.

Expanded Filtering by Summaries in Code

Summary filter settings are encapsulated in the PivotSummaryFilter object exposed via the PivotGridFieldBase.SummaryFilter property.

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.


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.

To specify a valid summary filter range in code, you may need to know the maximum and minimum summary values calculated against the current data field. Use the PivotGridFieldBase.GetSummaryInterval method to obtain these values.

Expanded Example

The following example shows how to apply a summary filter to PivotGridControl data that belongs to a particular aggregation level.

In this example, Pivot Grid Control displays product sales by country. The summary filter is applied to country totals calculated for individual products, so that only values that fall into the range from 500 to 2500 are included.

The range of included values is specified using the PivotSummaryFilter.StartValue and PivotSummaryFilter.EndValue properties. To enable filtering only for the selected aggregation level, the PivotSummaryFilter.Mode property is set to PivotSummaryFilterMode.SpecificLevel. To identify this level, the PivotSummaryFilter.RowField and PivotSummaryFilter.ColumnField properties are set to fieldProductName and fieldCountry respectively.


A complete sample project is available at https://github.com/DevExpress-Examples/how-to-apply-summary-filter-e4390

Expanded See Also

Is this topic helpful?​​​​​​​