[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
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
  [Collapse]Data Grid
   [Expand]Getting Started
   [Expand]Implementation Details
   [Expand]Grid View Data Layout
   [Expand]Binding to Data
   [Expand]Master-Detail Data Representation
   [Expand]Data Editing and Validation
   [Collapse]Filtering and Searching
     Filtering Overview
     Automatic Filter Row
     Filter Dropdown
     Filter Editor
     Filtering in Code
     Filter Expressions
     Allowed Filters
     Filter Modes and Custom Filtering
     Filtering Nodes
     Search Panel
     Incremental Search
   [Expand]Data Summaries
   [Expand]Paging and Scrolling
   [Expand]Focus and Navigation
   [Expand]Conditional Formatting
   [Expand]Appearance Customization
   [Expand]MVVM Enhancements
   [Expand]Printing and Exporting
   [Expand]End-User Interaction
   [Expand]Performance Improvement
   [Expand]Design-Time Features
   [Expand]Visual Elements
   [Expand]End-User Capabilities
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Rich Text Editor
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
[Expand]eXpressApp Framework
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Filtering in Code

The GridControl allows you to apply filters in the UI and in code. This topic explains how to apply filters in code.

Refer to the Filtering topic to learn how to apply a filter in the UI.

Expanded Applying a Filter to the Grid

Use the DataControlBase.FilterCriteria or DataControlBase.FilterString property to apply a filter to the grid. This filter can consist of multiple conditions applied to multiple columns. The DataControlBase.FilterChanged event fires when a filter is applied.

You should create a CriteriaOperator object or its descendant representing the filter expression when using the DataControlBase.FilterCriteria property:

You can apply filter criteria by parsing a filter string with the CriteriaOperator.Parse static method:

The DataControlBase.FilterString property allows you to specify a filter string:

End-users can modify filters that you set using the DataControlBase.FilterCriteria and DataControlBase.FilterString properties. Use the DataControlBase.FixedFilter property to specify a filter criteria that cannot be modified.

Expanded Applying a Filter to a Column

Use any of the following approaches to apply a filter to a column:

Use the column's ColumnBase.IsFiltered property to identify whether a filter is applied to the column. If this property returns true, you can obtain the column's filter using the DataControlBase.GetColumnFilterCriteria or DataControlBase.GetColumnFilterString method.

Expanded Clearing Filters

Clear GridControl filter

Set the DataControlBase.FilterCriteria property to null or the DataControlBase.FilterString property to an empty string to clear the GridControl's filter.

Clear column filter

Use the DataControlBase.ClearColumnFilter method to clear a column's filter.

Expanded See Also

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