SubstituteFilterEventArgs.Filter Property

Gets or sets the filter applied to a data control.

Namespace: DevExpress.Data

Assembly: DevExpress.Data.v19.1.dll

Declaration

C#

public CriteriaOperator Filter { get; set; }

VB.NET

Public Property Filter As CriteriaOperator

Property Value

Type	Description
CriteriaOperator	A CriteriaOperator object that specifies the filter applied to a data control.

Remarks

Do not modify the existing filter assigned to the Filter property, rather, specify a new filter.

Related GitHub Examples

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

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#L30

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#L34

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#L29

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))
End Sub

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

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