ClassTelerikTreeList<TItem>
The class for the Telerik TreeList component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
The type of the model to which the TreeList is bound.
Syntax:
public class TelerikTreeList<TItem> : TableGridBase<TItem, TreeListCommandEventArgs>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>GridBase<TItem>TableGridBase<TItem, TreeListCommandEventArgs>TelerikTreeList<TItem>
Implements:
Inherited Members
Properties
EditFieldOnStateInit
Declaration
protected string EditFieldOnStateInit { get; set; }
Property Value
EditMode
Defines the EditMode of the TreeList. Supports None, Inline, Popup and Incell editing. The Default Option is None.
Declaration
[Parameter]
public TreeListEditMode EditMode { get; set; }
Property Value
FilterMode
Defines the Filter Mode of the Component.
Declaration
[Parameter]
public TreeListFilterMode FilterMode { get; set; }
Property Value
HasChildrenField
Defines the HasChildren DataField of the DataSource.
Declaration
[Parameter]
public string HasChildrenField { get; set; }
Property Value
IdField
Defines the Id DataField of the DataSource.
ItemsField
Defines the Items DataField of the DataSource that contains the child nodes.
Declaration
[Parameter]
public string ItemsField { get; set; }
Property Value
OnCollapse
Fires when a row is collapsed.
Declaration
[Parameter]
public EventCallback<TreeListCollapseEventArgs> OnCollapse { get; set; }
Property Value
OnExpand
Fires when a row is expanded.
Declaration
[Parameter]
public EventCallback<TreeListExpandEventArgs> OnExpand { get; set; }
Property Value
OnRowClick
Fires when the user clicks on a row, or presses enter.
Declaration
[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowClick { get; set; }
Property Value
OnRowContextMenu
Fires when the user triggers contextmenu event with click or context menu button.
Declaration
[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowContextMenu { get; set; }
Property Value
OnRowDoubleClick
Fires when the user double-clicks on a row.
Declaration
[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowDoubleClick { get; set; }
Property Value
OnRowDrop
Fired when a row is dropped.
Declaration
[Parameter]
public EventCallback<TreeListRowDropEventArgs<TItem>> OnRowDrop { get; set; }
Property Value
OnRowRender
Called each time a row is rendered. Use this to add custom classes to the row based on the data item.
Declaration
[Parameter]
public Action<TreeListRowRenderEventArgs> OnRowRender { get; set; }
Property Value
OnStateChanged
Fires on user interaction that causes changes in the TreeListState<TItem>.
Declaration
[Parameter]
public EventCallback<TreeListStateEventArgs<TItem>> OnStateChanged { get; set; }
Property Value
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
[Parameter]
public EventCallback<TreeListStateEventArgs<TItem>> OnStateInit { get; set; }
Property Value
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
[Parameter]
public string ParentIdField { get; set; }
Property Value
ScrollMode
Defines scrolling mode of the TreeList. Possible values are Scrollable and Virtual.
Declaration
[Parameter]
public TreeListScrollMode ScrollMode { get; set; }
Property Value
SelectedCells
Defines the collection of selected cells. The parameter supports two-way binding. Also set SelectionMode
.
Declaration
[Parameter]
public IEnumerable<TreeListSelectedCellDescriptor> SelectedCells { get; set; }
Property Value
SelectedCellsChanged
The event fires when users select or unselect cell.
Declaration
[Parameter]
public EventCallback<IEnumerable<TreeListSelectedCellDescriptor>> SelectedCellsChanged { get; set; }
Property Value
SelectionMode
Defines the Selection Mode of the TreeList.
Declaration
[Parameter]
public TreeListSelectionMode SelectionMode { get; set; }
Property Value
TreeListPagerTemplate
Defines the template that will be displayed instead of the Pager.
Declaration
[Parameter]
public RenderFragment TreeListPagerTemplate { get; set; }
Property Value
TreeListSettings
Declaration
[Parameter]
public RenderFragment TreeListSettings { get; set; }
Property Value
Methods
AutoFitAllColumns()
Declaration
public void AutoFitAllColumns()
AutoFitColumns(IEnumerable<string>)
Declaration
public void AutoFitColumns(IEnumerable<string> ids)
Parameters
ids
AutoFitColumnsAsync(IEnumerable<string>)
Declaration
public Task AutoFitColumnsAsync(IEnumerable<string> ids)
Parameters
ids
Returns
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides
GetItemFromDropIndex(int)
Declaration
protected override TItem GetItemFromDropIndex(int index)
Parameters
index
Returns
TItem
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.
SetParametersAsync(ParameterView)
Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
parameters
Returns
Overrides
SetSkip(int)
Declaration
protected override void SetSkip(int skip)
Parameters
skip
Overrides
SetStateAsync(TreeListState<TItem>)
Sets the state of the TreeList. Includes sorting, filtering, edit items, column state, etc.
Declaration
public Task SetStateAsync(TreeListState<TItem> state)
Parameters
state
TreeListState<TItem>
Returns