DataControlBase.FilterChanged Event

Occurs after the grid’s filter has been changed.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event RoutedEventHandler FilterChanged

VB.NET

Public Event FilterChanged As RoutedEventHandler

Event Data

The FilterChanged event's data class is RoutedEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance.
Source	Gets or sets a reference to the object that raised the event.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes.

Remarks

The FilterChanged event is fired in the cases listed below:

• The grid’s filter (DataControlBase.FilterString) has been changed.
• The filter’s state has been changed by toggling the Filter Button displayed within the Filter Panel.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterChanged 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.

C#

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

    grid.CustomRowFilter += OnCustomRowFilter;
    grid.FilterChanged += OnFilterChanged;
}

wpf-data-grid-create-event-raised-on-layout-changes/CS/E4609/Implementation/GridLayoutHelper.cs#L25

    Grid.SortInfo.CollectionChanged += OnSortInfoChanged;
    Grid.FilterChanged += OnGridFilterChanged;
}

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/CS/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.cs#L38

this.IsVisibleChanged += ThisIsVisibleChanged;
this._Grid.FilterChanged += GridFilterChanged;
ThemeManager.ThemeChanged += ThemeChanged;

VB.NET

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

    AddHandler grid.CustomRowFilter, AddressOf OnCustomRowFilter
    AddHandler grid.FilterChanged, AddressOf OnFilterChanged
End If

wpf-data-grid-create-event-raised-on-layout-changes/VB/E4609/Implementation/GridLayoutHelper.vb#L27

    AddHandler Grid.SortInfo.CollectionChanged, AddressOf OnSortInfoChanged
    AddHandler Grid.FilterChanged, AddressOf OnGridFilterChanged
End Sub

wpf-data-grid-pass-filtered-data-to-viewmodel/VB/ExpressionEvaluator Filter/FilteredDataSupport.vb#L28

If e.OldValue Is Nothing AndAlso e.NewValue IsNot Nothing Then
    AddHandler grid.FilterChanged, AddressOf OnFilterChanged
ElseIf e.OldValue IsNot Nothing AndAlso e.NewValue Is Nothing Then

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/VB/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.vb#L40

AddHandler IsVisibleChanged, AddressOf ThisIsVisibleChanged
AddHandler _Grid.FilterChanged, AddressOf GridFilterChanged
AddHandler ThemeManager.ThemeChanged, AddressOf ThemeChanged