ContextQMD
Back to Devexpress

How to: Apply a Filter to a Column

windowsforms-3013-controls-and-libraries-data-grid-examples-filtering-how-to-apply-a-filter-to-a-column.md

latest3.0 KB
Original Source

How to: Apply a Filter to a Column

  • Mar 14, 2019
  • 2 minutes to read

Example 1

The following code selects records whose shipping country names start with ‘F’. The required filter is created using a ColumnFilterInfo object. It’s then assigned to the GridColumn.FilterInfo property.

csharp
using DevExpress.XtraGrid.Columns;

gridView1.Columns["ShipCountry"].FilterInfo = 
  new ColumnFilterInfo("[ShipCountry] LIKE 'F%'");
vb
Imports DevExpress.XtraGrid.Columns

GridView1.Columns("ShipCountry").FilterInfo = _
  New ColumnFilterInfo("[ShipCountry] LIKE 'F%'")

Example 2

The following code shows how to add a filter condition to a View via its ColumnView.ActiveFilter object. The filter condition selects records whose CategoryName fields start with ‘c’.

csharp
using DevExpress.XtraGrid.Views.Base;
using DevExpress.XtraGrid.Columns;
//...
ColumnView view = gridView1;
view.ActiveFilter.Add(view.Columns["CategoryName"], 
  new ColumnFilterInfo("[CategoryName] Like 'c%'", ""));
vb
Imports DevExpress.XtraGrid.Views.Base
Imports DevExpress.XtraGrid.Columns
'...
Dim view As ColumnView = GridView1
view.ActiveFilter.Add(view.Columns("CategoryName"), 
  New ColumnFilterInfo("[CategoryName] Like 'c%'", ""))

Example 3

The following code uses the ColumnView.ActiveFilter property to apply a filter. The filter selects records that contain “Produce” or “Seafood” in the CategoryName column.

csharp
using DevExpress.XtraGrid.Views.Base;
using DevExpress.XtraGrid.Columns;
//...
ColumnView view = gridView1;
GridColumn colCategory = view.Columns["CategoryName"];
ColumnFilterInfo filter = new ColumnFilterInfo("[CategoryName] = 'Produce' OR [CategoryName] = 'Seafood'", "");
view.ActiveFilter.Add(colCategory, filter);
vb
Imports DevExpress.XtraGrid.Views.Base
Imports DevExpress.XtraGrid.Columns
'...
Dim view As ColumnView = GridView1
Dim colCategory As GridColumn = view.Columns("CategoryName")
Dim filter As New ColumnFilterInfo("[CategoryName] = 'Produce' OR [CategoryName] = 'Seafood'", "")
view.ActiveFilter.Add(colCategory, filter)

Example 4

The following example selects records that contain a null value in the ‘Region’ field.

csharp
colRegion.FilterInfo = new DevExpress.XtraGrid.Columns.ColumnFilterInfo("[Region] IS NULL");
vb
colRegion.FilterInfo = New DevExpress.XtraGrid.Columns.ColumnFilterInfo("[Region] IS NULL")