Class
TelerikTreeView

The class for the Telerik TreeView component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikTreeView : DataBoundComponent<object>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<object>TelerikTreeView

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataBoundComponent<object>.Dispose()DataBoundComponent<object>.Rebind()DataBoundComponent<object>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Properties

AriaLabel

Describe the aria-label attribute for the component.

Declaration

cs-api-definition
[Parameter]
public string AriaLabel { get; set; }

Property Value

string

AriaLabelledBy

Describe the aria-labelledby attribute for the component.

Declaration

cs-api-definition
[Parameter]
public string AriaLabelledBy { get; set; }

Property Value

string

CheckBoxMode

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

Declaration

cs-api-definition
[Parameter]
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

cs-api-definition
[Parameter]
public bool CheckChildren { get; set; }

Property Value

bool

CheckOnClick

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

Declaration

cs-api-definition
[Parameter]
public bool CheckOnClick { get; set; }

Property Value

bool

CheckParents

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

Declaration

cs-api-definition
[Parameter]
public bool CheckParents { get; set; }

Property Value

bool

CheckedItems

Defines collection of Checked Items in the TreeView.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<object> CheckedItems { get; set; }

Property Value

IEnumerable<object>

CheckedItemsChanged

Fires when CheckedItems collection has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<IEnumerable<object>> CheckedItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<object>>

DragThrottleInterval

Specifies the time interval (in milliseconds) between the firings of the OnDrag event handler during the dragging operation. The default interval is 0ms.

Declaration

cs-api-definition
[Parameter]
public int DragThrottleInterval { get; set; }

Property Value

int

Draggable

Defines if users can drag TreeView items.

Declaration

cs-api-definition
[Parameter]
public bool Draggable { get; set; }

Property Value

bool

ExpandedItems

Defines collection of Expanded Items in the TreeView.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<object> ExpandedItems { get; set; }

Property Value

IEnumerable<object>

ExpandedItemsChanged

Triggers when ExpandedItems has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<IEnumerable<object>> ExpandedItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<object>>

Id

Defines the id HTML attribute of the Component.

Declaration

cs-api-definition
[Parameter]
public string Id { get; set; }

Property Value

string

OnDrag

Fired when a tree item is being dragged.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewDragEventArgs> OnDrag { get; set; }

Property Value

EventCallback<TreeViewDragEventArgs>

OnDragEnd

Fired when a drag operation is being ended.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewDragEndEventArgs> OnDragEnd { get; set; }

Property Value

EventCallback<TreeViewDragEndEventArgs>

OnDragStart

Fired when a tree item is being dragged.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewDragStartEventArgs> OnDragStart { get; set; }

Property Value

EventCallback<TreeViewDragStartEventArgs>

OnDrop

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewDropEventArgs> OnDrop { get; set; }

Property Value

EventCallback<TreeViewDropEventArgs>

OnExpand

Fires when the user expands or collapses a node.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewExpandEventArgs> OnExpand { get; set; }

Property Value

EventCallback<TreeViewExpandEventArgs>

OnItemClick

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewItemClickEventArgs> OnItemClick { get; set; }

Property Value

EventCallback<TreeViewItemClickEventArgs>

OnItemContextMenu

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewItemContextMenuEventArgs> OnItemContextMenu { get; set; }

Property Value

EventCallback<TreeViewItemContextMenuEventArgs>

OnItemDoubleClick

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TreeViewItemDoubleClickEventArgs> OnItemDoubleClick { get; set; }

Property Value

EventCallback<TreeViewItemDoubleClickEventArgs>

OnItemRender

Fired when a tree item is being rendered.

Declaration

cs-api-definition
[Parameter]
public Action<TreeViewItemRenderEventArgs> OnItemRender { get; set; }

Property Value

Action<TreeViewItemRenderEventArgs>

SelectedItems

Defines collection of Selected Items in the TreeView.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<object> SelectedItems { get; set; }

Property Value

IEnumerable<object>

SelectedItemsChanged

Fires when SelectedItems collection has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<IEnumerable<object>> SelectedItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<object>>

SelectionMode

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

Declaration

cs-api-definition
[Parameter]
public TreeViewSelectionMode SelectionMode { get; set; }

Property Value

TreeViewSelectionMode

Size

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

Declaration

cs-api-definition
[Parameter]
public string Size { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public RenderFragment TreeViewBindings { get; set; }

Property Value

RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetItemFromDropIndex(string)

Declaration

cs-api-definition
public object GetItemFromDropIndex(string index)

Parameters

index

string

Returns

object

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides DataBoundComponent<object>.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides DataBoundComponent<object>.SetParametersAsync(ParameterView)