TreeListOptionsBehavior.EnableFiltering Property

Gets or sets whether nodes can be filtered.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

C#

[Browsable(false)]
public virtual bool EnableFiltering { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property EnableFiltering As Boolean

Property Value

Type	Description
Boolean	true, to allow nodes to be filtered; otherwise, false. The property’s default value is false in version 16.2 and older. The property’s default value is true in version 17.1 and newer. See Version Compatibility: Default Property Values to learn more.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to EnableFiltering
WinForms Controls	GanttControl	.OptionsBehavior.EnableFiltering
	ResourcesTree	.OptionsBehavior.EnableFiltering
	TreeList	.OptionsBehavior.EnableFiltering
Reporting	XRDesignFieldList	.OptionsBehavior.EnableFiltering
	XRDesignReportExplorer	.OptionsBehavior.EnableFiltering

Remarks

For versions 17.1 and newer, this property is considered obsolete and should not be used. Instead, use the TreeListOptionsCustomization.AllowFilter property to prevent end-users from filtering data (filtering in code still remains available).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EnableFiltering 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#

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

{
    get { return base.EnableFiltering; }
    set

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/CS/WindowsApplication3/FindPanel.cs#L62

BringToFront();
tree.OptionsBehavior.EnableFiltering = true;
tree.FilterNode += OnFilterNode;

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

treeList = treeListEditor.TreeList;
treeList.OptionsBehavior.EnableFiltering = true;
treeList.OptionsFilter.FilterMode = FilterMode.Extended;

VB.NET

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

Get
    Return MyBase.EnableFiltering
End Get

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/VB/WindowsApplication3/FindPanel.vb#L65

BringToFront()
tree.OptionsBehavior.EnableFiltering = True
AddHandler tree.FilterNode, AddressOf OnFilterNode

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

treeList = treeListEditor.TreeList
treeList.OptionsBehavior.EnableFiltering = True
treeList.OptionsFilter.FilterMode = FilterMode.Extended