Class TelerikTreeView

The class for the Telerik TreeView component.

Inheritance

System.Object

BaseComponent

DataBoundComponent<System.Object>

TelerikTreeView

Inherited Members

DataBoundComponent<Object>.Dispose()

DataBoundComponent<Object>.Rebind()

DataBoundComponent<Object>.Data

BaseComponent.ShouldRender()

BaseComponent.OnInitializedAsync()

BaseComponent.InitLocalizer()

BaseComponent.ThrowIfParameterIsNull(Object, String)

BaseComponent.HaveOptionsChanged(IDictionary<String, Object>, IDictionary<String, Object>)

BaseComponent.GetClassString(String[])

BaseComponent.InvokeAsync<T>(String, Object[])

BaseComponent.InvokeAsync<T>(String, CancellationToken, Object[])

BaseComponent.InvokeVoidAsync(String, Object[])

BaseComponent.InvokeComponentMethodAsync<T>(String, Object[])

BaseComponent.InvokeComponentMethodAsync<T>(String, CancellationToken, Object[])

BaseComponent.InvokeVoidComponentMethodAsync(String, Object[])

BaseComponent.InvokeDisposeAsync()

BaseComponent.StateHasChanged()

BaseComponent.RootComponent

BaseComponent.Class

Namespace: Telerik.Blazor.Components

Assembly: Telerik.Blazor.dll

Syntax

public class TelerikTreeView : DataBoundComponent<object>, IDisposable, ITreeBindingContainer

Properties

CheckBoxMode

Defines if users can check one or multiple TreeView item checkboxes. Supports Multiple, Single and None checkbox selection modes.

Declaration

public TreeViewCheckBoxMode CheckBoxMode { get; set; }

Property Value

TreeViewCheckBoxMode

CheckChildren

Defines if child items' checkboxes will get checked when the user selects the parent checkbox. Applicable for Multiple TreeViewCheckMode.

Declaration

public bool CheckChildren { get; set; }

Property Value

System.Boolean

CheckedItems

Defines collection of Checked Items in the TreeView.

Declaration

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

Property Value

System.Collections.Generic.IEnumerable<System.Object>

CheckedItemsChanged

Fires when CheckedItems collection has changed.

Declaration

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

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<System.Object>>

CheckOnClick

Defines if the click on the TreeView item should trigger checkbox selection.

Declaration

public bool CheckOnClick { get; set; }

Property Value

System.Boolean

CheckParents

Defines if the parent checkbox state will change when the user toggles child checkboxes. Applicable for Multiple TreeViewCheckMode.

Declaration

public bool CheckParents { get; set; }

Property Value

System.Boolean

Draggable

Defines if users can drag TreeView items.

Declaration

public bool Draggable { get; set; }

Property Value

System.Boolean

ExpandedItems

Defines collection of Expanded Items in the TreeView.

Declaration

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

Property Value

System.Collections.Generic.IEnumerable<System.Object>

ExpandedItemsChanged

Triggers when ExpandedItems has changed.

Declaration

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

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<System.Object>>

Id

Defines the id HTML attribute of the Component.

Declaration

public string Id { get; set; }

Property Value

System.String

OnDrop

Fired when a tree item is dropped. All data manipulations should be made here.

Declaration

public EventCallback<TreeViewDropEventArgs> OnDrop { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TreeViewDropEventArgs>

OnExpand

Fires when the user expands or collapses a node.

Declaration

public EventCallback<TreeViewExpandEventArgs> OnExpand { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TreeViewExpandEventArgs>

OnItemClick

Fires when the user clicks, taps or presses Enter on a TreeView node (item).

Declaration

public EventCallback<TreeViewItemClickEventArgs> OnItemClick { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TreeViewItemClickEventArgs>

OnItemContextMenu

Fires when the user right-clicks on a TreeView node or taps-and-holds on a touch device.

Declaration

public EventCallback<TreeViewItemContextMenuEventArgs> OnItemContextMenu { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TreeViewItemContextMenuEventArgs>

OnItemDoubleClick

Fires when the user double-clicks or double-taps a TreeView node.

Declaration

public EventCallback<TreeViewItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TreeViewItemDoubleClickEventArgs>

OnItemRender

Fired when a tree item is being rendered.

Declaration

public Action<TreeViewItemRenderEventArgs> OnItemRender { get; set; }

Property Value

System.Action<TreeViewItemRenderEventArgs>

SelectedItems

Defines collection of Selected Items in the TreeView.

Declaration

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

Property Value

System.Collections.Generic.IEnumerable<System.Object>

SelectedItemsChanged

Fires when SelectedItems collection has changed.

Declaration

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

Property Value

Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<System.Object>>

SelectionMode

Defines if users can select one or multiple items. Supports Multiple, Single and None selection modes.

Declaration

public TreeViewSelectionMode SelectionMode { get; set; }

Property Value

TreeViewSelectionMode

Size

Specifies the Size of the text TextBox. Default value is Medium.

Declaration

public string Size { get; set; }

Property Value

System.String

TreeViewBindings

The TreeView items have features that map to properties in the model. The container enables you to create TreeViewBinding tags and configure the mappings between the features of the TreeView and the properties in the model. See TreeView Bingings.

Declaration

public RenderFragment TreeViewBindings { get; set; }

Property Value

Microsoft.AspNetCore.Components.RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

GetItemFromDropIndex(String)

Declaration

public object GetItemFromDropIndex(string index)

Parameters

System.String index

Returns

System.Object

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

System.Boolean firstRender

Returns

System.Threading.Tasks.Task

Overrides

BaseComponent.OnAfterRenderAsync(Boolean)

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

System.Threading.Tasks.Task

Overrides

Telerik.Blazor.Components.Common.DataBoundComponent<System.Object>.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Microsoft.AspNetCore.Components.ParameterView parameters

Returns

System.Threading.Tasks.Task

Overrides

Telerik.Blazor.Components.Common.DataBoundComponent<System.Object>.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView)