Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

ITreeList Interface

An interface that defines DxTreeList component API members (properties and methods).

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

#Declaration

C#
public interface ITreeList

The following members return ITreeList objects:

Show 36 links

#Remarks

We recommend that you use the ITreeList interface when you access TreeList API members in any of the following cases:

  • You use the @ref attribute to reference a TreeList object. For example, you set or change values of the TreeList parameters outside the component’s markup.
  • You access a TreeList object from templates or event handlers.

In all other cases, bind your data to TreeList parameters.

Enclose your code between BeginUpdate() and EndUpdate() method calls if you change values of TreeList parameters outside the markup or to avoid excessive render operations. The following code snippet changes multiple sort options in the TreeList:

@inject EmployeeTaskService EmployeeTaskService

<style>
    .my-button {
        width: 200px;
    }
</style>

<DxTreeList Data="TreeListData" KeyFieldName="Id" ParentKeyFieldName="ParentId" @ref="MyTreeList">
    <Columns>
        <DxTreeListDataColumn FieldName="Name" Caption="Task" SortIndex="0" />
        <DxTreeListDataColumn FieldName="EmployeeName" SortIndex="1" />
        <DxTreeListDataColumn FieldName="StartDate" />
        <DxTreeListDataColumn FieldName="DueDate" />
    </Columns>
</DxTreeList>
<br />
<DxButton Click="ChangeSortInfo" CssClass="my-button" Text="Change Sort Options" />

@code {
    ITreeList MyTreeList { get; set; }
    List<EmployeeTask> TreeListData { get; set; }

    protected override void OnInitialized() {
        TreeListData = EmployeeTaskService.GenerateData();
    }
    void ChangeSortInfo() {
        MyTreeList.BeginUpdate();
        MyTreeList.ClearSort();
        MyTreeList.SortBy("StartDate");
        MyTreeList.SortBy("DueDate", TreeListColumnSortOrder.Descending);
        MyTreeList.EndUpdate();
    }
}

See Also