DxTreeView.ShowFilterPanel Property

Specifies whether the TreeView displays the filter panel.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(false)]
[Parameter]
public bool ShowFilterPanel { get; set; }

Property Value

Type	Default	Description
Boolean	false	true to display the filter panel; otherwise, false.

Remarks

Enable the ShowFilterPanel option to activate the filter panel. If a user types in a search string, the component displays matching nodes, and optionally, their parent/child nodes. Note that if you activate the filter option with the enabled LoadChildNodesOnDemand option, the component loads all its nodes into memory.

<DxTreeView ShowFilterPanel="true">
    @* ... *@
</DxTreeView>

You can also use the FilterString property to specify the filter criteria from code.

Note

The following actions change the check state of all nodes, even those that do not meet the applied filter criteria:

• CheckAll() method call
• ClearCheck() method call
• Recursive check mode update

Filter Panel Settings

Use the FilterMode property to specify how the component displays the filter operation results. The following options are available:

EntireBranch

The component displays a node that meets the filter criteria and all its parent and child nodes, even if they do not meet the criteria.

ParentBranch

The component displays a node that meets the filter criteria and all its parent nodes, even if they do not meet the criteria.

Nodes

The component displays only nodes that meet the filter criteria. A node at the hierarchy’s highest level that meets the filter criteria becomes the root node. The node’s child nodes that meet the filter criteria move to the upper hierarchy levels.

In addition to these options, you can specify the CustomFilter property to add heuristics to default filter behavior.