Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Collapse]Controls and Libraries
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
   Reporting
  [Collapse]Data Grid
   [Expand]Getting Started
   [Expand]Implementation Details
   [Expand]Views
   [Expand]Grid View Data Layout
   [Expand]Binding to Data
   [Expand]Master-Detail Data Representation
   [Expand]Data Editing and Validation
   [Expand]Grouping
   [Expand]Selection
   [Collapse]Filtering and Searching
     Filtering Overview
     Automatic Filter Row
     Filter Dropdown
     Filter Editor
     Filter Modes and Custom Filtering
     Filtering in Code
     Filter Expressions
     Search Panel
     Incremental Search
     Filtering Nodes
   [Expand]Sorting
   [Expand]Data Summaries
   [Expand]Data Scrolling
   [Expand]Focus and Navigation
   [Expand]Conditional Formatting
   [Expand]Drag and Drop Overview
   [Expand]Appearance Customization
   [Expand]MVVM Enhancements
   [Expand]Printing and Exporting
   [Expand]End-User Interaction
   [Expand]Miscellaneous
   [Expand]Performance Improvement
   [Expand]Design-Time Features
   [Expand]Visual Elements
   [Expand]End-User Capabilities
   [Expand]Examples
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Expand]Scheduler (new)
  [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]Diagram Control
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Filter Dropdown

Expanded Overview

A column's filter dropdown list provides runtime filtering capabilities. A filter dropdown displays items that represent unique values within a column. To filter data against a column, an end-user should invoke the column's filter dropdown list and select any item(s) in this list. This automatically filters data (displays records that have the selected value(s) in the current column). Filter dropdown lists also display MRU items (most recently used items) and predefined items (All), (Blanks) and (Non Blanks).

To show a filter dropdown list, an end-user should click the filter button within a column header.

Expanded Availability

An end-user can invoke a column's Filter Dropdown if the view's DataViewBase.AllowColumnFiltering property is set to true. Grid columns provide the ColumnBase.AllowColumnFiltering option that enables you override the default behavior specified by a View. For instance, you can set a column's ColumnBase.AllowColumnFiltering property to DefaultBoolean.False and prevent an end-user from filtering data by its values using the filter dropdown.

Expanded Excel Style Filtering

The TableView provides an Excel inspired filter dropdown. The Excel-style filter dropdown allows your end-users to create filter criteria in a more flexible way. The dropdown consists of two tabs.

  • The Filter Rules tab displays predefined, most relevant filter conditions for the current column's data type.

  • The Filter Values tab provides an Excel-like checklist with all of the available values. For the DateTime columns, the Excel-style filter provides a tree-like presentation of filter values.

       

Bult-in smart search

The Excel-style filter dropdown provides a search box that allows your end-users to easily find the required filter values.

   

You can enable the Excel-inspired filtering for:

Expanded Regular and Checked Dropdown Lists

The filter dropdown can be represented as a regular list of items (one item at a time can be selected) or as a checked list (multiple items can be selected/checked simultaneously):

By default, filter dropdowns of all non-date-time columns are represented by regular lists. To use a checked filter dropdown list for a column, set the column's ColumnBase.FilterPopupMode property to FilterPopupMode.CheckedList. The following table summarizes differences between regular and checked filter dropdown lists:

Feature Regular Filter Dropdown List Checked Filter Dropdown List
Selection One item at one time can be selected Multiple items can be selected simultaneously
Clear Filter Click the (All) item. This cancels any filtering by the current column. Click the (Select All) item
MRU Items Yes No
(Blanks) and (Non Blanks) Items

Yes

(Blanks) - Displays the records which contain DBNull values in the current column.

(Non Blanks) - Displays records which do not contain DBNull values in the current column.

Yes

Set DataControlBase.ImplyNullLikeEmptyStringWhenFiltering to true.

Adding Custom Items Yes No
Deleting Individual Items Yes Yes

By default, a filter dropdown displays all unique values in a column. To limit the number of items displayed within the filter dropdown, use the ColumnBase.ColumnFilterPopupMaxRecordsCount property.

If the filter dropdown is represented as a checked list (multiple items can be checked/unchecked simultaneously) or by a custom template, use the ColumnBase.ImmediateUpdateColumnFilter property to enable or disable automatic updates. If automatic updates are disabled, the filter is applied after the filter dropdown has been closed.

If a column's filter dropdown is represented as a regular list of items, only one item at a time can be selected. In this instance, selecting an item automatically updates the column's filter and closes the filter dropdown.

Expanded Date-Time Filter Dropdown

The WPF Grid provides the calendar dropdown for date-time columns. By default, the ColumnBase.FilterPopupMode propery for date-time columns is set to FilterPopupMode.DateSmart. To change the set of predefined values within the calendar, set this property to one of the following values: FilterPopupMode.Date, FilterPopupMode.DateCompact, FilterPopupMode.DateAlt.

Expanded Custom Filter Dropdowns

If you don't want to use built-in filter dropdowns (list or checked list), you can provide your own filter dropdown via templates. In this instance, you should do the following:

For an example, please see How to: Create a Custom Filter Dropdown.

Expanded Example: How to Customize a Column's Filter Dropdown List

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E1533.

This example shows how to remove default items from the 'Date' column's Filter Dropdown, and add three custom items:

  • (All) - Cancels filtering
  • Registered in 2008 - Shows users that #were registered in 2008
  • Registered in 2009 - Shows users that #were registered in 2009

The image below shows the result:

How would you rate this topic?​​​​​​​