FilterMode Enum

Enumerates modes that specify whether to show only the filtered nodes or also show their parent and child nodes.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.1.dll

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

Declaration

C#

public enum FilterMode

VB.NET

Public Enum FilterMode

Members

Name	Description
Default	Equivalent to ‘ParentBranch’ mode for the TreeList control. Equivalent to ‘Matches’ mode for the TreeListLookUpEdit control.
ParentsMatch	Shows nodes if they and all their parents match the filter. If a node fits the filter but any of its parents does not, the node is not displayed.
Matches	Shows only those nodes that match the filter. If a node is collapsed, its children are hidden even if they match the current filter. Enable the TreeListOptionsFilter.ExpandNodesOnFiltering option to automatically expand collapsed nodes before filtration.
ParentBranch	Shows nodes that match the filter along with the nodes’ parents (even if they do not fit the filter).
EntireBranch	Shows nodes that match the filter along with the nodes’ parents and children (even if they do not fit the filter).
Standard	The same as the ‘ParentsMatch’ option.
Smart	The same as the ‘Matches’ option.
Extended	The same as the ‘ParentBranch’ option.

Related API Members

The following properties accept/return FilterMode values:

• TreeListOptionsFilter.FilterMode

Remarks

This type is used to specify the TreeList.OptionsFilter.FilterMode property.

Note

Use the following properties to allow users to filter nodes:

• for version 17.1, use the TreeList.OptionsCustomization.AllowFilter property
• for older versions, use the TreeList.OptionsBehavior.EnableFiltering property

For more information, see Version Compatibility: Default Property Values.