ViewFilter.Expression Property

Gets the total filter expression.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public string Expression { get; }

VB.NET

Public ReadOnly Property Expression As String

Property Value

Type	Description
String	A string value representing the total filter expression. An empty string if there are no elements in the collection.

Remarks

All the elements in the ViewFilter collection refer to specific filter conditions of the ColumnFilterInfo type. Each of these elements defines the filter expression used to filter the data and display text used to represent this expression within the filter panel.

The Expression property returns the total filter expression which is a combination of the individual filter expressions (individual filter expressions are combined using the Boolean AND operator). The ColumnView.RowFilter property returns the same value as the Expression property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Expression 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-get-a-list-of-data-rows-shown-in-a-filtered-grid-e691/CS/FilteredDataSourceHelperComponent/FilteredDataSourceHelper.cs#L29

if (view.ActiveFilter == null || !view.ActiveFilterEnabled
    || view.ActiveFilter.Expression == "")
    return view.DataSource as DataView;

VB.NET

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

End If
If view.ActiveFilter Is Nothing OrElse Not view.ActiveFilterEnabled OrElse view.ActiveFilter.Expression = "" Then
    Return TryCast(view.DataSource, DataView)