[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]What's Installed
 [Expand]Common Concepts
 [Collapse]ASP.NET WebForms Controls
   Getting Started
  [Collapse]Grid View
   [Expand]Product Information
    Getting Started
    [Expand]Bind to Data
    [Expand]Data Representation Basics
    [Expand]Focus and Navigation
    [Expand]Edit Data
    [Expand]Use Data Summaries
    [Collapse]Filter Data
      Filtering in Code
      Filter Row
      Filter Control
      Header Filter
      Search Panel
    [Expand]Group Data
    [Expand]Sort Data
     Merge Data Cells
     Save and Restore Client Layout
    [Expand]Format Data
    [Expand]Master-Detail Relationship
     Appearance Customization
     GridView Table Layout
    Grid Designer
   [Expand]Visual Elements
   [Expand]Member Tables
  [Expand]Tree List
  [Expand]Card View
  [Expand]Chart Control
  [Expand]Pivot Grid
  [Expand]Rich Text Editor
  [Expand]Site Navigation and Layout
  [Expand]HTML Editor
  [Expand]Vertical Grid
  [Expand]Data Editors
  [Expand]Docking and Popups
  [Expand]File Management
  [Expand]Data and Image Navigation
  [Expand]Multi-Use Site Controls
  [Expand]Spell Checker
  [Expand]Query Builder
 [Expand]ASP.NET MVC Extensions
 [Expand]Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[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)

Filter Control

This topic contains the following sections.

The filter control allows end-users to build complex filter criteria with an unlimited number of filter conditions, combined by logical operators.

Expanded How to Invoke the Filter Control

The filter control can be invoked by clicking the filter image or filter expression displayed in the Filter Bar, whose visibility is controlled by the ASPxGridSettings.ShowFilterBar property.

The ASPxGridSettings.ShowFilterBar property can be set to the following values.

  • Hidden - The filter bar is always hidden.
  • Visible - The filter bar is always visible.
  • Auto - The filter bar is visible when grid data is filtered (e.g., by the Filter Row or Header Filter).

You can show and hide the filter control in code using the following methods.

Action Client-side methods Server-side methods
Show ASPxClientGridView.ShowFilterControl ASPxGridBase.ShowFilterControl
Hide ASPxClientGridView.CloseFilterControl ASPxGridBase.HideFilterControl

Expanded How to Specify Visibility of Filter Control Elements

Column Visibility

Be default, the filter control allows end-users to create criteria with columns that are visible in the grid. Set the ASPxGridFilterControlSettings.ShowAllDataSourceColumns property to true to display all data source columns in the filter control.

The filter control can display hierarchical columns provided that the ASPxGridFilterControlSettings.AllowHierarchicalColumns property is set to true. In this case, you can use the ASPxGridFilterControlSettings.MaxHierarchyDepth property to limit the max hierarchy depth level.

Tab Visibility

End-users can create filter criteria using visual representation (Visual tab) or by typing the criteria as text (Text tab). The content of the tabs is automatically synchronized. Note that the Text tab is disabled by default, and the Visual tab header is not displayed. Set the ASPxGridFilterControlSettings.ViewMode property to VisualAndText to enable them.

Group Operator Visibility

You can control the visibility of group operators displayed in the drop-down menu using the ASPxGridFilterControlSettings.GroupOperationsVisibility property.

Operand Type Button Visibility

The operand type button allows end-users to switch a filter condition between two modes: comparing a field's value to a value; or comparing a field's value to another field's value. Button visibility is controlled by the ASPxGridFilterControlSettings.ShowOperandTypeButton property.

Expanded Visibility of Filter Operators

The filter control drop-down window displays different comparison operators based on the column data type. The table below lists comparison operator visibility for different column types.

Filter Comparison Operator String Column* ComboBox Column Binary Image Column Date Column Other Type Column (Numbers, etc.)
Equals yes yes (default value) no yes (default value) yes
Does not equal yes yes no yes yes
Is greater than yes no no yes yes (default value)
Is greater than or equal to yes no no yes yes
Is less than yes no no yes yes
Is less than or equal to yes no no yes yes
Is between yes no no yes yes
Is not between yes no no yes yes
Contains yes no no no no
Does not contain yes no no no no
Begins with yes (default value) no no no no
Ends with yes no no no no
Is like yes no no no no
Is not like yes no no no no
Is blank yes yes no yes yes
Is not blank yes yes yes (default value) yes yes
Is any of yes yes yes yes yes
Is none of yes yes no yes yes
Date operators** no no no yes no

*A string column is a column containing string values or a column whose GridDataColumnSettings.FilterMode property is set to DisplayText.

**For date columns, the filter control displays an additional list of date operators.

Expanded See Also

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