ColumnView.ColumnFilterChanged Event

Occurs when a column’s filter condition changes. This event also raises when the Find Panel finishes its search.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DXCategory("Property Changed")]
public event EventHandler ColumnFilterChanged

VB.NET

<DXCategory("Property Changed")>
Public Event ColumnFilterChanged As EventHandler

Event Data

The ColumnFilterChanged event's data class is EventArgs.

Remarks

If the column’s OptionsColumnFilter.AllowFilter option is enabled, users can use the column’s Filter DropDown or the column header context menu to change filter conditions. To change filter conditions in code, modify the GridColumn.FilterInfo property.

You can also apply filters by multiple columns. Refer to the Filter and Search topic for more details.

Each time a column filter condition changes, the ColumnFilterChanged event occurs.

The code sample below illustrates how to detect if the user has applied any filters to the grid.

C#

using DevExpress.XtraGrid.Views.Grid;

..

gridView1.ColumnFilterChanged += GridView1_ColumnFilterChanged;

private void GridView1_ColumnFilterChanged(object sender, EventArgs e)
{
    GridView view = sender as GridView;
    if (view.ActiveFilterString == "")
        XtraMessageBox.Show("The grid has no filters applied");
    else
        XtraMessageBox.Show(string.Format("The grid has the following filter applied: {0}", view.ActiveFilterString));

}

VB.NET

Imports DevExpress.XtraGrid.Views.Grid

..

Private gridView1.ColumnFilterChanged += AddressOf GridView1_ColumnFilterChanged

Private Sub GridView1_ColumnFilterChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim view As GridView = TryCast(sender, GridView)
    If view.ActiveFilterString = "" Then
        XtraMessageBox.Show("The grid has no filters applied")
    Else
        XtraMessageBox.Show(String.Format("The grid has the following filter applied: {0}", view.ActiveFilterString))
    End If

End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnFilterChanged 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#

how-to-get-a-list-of-data-rows-shown-in-a-filtered-grid-e691/CS/FilteredDataSourceHelperComponent/FilteredDataSourceHelperComponent.cs#L51

    gridView.DataSourceChanged -= gridView_DataSourceChanged;
    gridView.ColumnFilterChanged -= gridView_ColumnFilterChanged;
}

VB.NET

how-to-get-a-list-of-data-rows-shown-in-a-filtered-grid-e691/VB/FilteredDataSourceHelperComponent/FilteredDataSourceHelperComponent.vb#L50

    RemoveHandler gridView.DataSourceChanged, AddressOf gridView_DataSourceChanged
    RemoveHandler gridView.ColumnFilterChanged, AddressOf gridView_ColumnFilterChanged
End Sub