TreeListOptionsFilter.FilterMode Property

Gets or sets whether to show a node that matches the current filter regardless of whether its parent nodes also match the filter, and if so, whether to show the parent nodes.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

[DefaultValue(FilterMode.Default)]
[XtraSerializableProperty]
public virtual FilterMode FilterMode { get; set; }

VB.NET

<DefaultValue(FilterMode.Default)>
<XtraSerializableProperty>
Public Overridable Property FilterMode As FilterMode

Property Value

Type	Default	Description
FilterMode	**Default**	A FilterMode enumeration value that specifies whether to show nodes that match the current filter depending on their parent nodes.

Available values:

Name	Description
Default	The same as: Smart - if the TreeList control is contained in a TreeListLookUpEdit; Extended - otherwise. For version 16.1 and older, the default is Standard. See Version Compatibility: Default Property Values for details.
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.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to FilterMode
WinForms Controls	ResourcesTree	.OptionsFilter.FilterMode
	TreeList	.OptionsFilter.FilterMode
Reporting	XRDesignFieldList	.OptionsFilter.FilterMode
	XRDesignReportExplorer	.OptionsFilter.FilterMode

Remarks

The TreeList.OptionsFilter property provides access to options specify to the filtering functionality. The TreeList.OptionsFilter.FilterMode property specifies whether to show nodes that match the current filter depending on their parent nodes. See the FilterMode enumeration for the provided modes.

Note

Version Compatibility To enable filtering:

• for the 17.1 version, use the TreeListOptionsCustomization.AllowFilter property (enabled by default);
• for older versions, use the TreeListOptionsBehavior.EnableFiltering property.

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

Related GitHub Examples

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

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