TreeListOptionsFilter.FilterMode Property

Gets or sets whether to show only the filtered nodes or also show their parent and child nodes. Additionally, you can enable the ExpandNodesOnFiltering property to automatically expand filtered nodes.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v21.2.dll

Declaration

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

Property Value

Type Default Description
FilterMode

Default

A FilterMode enumeration value that specifies how filtered nodes are shown.

Available values:

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.

TreeList_FilterMode_Standard

If a node fits the filter but any of its parents does not, the node is not displayed.

TreeList_FilterMode_Standard2

Matches

Shows only those nodes that match the filter.

TreeList_FilterMode_Smart

ParentBranch

Shows nodes that match the filter along with the nodes’ parents (even if they do not fit the filter).

TreeList_FilterMode_Extended

EntireBranch

Shows nodes that match the filter along with the nodes’ parents and children (even if they do not fit the filter).

image

Standard

The same as the ‘ParentsMatch’ option.

Smart

The same as the ‘Matches’ option.

Extended

The same as the ‘ParentBranch’ option.

Property Paths

You can access this nested property as listed below:

Object Type Path to FilterMode
GanttControl
.OptionsFilter.FilterMode
ResourcesTree
.OptionsFilter.FilterMode
TreeList
.OptionsFilter.FilterMode

Remarks

This property specifies whether to show only the filtered nodes or also show the parent and child nodes. You can also hide nodes that have parent nodes that do not match the filter criteria. See FilterMode for more information.

Note

Use the following properties to allow users to filter nodes:

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

See Also