Class RadzenTree

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

Inheritance

System.Object

RadzenComponent

RadzenTree

Implements

IDisposable

Inherited Members

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.OnAfterRenderAsync(Boolean)

RadzenComponent.RaiseContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.CurrentStyle

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenTree : RadzenComponent, IDisposable

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>

Properties

AllowCheckBoxes

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

Declaration

public bool AllowCheckBoxes { get; set; }

Property Value

Type	Description
System.Boolean	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.

Declaration

public bool AllowCheckChildren { get; set; }

Property Value

Type	Description
System.Boolean

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.

Declaration

public bool AllowCheckParents { get; set; }

Property Value

Type	Description
System.Boolean

Change

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

Declaration

public EventCallback<TreeEventArgs> Change { get; set; }

Property Value

Type	Description
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.

Declaration

public IEnumerable<object> CheckedValues { get; set; }

Property Value

Type	Description
IEnumerable<System.Object>

CheckedValuesChanged

A callback which will be invoked when CheckedValues changes.

Declaration

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

Property Value

Type	Description
EventCallback<IEnumerable<System.Object>>

ChildContent

Gets or sets the child content.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
RenderFragment	The child content.

Collapse

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

Declaration

public EventCallback<TreeEventArgs> Collapse { get; set; }

Property Value

Type	Description
EventCallback<TreeEventArgs>

Data

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

Declaration

public IEnumerable Data { get; set; }

Property Value

Type	Description
IEnumerable

Expand

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

Declaration

public EventCallback<TreeExpandEventArgs> Expand { get; set; }

Property Value

Type	Description
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) 
  {

  }
}

ItemContentCssClass

Gets or sets the CSS classes added to the item content.

Declaration

public string ItemContentCssClass { get; set; }

Property Value

Type	Description
System.String

ItemContextMenu

Gets or sets the context menu callback.

Declaration

public EventCallback<TreeItemContextMenuEventArgs> ItemContextMenu { get; set; }

Property Value

Type	Description
EventCallback<TreeItemContextMenuEventArgs>	The context menu callback.

ItemIconCssClass

Gets or sets the CSS classes added to the item icon.

Declaration

public string ItemIconCssClass { get; set; }

Property Value

Type	Description
System.String

ItemLabelCssClass

Gets or sets the CSS classes added to the item label.

Declaration

public string ItemLabelCssClass { get; set; }

Property Value

Type	Description
System.String

ItemRender

A callback that will be invoked when item is rendered.

Declaration

public Action<TreeItemRenderEventArgs> ItemRender { get; set; }

Property Value

Type	Description
Action<TreeItemRenderEventArgs>

SelectItemAriaLabel

Gets or sets the open button aria-label attribute.

Declaration

public string SelectItemAriaLabel { get; set; }

Property Value

Type	Description
System.String

SingleExpand

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

Declaration

public bool SingleExpand { get; set; }

Property Value

Type	Description
System.Boolean

Value

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

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object

ValueChanged

A callback which will be invoked when Value changes.

Declaration

public EventCallback<object> ValueChanged { get; set; }

Property Value

Type	Description
EventCallback<System.Object>

Methods

ClearSelection()

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

Declaration

public void ClearSelection()

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
System.String

Overrides

RadzenComponent.GetComponentCssClass()

OnInitialized()

Called by the Blazor runtime.

Declaration

protected override void OnInitialized()

Overrides

RadzenComponent.OnInitialized()

Reload(RadzenTreeItem)

Forces the specified item or, if item is null, all items in the tree to be re-evaluated such that items lazily created via Expand are realised if the underlying data model has been changed from somewhere else.

Declaration

public async Task Reload(RadzenTreeItem item = null)

Parameters

Type	Name	Description
RadzenTreeItem	item	The item to be reloaded or null to refresh the root nodes of the tree.

Returns

Type	Description
Task	A task to wait for the operation to complete.

SetParametersAsync(ParameterView)

Called by the Blazor runtime when parameters are set.

Declaration

public override async Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task

Overrides

RadzenComponent.SetParametersAsync(ParameterView)

Implements

IDisposable