ColumnView.ActiveFilterCriteria Property

Gets or sets the current filter criteria.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Hidden)]
[Browsable(false)]
public CriteriaOperator ActiveFilterCriteria { get; set; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Hidden)>
<Browsable(False)>
Public Property ActiveFilterCriteria As CriteriaOperator

Property Value

Type	Description
CriteriaOperator	A CriteriaOperator object which represents the total filter criteria.

Remarks

Use the ActiveFilterCriteria property to specify the filter criteria by using a CriteriaOperator object. The property returns the same value as the ViewFilter.Criteria property of the ColumnView.ActiveFilter object. In specific instances you may want to assign the filter criteria by using a filter string. To do this, use the ColumnView.ActiveFilterString property.

Note that the filter can be temporarily disabled by using the ColumnView.ActiveFilterEnabled property.

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

For more information on filtering, see Filter and Search.

Example

The following code demonstrates how to create filter criteria and assign them to a Grid View via the ColumnView.ActiveFilterCriteria property. The criteria is created using the operators defined in the DevExpress.Data.Filtering namespace (the GroupOperator and BinaryOperator classes). The created criteria represent the filter expression: “[Extension] = ‘.gif’ OR [Extension] = ‘.png’”.

C#

using DevExpress.Data.Filtering;

CriteriaOperator expr1 = new BinaryOperator("Extension", ".gif");
CriteriaOperator expr2 = new BinaryOperator("Extension", ".png");
gridView1.ActiveFilterCriteria = GroupOperator.Or(new CriteriaOperator[] { expr1, expr2 });

VB.NET

Imports DevExpress.Data.Filtering

Dim expr1 As CriteriaOperator = New BinaryOperator("Extension", ".gif")
Dim expr2 As CriteriaOperator = New BinaryOperator("Extension", ".png")
gridView1.ActiveFilterCriteria = GroupOperator.Or(New CriteriaOperator() {expr1, expr2})

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveFilterCriteria 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-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/CS/WindowsApplication1/Form1.cs#L50

CriteriaOperator[] operands = new CriteriaOperator[2];
operands[0] = gridView1.ActiveFilterCriteria;
operands[1] = new BinaryOperator("ID", 5, BinaryOperatorType.Greater );

how-to-customize-the-filter-criteria-before-it-is-applied-to-gridview-e4119/CS/FilterEvent/Form1.cs#L26

    this.GridControl.DataMember = "Orders";
    this.GridView.ActiveFilterCriteria = CriteriaOperator.Parse("Freight > 0");
}

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/CS/RangeDate/MyGridControl/MyDateFilterPopup.cs#L155

    CalcControlsLocation((sender as CheckEdit).Text);
    this.View.ActiveFilterCriteria = GetFilterCriteriaByControlState();
}

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

DataView filteredDataView = new DataView(table);
filteredDataView.RowFilter = DevExpress.Data.Filtering.CriteriaToWhereClauseHelper.GetDataSetWhere(view.ActiveFilterCriteria);
return filteredDataView;

how-to-use-the-checkedcombobox-control-when-editing-isanyof-and-isnoneof-operands-e4223/CS/B217847Example/Form1.cs#L18

{
    gridView1.ActiveFilterCriteria = filterAdapter1.RowCriteria;
}

VB.NET

how-to-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/VB/Form1.vb#L47

Dim operands(1) As CriteriaOperator
operands(0) = gridView1.ActiveFilterCriteria
operands(1) = New BinaryOperator("ID", 5, BinaryOperatorType.Greater)

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

    Me.GridControl.DataMember = "Orders"
    Me.GridView.ActiveFilterCriteria = CriteriaOperator.Parse("Freight > 0")
End Sub

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/VB/RangeDate/MyGridControl/MyDateFilterPopup.vb#L171

    CalcControlsLocation((TryCast(sender, CheckEdit)).Text)
    Me.View.ActiveFilterCriteria = GetFilterCriteriaByControlState()
Else

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

Dim filteredDataView As New DataView(table)
filteredDataView.RowFilter = DevExpress.Data.Filtering.CriteriaToWhereClauseHelper.GetDataSetWhere(view.ActiveFilterCriteria)
Return filteredDataView

how-to-use-the-checkedcombobox-control-when-editing-isanyof-and-isnoneof-operands-e4223/VB/B217847Example/Form1.vb#L16

Private Sub OnFilterAdapterRowFilterChanged(ByVal sender As Object, ByVal e As EventArgs) Handles filterAdapter1.RowFilterChanged
    gridView1.ActiveFilterCriteria = filterAdapter1.RowCriteria
End Sub