Back to Devexpress

ColumnView.GetFilterDisplayText(ViewFilter) Method

windowsforms-devexpress-dot-xtragrid-dot-views-dot-base-dot-columnview-dot-getfilterdisplaytext-x28-devexpress-dot-xtragrid-dot-views-dot-base-dot-viewfilter-x29.md

latest2.5 KB
Original Source

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

csharp
public virtual string GetFilterDisplayText(
    ViewFilter filter
)
vb
Public Overridable Function GetFilterDisplayText(
    filter As ViewFilter
) As String

Parameters

NameTypeDescription
filterViewFilter

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

|

Returns

TypeDescription
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.

csharp
string s = gridView1.GetFilterDisplayText(gridView1.ActiveFilter);
vb
Dim s As String = gridView1.GetFilterDisplayText(gridView1.ActiveFilter)

See Also

ActiveFilter

RowFilter

ColumnView Class

ColumnView Members

DevExpress.XtraGrid.Views.Base Namespace