TreeListOptionsFilter.FilterEditorAggregateEditing Property

Gets or sets whether users can create filters against properties of the List type.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.1.dll

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

Declaration

C#

[Browsable(false)]
[DefaultValue(FilterControlAllowAggregateEditing.No)]
[XtraSerializableProperty]
public virtual FilterControlAllowAggregateEditing FilterEditorAggregateEditing { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(FilterControlAllowAggregateEditing.No)>
<XtraSerializableProperty>
Public Overridable Property FilterEditorAggregateEditing As FilterControlAllowAggregateEditing

Property Value

Type	Default	Description
FilterControlAllowAggregateEditing	No	A FilterControlAllowAggregateEditing value that specifies whether users can create filters against properties of the List type.

Available values:

Name	Description
No	Doesn’t allow filters to be created against List properties and against their children.
Aggregate	Allows filters to be created against properties that are List objects.
AggregateWithCondition	Allows filters to be created against properties that are List objects, and against the List’s children.

Property Paths

You can access this nested property as listed below:

Object Type	Path to FilterEditorAggregateEditing
TreeList	.OptionsFilter .FilterEditorAggregateEditing

Remarks

The FilterEditorAggregateEditing property specifies whether users can create filters based on collection properties in the Filter Editor:

C#

using DevExpress.XtraEditors;
// ...
public Form1() {
    InitializeComponent();
    var r = new Random();

    var dataSource = Enumerable.Range(0, 5).Select(x => new DataNode {
        Id = x,
        Name = "MasterNode" + x,
        Nodes = Enumerable.Range(0, r.Next(5)).Select(y => new DataNode {
            Id = y,
            Name = "DetailNode" + y
        }).ToList(),
    }).ToList();

    treeList1.DataSource = dataSource;
    treeList1.ChildListFieldName = "Nodes";
    treeList1.OptionsFilter.FilterMode = DevExpress.XtraTreeList.FilterMode.EntireBranch;
    treeList1.OptionsFilter.FilterEditorAggregateEditing = FilterControlAllowAggregateEditing.Aggregate;
}
public class DataNode {
    public int Id { get; set; }
    public string Name { get; set; }
    public List<DataNode> Nodes { get; set; }
}

VB.NET

Imports DevExpress.XtraEditors
' ...
Public Sub New()
    InitializeComponent()
    Dim r = New Random()
    Dim dataSource = Enumerable.Range(0, 5).[Select](Function(x) New DataNode With {
        .Id = x,
        .Name = "MasterNode" & x,
        .Nodes = Enumerable.Range(0, r.[Next](5)).[Select](Function(y) New DataNode With {
            .Id = y,
            .Name = "DetailNode" & y
        }).ToList()
    }).ToList()

    treeList1.DataSource = dataSource
    treeList1.ChildListFieldName = "Nodes"
    treeList1.OptionsFilter.FilterMode = DevExpress.XtraTreeList.FilterMode.EntireBranch
    treeList1.OptionsFilter.FilterEditorAggregateEditing = FilterControlAllowAggregateEditing.Aggregate
End Sub

Public Class DataNode
    Public Property Id As Integer
    Public Property Name As String
    Public Property Nodes As List(Of DataNode)
End Class