Class

TelerikTreeList<TItem>

Declaration

protected string EditFieldOnStateInit { get; set; }

Property Value

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

Enables WebMCP tool registration for this TreeList. When true, TreeList operations are exposed as tools discoverable by AI models through the browser. Configure tool names and overrides via TreeListWebMcpSettings inside TreeListSettings.

Declaration

[Parameter]
public bool EnableWebMcpTools { get; set; }

Property Value

Defines the Filter Mode of the Component.

Declaration

[Parameter]
public TreeListFilterMode FilterMode { get; set; }

Property Value

Defines the HasChildren DataField of the DataSource.

Declaration

[Parameter]
public string HasChildrenField { get; set; }

Property Value

Defines the Id DataField of the DataSource.

Declaration

[Parameter]
public string IdField { get; set; }

Property Value

Defines the Items DataField of the DataSource that contains the child nodes.

Declaration

[Parameter]
public string ItemsField { get; set; }

Property Value

The position at which a new data item is inserted in the TreeList - top or bottom. Default value is Top.

Declaration

[Parameter]
public TreeListNewRowPosition NewRowPosition { get; set; }

Property Value

Fires when a row is collapsed.

Declaration

[Parameter]
public EventCallback<TreeListCollapseEventArgs> OnCollapse { get; set; }

Property Value

Fires when a row is expanded.

Declaration

[Parameter]
public EventCallback<TreeListExpandEventArgs> OnExpand { get; set; }

Property Value

Fires when the user clicks on a row, or presses enter.

Declaration

[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowClick { get; set; }

Property Value

Fires when the user triggers contextmenu event with click or context menu button.

Declaration

[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowContextMenu { get; set; }

Property Value

Fires when the user double-clicks on a row.

Declaration

[Parameter]
public EventCallback<TreeListRowClickEventArgs> OnRowDoubleClick { get; set; }

Property Value

Fired when a row is dropped.

Declaration

[Parameter]
public EventCallback<TreeListRowDropEventArgs<TItem>> OnRowDrop { get; set; }

Property Value

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

Fires on user interaction that causes changes in the TreeListState<TItem>.

Declaration

[Parameter]
public EventCallback<TreeListStateEventArgs<TItem>> OnStateChanged { get; set; }

Property Value

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

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

Defines scrolling mode of the TreeList. Possible values are Scrollable and Virtual.

Declaration

[Parameter]
public TreeListScrollMode ScrollMode { get; set; }

Property Value

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

The event fires when users select or unselect cell.

Declaration

[Parameter]
public EventCallback<IEnumerable<TreeListSelectedCellDescriptor>> SelectedCellsChanged { get; set; }

Property Value

Defines the Selection Mode of the TreeList.

Declaration

[Parameter]
public TreeListSelectionMode SelectionMode { get; set; }

Property Value

Defines the container for the TreeList columns. Children: TreeListColumn, TreeListCheckboxColumn, TreeListCommandColumn.

Declaration

[Parameter]
public RenderFragment TreeListColumns { get; set; }

Property Value

Defines the template that will be displayed instead of the Pager.

Declaration

[Parameter]
public RenderFragment TreeListPagerTemplate { get; set; }

Property Value

Declaration

[Parameter]
public RenderFragment TreeListSettings { get; set; }

Property Value

Defines the tools for the toolbar of the TreeList. Children: TreeListCommandButton, TreeListSearchBox, TreeListToolBarAddTool, TreeListToolBarSpacerTool, TreeListToolBarCustomTool .

Declaration

[Parameter]
public RenderFragment TreeListToolBar { get; set; }

Property Value

Defines the toolbar of the TreeList.

Declaration

[Parameter]
public RenderFragment TreeListToolBarTemplate { get; set; }

Property Value

Declaration

public void AutoFitAllColumns()

Declaration

public Task AutoFitAllColumnsAsync()

Returns

Declaration

public void AutoFitColumn(string id)

Parameters

Declaration

public Task AutoFitColumnAsync(string id)

Parameters

Returns

Declaration

public void AutoFitColumns(IEnumerable<string> ids)

Parameters

Declaration

public Task AutoFitColumnsAsync(IEnumerable<string> ids)

Parameters

Returns

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

public override void Dispose()

Overrides TableGridBase<TItem, TreeListCommandEventArgs>.Dispose()

Declaration

protected override TItem GetItemFromDropIndex(int index)

Parameters

Returns

Overrides TableGridBase<TItem, TreeListCommandEventArgs>.GetItemFromDropIndex(int)

Gets the current state of the TreeList. Includes sorting, filtering, edit items, column state, etc.

Declaration

public TreeListState<TItem> GetState()

Returns

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override Task OnParametersSetAsync()

Returns

Overrides DataBoundComponent<TItem>.OnParametersSetAsync()

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Overrides DataBoundComponent<TItem>.SetParametersAsync(ParameterView)

Declaration

protected override void SetSkip(int skip)

Parameters

Overrides TableGridBase<TItem, TreeListCommandEventArgs>.SetSkip(int)

Sets the state of the TreeList. Includes sorting, filtering, edit items, column state, etc.

Declaration

public Task SetStateAsync(TreeListState<TItem> state)

Parameters

Returns