ColumnView.ActiveFilterString Property

Gets or sets the total filter expression for the current View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[XtraSerializableProperty(1000)]
[XtraSerializablePropertyId(3)]
[Browsable(false)]
[DefaultValue("")]
public string ActiveFilterString { get; set; }

VB.NET

<XtraSerializableProperty(1000)>
<XtraSerializablePropertyId(3)>
<Browsable(False)>
<DefaultValue("")>
Public Property ActiveFilterString As String

Property Value

Type	Default	Description
String	String.Empty	A string that specifies the total filter expression applied to the current View.

Remarks

Reading the ActiveFilterString property returns the value of the ViewFilter.Expression property of the ColumnView.ActiveFilter object.

Assigning any filter string to the ActiveFilterString property clears any filters that have been previously assigned, and then applies a new filter expression to the View.

The ActiveFilterString and ColumnView.ActiveFilterCriteria properties can’t be used to filter data by a field that isn’t represented by a column in the current View.

Example

This example demonstrates how to assign a filter to a View using the ColumnView.ActiveFilterString property.

C#

gridView1.ActiveFilterString = "([ProductID] = 1 OR [ProductID] = 3 " + 
  "OR [ProductID] > 10) AND [Discount] = 0";

VB.NET

GridView1.ActiveFilterString = "([ProductID] = 1 OR [ProductID] = 3 " & _
  "OR [ProductID] > 10) AND [Discount] = 0"

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveFilterString 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-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/CS/WindowsApplication3/FilterNameProvider.cs#L87

if (string.IsNullOrEmpty(filterNameEdit.Text.Trim())) return;
GridFitlerItem fItem = filters.FirstOrDefault(it => it.FilterString == view.ActiveFilterString);
if (fItem == null)

how-to-pass-the-specific-data-when-navigating-through-containers-e4613/CS/ParamNavigation/ucDetails.cs#L26

    detailsID = (args.Parameter as ParamNavigation.nwindDataSet.EmployeesRow).EmployeeID.ToString();
    layoutView1.ActiveFilterString = "[EmployeeID] = " + detailsID;
}

winforms-filtercontrol-assign-custom-editors-to-value-operands/CS/CustomEditor/Form1.cs#L27

    gridControl1.DataSource = tbl;
    gridView1.ActiveFilterString = "[Payment] Between (50, 120)";
}

how-to-implement-your-own-filter-builder-dialog-for-the-gridview-e1919/CS/B143073/Form1.cs#L19

    this.productsTableAdapter.Fill(this.nwindDataSet.Products);
    myGridView1.ActiveFilterString = "CategoryID = 1";
}

how-to-set-focus-to-filtered-value-in-the-filter-popup-list-box-e2851/CS/Form1.cs#L28

    gridControl1.DataSource = tbl;
    gridView1.ActiveFilterString = "[Item] = 'Item5'";
}

VB.NET

how-to-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/VB/WindowsApplication3/FilterNameProvider.vb#L90

End If
Dim fItem As GridFitlerItem = filters.FirstOrDefault(Function(it) it.FilterString = view.ActiveFilterString)
If fItem Is Nothing Then

how-to-pass-the-specific-data-when-navigating-through-containers-e4613/VB/ucDetails.vb#L29

    detailsID = (TryCast(args.Parameter, ParamNavigation.nwindDataSet.EmployeesRow)).EmployeeID.ToString()
    layoutView1.ActiveFilterString = "[EmployeeID] = " & detailsID
End Sub

winforms-filtercontrol-assign-custom-editors-to-value-operands/VB/CustomEditor/Form1.vb#L30

    gridControl1.DataSource = tbl
    gridView1.ActiveFilterString = "[Payment] Between (50, 120)"
End Sub

how-to-implement-your-own-filter-builder-dialog-for-the-gridview-e1919/VB/B143073/Form1.vb#L21

    Me.productsTableAdapter.Fill(Me.nwindDataSet.Products)
    myGridView1.ActiveFilterString = "CategoryID = 1"
End Sub

how-to-set-focus-to-filtered-value-in-the-filter-popup-list-box-e2851/VB/Form1.vb#L31

    gridControl1.DataSource = tbl
    gridView1.ActiveFilterString = "[Item] = 'Item5'"
End Sub