[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Collapse]Pivot Grid
   [Expand]Getting Started
   [Expand]Fundamentals
   [Expand]Binding to Data
   [Collapse]Data Shaping
    [Expand]Summarization
     Grouping
    [Expand]Sorting
    [Collapse]Filtering
      Prefilter
      Filter Drop-Down
      Filter Editor
      Filter Panel
      Filter Elements
      Group Filtering
      Filtering in Code
      OLAP Filtering Specifics
    [Expand]Data Formatting
   [Expand]Data Analysis
   [Expand]Layout
   [Expand]Printing and Exporting
   [Expand]End-User Interaction
   [Expand]Appearance
   [Expand]MVVM Enhancements
   [Expand]UI Elements
   [Expand]End-User Capabilities
   [Expand]Examples
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Gantt Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Filter Drop-Down

End users can use a field's filter drop-down to build a simple filter criterion and apply it to a field.

To invoke a filter drop-down, click a field's filter button. The filter drop-down contains unique field values. Use the PivotGridField.GetUniqueValues method to get these values in code.

Tip

To create complex filter criteria, use the Filter Editor.

Expanded Availability

End-users cannot filter data fields.

To hide filter buttons from all field headers, set the PivotGridControl.AllowFilter property to false. For individual fields, set the PivotGridField.AllowFilter property to false. This does not affect Filtering in Code.

Note

Excel-style filter drop-down does not work with OLAP data sources.

Expanded Drop-down Filter Modes

To switch modes:

Excel (default)

The Excel-style filter drop down contains two tabs:

  • The Filter Rules tab displays a drop-down list of valid operators for the current field type. This allows you to construct a filter criterion.

  • The Filter Values tab contains a checklist with the filter values. The shaded numbers in parentheses are record counts.

Feature Description API
Display only the records that meet the current filter criteria The filter drop-down contains all the unique field values, although some values do not meet criteria set by other field filters. You can remove unnecessary field values from the filter drop-down. Set the PivotGridControl.ShowOnlyAvailableFilterItems property to true.
Tip

Demo: Excel Style Filtering

Requires the installation of a WPF Subscription. Download

Legacy

The drop-down displays a list of values in a checked list box. It is based on the ListBoxEdit control.

Feature Description API
Display only the records that meet the current filter criteria The filter drop-down contains all the unique field values, although some values do not meet criteria set by other field filters. You can remove unnecessary field values from the filter drop-down. Set the PivotGridControl.ShowOnlyAvailableFilterItems property to true.
Group filter The group filter filters data against the values of grouped fields. Filter values are hierarchically arranged in a filter drop-down and displayed in a tree list. Set the PivotGridControl.GroupFilterMode property to GroupFilterMode.Tree.

Expanded Custom Filter Drop-down

To implement a new custom filter and use it instead of the built-in filter drop-down, create a data template and assign it to the The PivotGridField.CustomExcelStyleFilterPopupTemplate property.

The following code snippet uses the CalendarFilterElement (see CalendarFilterElement) to filter the Order Date field values:

The image below shows the result:

Note

The complete sample project How to Create a Custom Filter Drop-Down is available in the DevExpress Examples repository.

Expanded See Also

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