GridControl.CustomRowFilter Event

Enables you to filter data rows using custom rules.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v21.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event RowFilterEventHandler CustomRowFilter

VB.NET

Public Event CustomRowFilter As RowFilterEventHandler

Event Data

The CustomRowFilter event's data class is DevExpress.Xpf.Grid.RowFilterEventArgs.

Remarks

The custom filter allows you to hide or display specific rows that exist in a data source. The custom filter takes priority over filter criteria applied using a column’s filter dropdown or using the Automatic Filter Row.

To manually filter data rows, handle the CustomRowFilter event. This event is raised for each record in a data source. The currently processed record is identified by its index in a data source, returned by the event parameter’s ListSourceRowIndex property.

To hide or show a row, specify the event parameter’s Visible property, and set the Handled property to true. If the Handled parameter is set to false, the record’s visibility is determined by the filter currently applied to a View. So, the record will only be visible if it matches the View’s filter. Otherwise, it will be hidden.

Note

The CustomRowFilter event does not work in Server Mode.

If you want to maintain a clean MVVM pattern and specify custom filter operations in a View Model, create a command and bind it to the CustomRowFilterCommand property.

Example

The following example demonstrates how to apply a custom filter condition to the GridControl:

View Example: How to Apply a Custom Filter Condition

MainWindow.xaml

<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="OnCheckedChanged"
                  Unchecked="OnCheckedChanged" />
        <CheckBox Name="chkHideOdd"
                  VerticalAlignment="Center"
                  Content="Hide Odd Rows"
                  Checked="OnCheckedChanged"
                  Unchecked="OnCheckedChanged" />
    </StackPanel>
    <dxg:GridControl Name="grid"
                     Grid.Row="1" 
                     AutoGenerateColumns="AddNew"
                     CustomRowFilter="OnCustomRowFilter">
        <dxg:GridControl.View>
            <dxg:TableView Name="view"
                           AutoWidth="True"
                           ShowGroupPanel="False"
                           NavigationStyle="None" />
        </dxg:GridControl.View>
    </dxg:GridControl>
</Grid>

MainWindow.xaml.cs

void OnCustomRowFilter(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;
}

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

MainWindow.xaml.vb

Private Sub OnCustomRowFilter(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 OnCheckedChanged(ByVal sender As Object, ByVal e As RoutedEventArgs)
    grid.RefreshData()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomRowFilter event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

how-to-perform-case-sensitive-filtering-e3349/CS/WpfApplication1/MainWindow.xaml#L6

<Grid>
    <dxg:GridControl HorizontalAlignment="Left" Name="gridControl1" VerticalAlignment="Top" AutoPopulateColumns="True" CustomRowFilter="gridControl1_CustomRowFilter" Height="282">

wpf-data-grid-implement-custom-filtering/CS/CustomFiltering_CodeBehind/MainWindow.xaml#L28

             AutoGenerateColumns="AddNew"
             CustomRowFilter="OnCustomRowFilter">
<dxg:GridControl.View>

C#

wpf-data-grid-specify-row-visibility-in-viewmodel/CS/Grid MVVM Filtering/FilteredDataSupport.cs#L69

if(e.Property == ExcludedDataProperty)
    grid.CustomRowFilter += excludeOnCustomRowFilter;
else if(e.Property == VisibleDataProperty) {

VB.NET

wpf-data-grid-specify-row-visibility-in-viewmodel/VB/Grid MVVM Filtering/FilteredDataSupport.vb#L72

If e.Property Is ExcludedDataProperty Then
    AddHandler grid.CustomRowFilter, AddressOf excludeOnCustomRowFilter
ElseIf e.Property Is VisibleDataProperty Then