TreeViewControl.FilteringMode Property

Gets or sets how the TreeViewControl filters its nodes. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v25.1.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public TreeListFilteringMode FilteringMode { get; set; }

VB.NET

Public Property FilteringMode As TreeListFilteringMode

Property Value

Type	Default	Description
TreeListFilteringMode	Nodes	A TreeListFilteringMode enumeration value that specifies how the TreeViewControl filters its nodes.

Available values:

Name	Description
Nodes	(Default) The TreeListView displays only nodes that meet the filter criteria. A node at the hierarchy’s highest level that meets the filter criteria becomes the root node. The node’s nearest child that meets the filter criteria changes the hierarchy level to the next level down from the root.
ParentBranch	The TreeListView displays a node that meets the filter criteria and all its parent nodes, even if they do not meet the filter criteria.
EntireBranch	The TreeListView displays a node that meets the filter criteria and all its parent and child nodes, even if they do not meet the filter criteria.
Recursive	The TreeListView displays a node that meets the filter criteria only if its parent nodes also meet the filter criteria.

Remarks

Nodes Mode (Default)

The TreeViewControl displays only nodes that meet the filter criteria. A node at the hierarchy’s highest level that meets the filter criteria becomes the root node. The node’s closest child that meets this criteria changes the hierarchy level to the next level down from the root.

ParentBranch Mode

The TreeViewControl displays a node that meets the filter criteria and all its parent nodes, even if they do not meet the filter criteria.

EntireBranch Mode

The TreeViewControl displays a node that meets the filter criteria and all its parent and child nodes, even if they do not meet the filter criteria.

Recursive Mode

The TreeViewControl displays a node that meets the filter criteria only if its parent nodes also meet the filter criteria.

For more information, refer to the following help topic: Search and Filter Nodes.