WinColumnsListEditor.FilterColumnsMode Property

Specifies whether only properties represented by the List Editor’s columns, or all properties, including the properties of the reference properties, are available in the Filter Editor for creating a filter criteria.

Namespace: DevExpress.ExpressApp.Win.Editors

Assembly: DevExpress.ExpressApp.Win.v23.1.dll

NuGet Packages: DevExpress.ExpressApp.Win, DevExpress.ExpressApp.Win.Design

NuGet Package: DevExpress.ExpressApp.Win

Declaration

C#

[DefaultValue(FilterColumnsMode.AllProperties)]
public FilterColumnsMode FilterColumnsMode { get; set; }

VB.NET

<DefaultValue(FilterColumnsMode.AllProperties)>
Public Property FilterColumnsMode As FilterColumnsMode

Property Value

Type	Default	Description
DevExpress.ExpressApp.Win.Editors.FilterColumnsMode	AllProperties	A FilterColumnsMode enumeration value that determines the list of the properties that are available in the Filter Editor of the current Grid List Editor. By default, the FilterColumnsMode.AllProperties value is set.

Remarks

The following values are available:

• FilterColumnsMode.AllProperties - All properties, including properties of reference properties, are available.

  

• FilterColumnsMode.ColumnsOnly - Only the properties that are represented by columns in the current Grid List Editor are available.

  

To specify the required mode for a certain List View, use the following Controller

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Win.Editors;
// ...
public class CustomizeFilterColumnsModeController : ObjectViewController<ListView, DevExpress.Persistent.BaseImpl.Person> {
    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        WinColumnsListEditor listEditor = this.View.Editor as WinColumnsListEditor;
        if (listEditor != null) {
            listEditor.FilterColumnsMode = FilterColumnsMode.ColumnsOnly;
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Win.Editors
' ...
Public Class CustomizeFilterColumnsModeController
    Inherits ObjectViewController(Of ListView, DevExpress.Persistent.BaseImpl.Person)
    Protected Overrides Sub OnViewControlsCreated()
        MyBase.OnViewControlsCreated()
        Dim listEditor As WinColumnsListEditor = TryCast(Me.View.Editor, WinColumnsListEditor)
        If listEditor IsNot Nothing Then
            listEditor.FilterColumnsMode = FilterColumnsMode.ColumnsOnly
        End If
    End Sub
End Class

Note

When the Filter Editor dialog is invoked, the default StartsWith([CurrentColumn, ?]) criterion is created automatically (here, CurrentColumn is the column whose header was right-clicked to start the Filter Editor). However, if the current column displays a complex property (e.g., Employee.Department.Office) and the FilterColumnsMode value is AllProperties, the Filter Editor starts with an empty criterion. This is designed behavior. If you want to autocreate the default criterion for a complex column, change the FilterColumnsMode value to ColumnsOnly.