GridControl.CustomRowFilter Event

Enables you to filter data rows using custom rules.

Namespace: DevExpress.Xpf.Grid

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

Declaration

public event RowFilterEventHandler CustomRowFilter

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 ViewModel, create a command and bind it to the GridControl.CustomRowFilterCommand property.

Example

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

View Example

<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>
See Also