Class TelerikTreeList<TItem>
The class for the Telerik TreeList component.
Inheritance
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll
Syntax
public class TelerikTreeList<TItem> : TableGridBase<TItem>, IDisposable, ITreeListDataStoreContainer<TItem>, IColumnContainer
Type Parameters
TItem
The type of the model to which the TreeList is bound. |
Properties
EditMode
Defines the EditMode of the TreeList. Supports "Inline", "Popup" and "Incell" editing.
Declaration
public TreeListEditMode EditMode { get; set; }
Property Value
TreeListEditMode
|
EnableLoaderContainer
Defines whether the loading container should be shown when there are long-running operations.
Declaration
public bool EnableLoaderContainer { get; set; }
Property Value
System.Boolean
|
FilterMode
Defines the Filter Mode of the Component.
Declaration
public TreeListFilterMode FilterMode { get; set; }
Property Value
TreeListFilterMode
|
HasChildrenField
Defines the HasChildren DataField of the DataSource.
Declaration
public string HasChildrenField { get; set; }
Property Value
System.String
|
IdField
Defines the Id DataField of the DataSource.
Declaration
public string IdField { get; set; }
Property Value
System.String
|
ItemsField
Defines the Items DataField of the DataSource that contains the child nodes.
Declaration
public string ItemsField { get; set; }
Property Value
System.String
|
OnCancel
Fires when the Cancel command is executed.
Declaration
public EventCallback<TreeListCommandEventArgs> OnCancel { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCommandEventArgs>
|
OnCollapse
Fires when a row is collapsed.
Declaration
public EventCallback<TreeListCollapseEventArgs> OnCollapse { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCollapseEventArgs>
|
OnCreate
Fires when the Create command is executed.
Declaration
public EventCallback<TreeListCommandEventArgs> OnCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCommandEventArgs>
|
OnDelete
Fires when the Delete command is executed.
Declaration
public EventCallback<TreeListCommandEventArgs> OnDelete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCommandEventArgs>
|
OnEdit
Fires when the Edit command is executed.
Declaration
public EventCallback<TreeListCommandEventArgs> OnEdit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCommandEventArgs>
|
OnExpand
Fires when a row is expanded.
Declaration
public EventCallback<TreeListExpandEventArgs> OnExpand { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListExpandEventArgs>
|
OnRowRender
Called each time a row is rendered. Use this to add custom classes to the row based on the data item.
Declaration
public Action<TreeListRowRenderEventArgs> OnRowRender { get; set; }
Property Value
System.Action<TreeListRowRenderEventArgs>
|
OnStateChanged
Fires on user interaction that causes changes in the TreeListState<TItem>.
Declaration
public EventCallback<TreeListStateEventArgs<TItem>> OnStateChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListStateEventArgs<TItem>>
|
OnStateInit
Invoked when the TreeList is initialized and state could be loaded. Useful when you'd like to persist changed on page reloads.
Declaration
public EventCallback<TreeListStateEventArgs<TItem>> OnStateInit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListStateEventArgs<TItem>>
|
OnUpdate
Fires when the Update command is executed.
Declaration
public EventCallback<TreeListCommandEventArgs> OnUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TreeListCommandEventArgs>
|
ParentIdField
Defines the ParentId DataField of the DataSource. Use this DataField when the component is bound to a flat data structure.
Declaration
public string ParentIdField { get; set; }
Property Value
System.String
|
SelectedItems
Defines the predefined collection of selected items.
Declaration
public IEnumerable<TItem> SelectedItems { get; set; }
Property Value
System.Collections.Generic.IEnumerable<TItem>
|
SelectedItemsChanged
Declaration
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TItem>>
|
SelectionMode
Defines the Selection Mode of the TreeList.
Declaration
public TreeListSelectionMode SelectionMode { get; set; }
Property Value
TreeListSelectionMode
|
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder
__builder
|
Dispose()
Declaration
public override void Dispose()
Overrides
GetState()
Gets the current state of the TreeList. Includes sorting, filtering, edit items, column state, etc.
Declaration
public TreeListState<TItem> GetState()
Returns
TreeListState<TItem>
Instance of a TreeListState<TItem> class that contains all data. |
OnAfterRenderAsync(Boolean)
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean
firstRender
|
Returns
System.Threading.Tasks.Task
|
Overrides
OnParametersSetAsync()
Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task
|
Overrides
SetState(TreeListState<TItem>)
Sets the state of the TreeList. Includes sorting, filtering, edit items, column state, etc.
Declaration
public Task SetState(TreeListState<TItem> state)
Parameters
TreeListState<TItem>
state
|
Returns
System.Threading.Tasks.Task
|