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, TreeListCommandEventArgs>, IDisposable, IPagerContainer, IRowDraggableContainer, IValidationContainer, IPopupEditSettingsContainer, ITreeListDataStoreContainer<TItem>, IColumnContainerType Parameters
|
TItem
The type of the model to which the TreeList is bound. |
Properties
EditMode
Defines the EditMode of the TreeList. Supports None, Inline, Popup and Incell editing. The Default Option is None.
Declaration
public TreeListEditMode EditMode { get; set; }Property Value
|
TreeListEditMode
|
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
|
OnCollapse
Fires when a row is collapsed.
Declaration
public EventCallback<TreeListCollapseEventArgs> OnCollapse { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListCollapseEventArgs>
|
OnExpand
Fires when a row is expanded.
Declaration
public EventCallback<TreeListExpandEventArgs> OnExpand { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListExpandEventArgs>
|
OnRowClick
Fires when the user clicks on a row, or presses enter.
Declaration
public EventCallback<TreeListRowClickEventArgs> OnRowClick { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListRowClickEventArgs>
|
OnRowContextMenu
Fires when the user triggers contextmenu event with click or context menu button.
Declaration
public EventCallback<TreeListRowClickEventArgs> OnRowContextMenu { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListRowClickEventArgs>
|
OnRowDoubleClick
Fires when the user double-clicks on a row.
Declaration
public EventCallback<TreeListRowClickEventArgs> OnRowDoubleClick { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListRowClickEventArgs>
|
OnRowDrop
Fired when a row is dropped.
Declaration
public EventCallback<TreeListRowDropEventArgs<TItem>> OnRowDrop { get; set; }Property Value
|
Microsoft.AspNetCore.Components.EventCallback<TreeListRowDropEventArgs<TItem>>
|
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>>
|
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
|
SelectionMode
Defines the Selection Mode of the TreeList.
Declaration
public TreeListSelectionMode SelectionMode { get; set; }Property Value
|
TreeListSelectionMode
|
TreeListSettings
Declaration
public RenderFragment TreeListSettings { get; set; }Property Value
|
Microsoft.AspNetCore.Components.RenderFragment
|
Methods
AutoFitAllColumns()
Declaration
public void AutoFitAllColumns()AutoFitAllColumnsAsync()
Declaration
public Task AutoFitAllColumnsAsync()Returns
|
System.Threading.Tasks.Task
|
AutoFitColumn(String)
Declaration
public void AutoFitColumn(string id)Parameters
|
System.String
id
|
AutoFitColumnAsync(String)
Declaration
public Task AutoFitColumnAsync(string id)Parameters
|
System.String
id
|
Returns
|
System.Threading.Tasks.Task
|
AutoFitColumns(IEnumerable<String>)
Declaration
public void AutoFitColumns(IEnumerable<string> ids)Parameters
|
System.Collections.Generic.IEnumerable<System.String>
ids
|
AutoFitColumnsAsync(IEnumerable<String>)
Declaration
public Task AutoFitColumnsAsync(IEnumerable<string> ids)Parameters
|
System.Collections.Generic.IEnumerable<System.String>
ids
|
Returns
|
System.Threading.Tasks.Task
|
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
SetParametersAsync(ParameterView)
Declaration
public override Task SetParametersAsync(ParameterView parameters)Parameters
|
Microsoft.AspNetCore.Components.ParameterView
parameters
|
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
|