Table of Contents

Class RadzenTree

Namespace
Radzen.Blazor
Assembly
Radzen.Blazor.dll

A component which displays a hierarchy of items. Supports inline definition and data-binding.

public class RadzenTree : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance
RadzenTree
Implements
Inherited Members

Examples

<RadzenTree>
    <RadzenTreeItem Text="BMW">
        <RadzenTreeItem Text="M3" />
        <RadzenTreeItem Text="M5" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Audi">
        <RadzenTreeItem Text="RS4" />
        <RadzenTreeItem Text="RS6" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Mercedes">
        <RadzenTreeItem Text="C63 AMG" />
        <RadzenTreeItem Text="S63 AMG" />
    </RadzenTreeItem>
</RadzenTree>

Constructors

RadzenTree() 

public RadzenTree()

Properties

AllowCheckBoxes

Specifies whether RadzenTree displays check boxes. Set to false by default.

[Parameter]
public bool AllowCheckBoxes { get; set; }

Property Value

bool

true if check boxes are displayed; otherwise, false.

AllowCheckChildren

Specifies what happens when a parent item is checked. If set to true checking parent items also checks all of its children.

[Parameter]
public bool AllowCheckChildren { get; set; }

Property Value

bool

AllowCheckParents

Specifies what happens with a parent item when one of its children is checked. If set to true checking a child item will affect the checked state of its parents.

[Parameter]
public bool AllowCheckParents { get; set; }

Property Value

bool

Change

A callback that will be invoked when the user selects an item.

[Parameter]
public EventCallback<TreeEventArgs> Change { get; set; }

Property Value

EventCallback<TreeEventArgs>

Examples

<RadzenTree Change=@OnChange>
    <RadzenTreeItem Text="BMW">
        <RadzenTreeItem Text="M3" />
        <RadzenTreeItem Text="M5" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Audi">
        <RadzenTreeItem Text="RS4" />
        <RadzenTreeItem Text="RS6" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Mercedes">
        <RadzenTreeItem Text="C63 AMG" />
        <RadzenTreeItem Text="S63 AMG" />
    </RadzenTreeItem>
</RadzenTree>
@code {
  void OnChange(TreeEventArgs args) 
  {

  }
}

CheckedValues

Gets or sets the checked values. Use with @bind-CheckedValues to sync it with a property.

[Parameter]
public IEnumerable<object> CheckedValues { get; set; }

Property Value

IEnumerable<object>

CheckedValuesChanged

A callback which will be invoked when CheckedValues changes.

[Parameter]
public EventCallback<IEnumerable<object>> CheckedValuesChanged { get; set; }

Property Value

EventCallback<IEnumerable<object>>

ChildContent

Gets or sets the child content.

[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

RenderFragment

The child content.

Collapse

A callback that will be invoked when the user collapse an item.

[Parameter]
public EventCallback<TreeEventArgs> Collapse { get; set; }

Property Value

EventCallback<TreeEventArgs>

Data

Specifies the collection of data items which RadzenTree will create its items from.

[Parameter]
public IEnumerable Data { get; set; }

Property Value

IEnumerable

Expand

A callback that will be invoked when the user expands an item.

[Parameter]
public EventCallback<TreeExpandEventArgs> Expand { get; set; }

Property Value

EventCallback<TreeExpandEventArgs>

Examples

<RadzenTree Expand=@OnExpand>
    <RadzenTreeItem Text="BMW">
        <RadzenTreeItem Text="M3" />
        <RadzenTreeItem Text="M5" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Audi">
        <RadzenTreeItem Text="RS4" />
        <RadzenTreeItem Text="RS6" />
    </RadzenTreeItem>
    <RadzenTreeItem Text="Mercedes">
        <RadzenTreeItem Text="C63 AMG" />
        <RadzenTreeItem Text="S63 AMG" />
    </RadzenTreeItem>
</RadzenTree>
@code {
  void OnExpand(TreeExpandEventArgs args) 
  {

  }
}

ItemContextMenu

Gets or sets the context menu callback.

[Parameter]
public EventCallback<TreeItemContextMenuEventArgs> ItemContextMenu { get; set; }

Property Value

EventCallback<TreeItemContextMenuEventArgs>

The context menu callback.

ItemRender

A callback that will be invoked when item is rendered.

[Parameter]
public Action<TreeItemRenderEventArgs> ItemRender { get; set; }

Property Value

Action<TreeItemRenderEventArgs>

SelectItemAriaLabel

Gets or sets the open button aria-label attribute.

[Parameter]
public string SelectItemAriaLabel { get; set; }

Property Value

string

SingleExpand

Specifies whether siblings items are collapsed. Set to false by default.

[Parameter]
public bool SingleExpand { get; set; }

Property Value

bool

Value

Specifies the selected value. Use with @bind-Value to sync it with a property.

[Parameter]
public object Value { get; set; }

Property Value

object

ValueChanged

A callback which will be invoked when Value changes.

[Parameter]
public EventCallback<object> ValueChanged { get; set; }

Property Value

EventCallback<object>

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearSelection()

Clear the current selection to allow re-selection by mouse click

public void ClearSelection()

GetComponentCssClass() 

protected override string GetComponentCssClass()

Returns

string

SetParametersAsync(ParameterView) 

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters ParameterView

Returns

Task