ColumnView.GetFilterDisplayText(ViewFilter) Method

Returns the textual representation of the specified filter.

Namespace : DevExpress.XtraGrid.Views.Base

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

public virtual string GetFilterDisplayText(
    ViewFilter filter
)

Public Overridable Function GetFilterDisplayText(
    filter As ViewFilter
) As String

Parameters

Name	Type	Description
filter	ViewFilter

A ViewFilter object representing the filter whose text representation needs to be obtained.

Returns

Type	Description
String

The textual representation of the specified filter.

Remarks

The GetFilterDisplayText method returns the textual representation of the specified filter based on the display values of cells and settings of columns and in-place editors. To get the textual representation of the filter which is currently applied to the View call the GetFilterDisplayText method with the ColumnView.ActiveFilter object as a parameter.

C#
VB.NET

csharp

string s = gridView1.GetFilterDisplayText(gridView1.ActiveFilter);

Dim s As String = gridView1.GetFilterDisplayText(gridView1.ActiveFilter)