FilterMode Enum

Provides members that specify the TreeList filtering mode.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v18.1.dll

Declaration

C#

public enum FilterMode

VB.NET

Public Enum FilterMode

Members

Name	Description
Default	The same as: Smart - if the TreeList control is contained in a TreeListLookUpEdit; Extended - otherwise. See also: Version Compatibility: Default Property Values.
Standard	Nodes that match the applied filter are only displayed if their parent nodes also fit the filter. If a node fits the filter but any of its parent nodes does not, the node is not displayed.
Smart	Nodes that match the applied filter are displayed regardless of whether their parent nodes fit the filter. Unlike the Extended mode, parent nodes that do not match the filer are not displayed.
Extended	Nodes that match the applied filter are displayed regardless of whether their parent nodes fit the filter. Unlike the Smart mode, if a node matches the applied filter, all its parent nodes are also displayed even if they do not fit the filter.

Related API Members

The following properties accept/return FilterMode values:

• ResourcesTreeOptionsFilter.FilterMode
• TreeListOptionsFilter.FilterMode

Remarks

Using the TreeListOptionsFilter.FilterMode property that uses the FilterMode enumerator values as parameters, you can set three options for filtering nodes. The Standard mode displays child nodes that match a specific criterion only when all the node’s parents match this criterion as well. If this behavior limits your tasks, use the Smart or Extended mode instead.

For DevExpess installation of versions 17.1 and newer, Tree List filtering is already enabled and managed by the TreeListOptionsCustomization.AllowFilter property. For older versions, enable the TreeListOptionsBehavior.EnableFiltering property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterMode enum.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/CS/E520.Module.Win/Controllers/WinFilterTreeListViewController.cs#L28

    treeList.OptionsBehavior.EnableFiltering = true;
    treeList.OptionsFilter.FilterMode = FilterMode.Extended;
}

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/CS/RepositoryItemTreeListLookUpEdit.cs#L273

TreeList.OptionsBehavior.ExpandNodesOnIncrementalSearch = true;
TreeList.OptionsFilter.FilterMode = FilterMode.Smart;
ImmediatePopup = true;

VB.NET

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/VB/E520.Module.Win/Controllers/WinFilterTreeListViewController.vb#L30

    treeList.OptionsBehavior.EnableFiltering = True
    treeList.OptionsFilter.FilterMode = FilterMode.Extended
End If

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/VB/RepositoryItemTreeListLookUpEdit.vb#L286

TreeList.OptionsBehavior.ExpandNodesOnIncrementalSearch = True
TreeList.OptionsFilter.FilterMode = FilterMode.Smart
ImmediatePopup = True