skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI UI for Xamarin

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic FiddlerCap FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
  • Blazor Hybrid
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • Blazor Tutorials and Learning
    • First Stepswith Blazor Web Assembly
    • First Steps with Blazor Server
    • First Steps with Blazor Hybrid
    • Accessibility and Security
    • Submit a Ticket
    • FAQs

    Docs & Resources

    • Docs
    • Demos
    • Modernization and Migration
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs

    Productivity and Design Tools

    • REPL for Blazor
    • ThemeBuilder
    • Design System Documentation
    • Figma Kits
    • Visual Studio Extensions
    • Visual Studio Code Extensions
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

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.InvokeComponentVoidMethodAsync(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

AriaLabel

Describe the aria-label attribute for the component.

Declaration
public string AriaLabel { get; set; }
Property Value
System.String

AriaLabelledBy

Describe the aria-labelledby attribute for the component.

Declaration
public string AriaLabelledBy { get; set; }
Property Value
System.String

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

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
public int DragThrottleInterval { get; set; }
Property Value
System.Int32

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

OnDrag

Fired when a tree item is being dragged.

Declaration
public EventCallback<TreeViewDragEventArgs> OnDrag { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeViewDragEventArgs>

OnDragEnd

Fired when a drag operation is being ended.

Declaration
public EventCallback<TreeViewDragEndEventArgs> OnDragEnd { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeViewDragEndEventArgs>

OnDragStart

Fired when a tree item is being dragged.

Declaration
public EventCallback<TreeViewDragStartEventArgs> OnDragStart { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeViewDragStartEventArgs>

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)
Getting Started
  • Client-side Blazor
  • Server-side Blazor
  • Demos
Community
  • Forums
  • Blogs
  • Feedback Portal
Support Resources
  • Demos
  • Knowledge Base
  • Samples Repo
  • Localizations Repo
Sample Applications
  • Dashboard
  • PWA - Stocks
  • PWA - Blazing Coffee Roasters

Copyright © 2019 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.