How to: Implement Custom Filtering

• Aug 01, 2019
• 2 minutes to read

This example demonstrates how to implement custom filtering in the DXGrid control.

View Example

Window1.xaml

<Window x:Class="CustomFiltering.Window1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        Title="Window1" Height="300" Width="300">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="36" />
            <RowDefinition Height="*" />
        </Grid.RowDefinitions>
        <StackPanel Grid.Row="0" Orientation="Horizontal">
            <CheckBox Name="chkHideEven" Margin="7,0,7,0" VerticalAlignment="Center" 
                      Content="Hide Even Rows"
                      Checked="chk_CheckedOrUnchecked"
                      Unchecked="chk_CheckedOrUnchecked" />
            <CheckBox Name="chkHideOdd" VerticalAlignment="Center" Content="Hide Odd Rows"
                      Checked="chk_CheckedOrUnchecked" Unchecked="chk_CheckedOrUnchecked" />
        </StackPanel>
        <dxg:GridControl Name="grid" Grid.Row="1" AutoGenerateColumns="AddNew" CustomRowFilter="grid_CustomRowFilter">
            <dxg:GridControl.View>
                <dxg:TableView Name="view" AutoWidth="True" ShowGroupPanel="False" NavigationStyle="None" />
            </dxg:GridControl.View>
        </dxg:GridControl>
    </Grid>
</Window>

Window1.xaml.cs

using System.Windows;
using DevExpress.Xpf.Grid;

namespace CustomFiltering {

    public partial class Window1 : Window {

        public Window1() {
            InitializeComponent();
            grid.ItemsSource = new object[] { "A", "B", "C", "D", "E", "F", "G", "H" };
        }

        private void grid_CustomRowFilter(object sender, RowFilterEventArgs e) {
            if (chkHideOdd.IsChecked.Value && e.ListSourceRowIndex % 2 == 1)
                e.Visible = false;
            if (chkHideEven.IsChecked.Value && e.ListSourceRowIndex % 2 == 0)
                e.Visible = false;
            e.Handled = !e.Visible ? true : false;
        }

        private void chk_CheckedOrUnchecked(object sender, RoutedEventArgs e) {
            grid.RefreshData();
        }
    }
}

Window1.xaml.vb

Imports System.Windows
Imports DevExpress.Xpf.Grid

Namespace CustomFiltering

    Partial Public Class Window1
        Inherits Window

        Public Sub New()
            InitializeComponent()
            grid.ItemsSource = New Object() { "A", "B", "C", "D", "E", "F", "G", "H" }
        End Sub

        Private Sub grid_CustomRowFilter(ByVal sender As Object, ByVal e As RowFilterEventArgs)
            If chkHideOdd.IsChecked.Value AndAlso e.ListSourceRowIndex Mod 2 = 1 Then
                e.Visible = False
            End If
            If chkHideEven.IsChecked.Value AndAlso e.ListSourceRowIndex Mod 2 = 0 Then
                e.Visible = False
            End If
            e.Handled = If((Not e.Visible), True, False)
        End Sub

        Private Sub chk_CheckedOrUnchecked(ByVal sender As Object, ByVal e As RoutedEventArgs)
            grid.RefreshData()
        End Sub
    End Class
End Namespace