[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]Aggregation
     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)

Prefilter

The legacy approach is a combination of two filters available to end users:

  • Prefilter feature applies a filter to the underlying data source before displaying data in the PivotGridControl.
  • Drop-down filters which filter visible fields.
Note

The Prefilter is not supported in OLAP mode.

Set the PivotGridControl.UseLegacyFilterEditor property to true to enable the Prefilter feature.

Expanded Prefilter Editor

The Prefilter editor allows end users to build complex filter criteria with multiple conditions, combined by logical operators. End users can right-click the field header and select Show Prefilter in the context menu to invoke the editor.

To hide the Show Prefilter menu item, set the PivotGridControl.AllowPrefilter property to false.

In code, call the PivotGridControl.ShowPrefilter method to invoke the Prefilter editor.

Expanded Prefilter Panel

The Prefilter Panel is automatically shown a the bottom of the PivotGridControl after a filter is applied and the Prefilter feature is enabled (the PivotGridControl.AllowPrefilter property is set to true).

The Prefilter Panel displays the following elements:

  • Prefilter expression

  • MRU filter button used to display the most recently used Prefilter criteria

  • Edit button used to invoke a Filter Editor

  • Enable/Disable Filter check box used to temporarily enable/disable the filter

  • Clear Filter button used to reset the current filter condition.

To make this panel always visible or always hidden, use the PivotGridControl.ShowPrefilterPanelMode property.

Expanded Prefilter API

The Prefilter allows you to access its settings and specify filter criteria in code. You can use the following properties and methods to do this:

PivotGridControl.PrefilterCriteria

PivotGridControl.PrefilterString

Gets or sets a filter expression.

PivotGridControl.IsPrefilterEnabled

Gets or sets whether the filter specified by the Prefilter is enabled.

PivotGridControl.IsPrefilterVisible

Gets whether the Prefilter is invoked.

PivotGridControl.ShowPrefilter

PivotGridControl.HidePrefilter

Invokes/hides the Filter Editor.

PivotGridControl.AllowPrefilter

Gets or sets whether end-users are allowed to invoke the Prefilter.

When you create a filter expression in code, use the PivotGridField.PrefilterColumnName property to refer to a field. The sample below shows how to do this.

Note

The Prefilter cannot filter data against data fields. If a filter criteria include a data field, an error message is shown in the Prefilter Panel. This message also appears if filter criteria contain a field name that does not exist.

After a filter condition changes (in a Filter Editor or in code), the PivotGridControl.PrefilterCriteriaChanged event occurs.

Expanded See Also

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