SubstituteFilterEventArgs Class

Provides data for events that allow you to replace a data filter applied by an end-user.

Namespace: DevExpress.Data

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

public class SubstituteFilterEventArgs :
    EventArgs

VB.NET

Public Class SubstituteFilterEventArgs
    Inherits EventArgs

Related API Members

SubstituteFilterEventArgs is the data class for the following events:

Library	Related API Members
WinForms Controls	ColumnView.SubstituteFilter
	TreeList.SubstituteFilter
WPF Controls	GridControl.SubstituteFilter
	TreeListView.SubstituteFilter
ASP.NET Web Forms Controls	ASPxGridBase.SubstituteFilter

Remarks

When an end-user applies a data filter, the data control raises an event (e.g., GridControl.SubstituteFilter, TreeList.SubstituteFilter) that allows you to replace the filter applied by the end-user. To replace the applied filter, use the SubstituteFilterEventArgs.Filter argument. Do not modify the existing filter assigned to the argument, rather, specify a new filter.

Related GitHub Examples

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

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-customize-the-filter-criteria-before-it-is-applied-to-gridview-e4119/CS/FilterEvent/Form1.cs#L29

private void GridView_SubstituteFilter(object sender, SubstituteFilterEventArgs e) {
    e.Filter &= CriteriaOperator.Parse("getyear(OrderDate) = ?", Convert.ToInt32(this.beiShowByYear.EditValue));

how-to-make-the-auto-filter-rows-filter-accent-insensitive-e5021/CS/DxSample/MainForm.cs#L33

private void GridView_SubstituteFilter(object sender, SubstituteFilterEventArgs e) {
    e.Filter = GridFilterSubstitutor.Substitute(e.Filter);

VB.NET

how-to-customize-the-filter-criteria-before-it-is-applied-to-gridview-e4119/VB/FilterEvent/Form1.vb#L28

Private Sub GridView_SubstituteFilter(ByVal sender As Object, ByVal e As SubstituteFilterEventArgs) Handles GridView.SubstituteFilter
    e.Filter = e.Filter And CriteriaOperator.Parse("getyear(OrderDate) = ?", Convert.ToInt32(Me.beiShowByYear.EditValue))

how-to-make-the-auto-filter-rows-filter-accent-insensitive-e5021/VB/DxSample/MainForm.vb#L32

Private Sub GridView_SubstituteFilter(ByVal sender As Object, ByVal e As SubstituteFilterEventArgs) Handles GridView.SubstituteFilter
    e.Filter = GridFilterSubstitutor.Substitute(e.Filter)

Inheritance

Object

EventArgs

SubstituteFilterEventArgs