DxTreeList.SortBy(String, TreeListColumnSortOrder) Method
Sorts data by column values in the specified order.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.v24.1.dll
NuGet Package: DevExpress.Blazor
Declaration
public void SortBy(
string columnFieldName,
TreeListColumnSortOrder sortOrder
)
Parameters
Name | Type | Description |
---|---|---|
columnFieldName | String | Specifies the name of the data source field that supplies data for the processed column. If the component does not contain the column that corresponds to the specified data field, an exception occurs. |
sortOrder | TreeListColumnSortOrder | The column’s sort order. |
Remarks
The SortBy
method allows you to sort TreeList data in code regardless of the DxTreeList.AllowSort or DxTreeListDataColumn.AllowSort property value.
The following code snippet uses different method overloads:
@inject EmployeeTaskService EmployeeTaskService
<DxTreeList @ref="MyTreeList" Data="TreeListData" KeyFieldName="Id" ParentKeyFieldName="ParentId">
<Columns>
<DxTreeListDataColumn FieldName="Name" Caption="Task" />
<DxTreeListDataColumn FieldName="EmployeeName" />
<DxTreeListDataColumn FieldName="StartDate" />
<DxTreeListDataColumn FieldName="DueDate" />
</Columns>
</DxTreeList>
<DxButton Click="@(() => MyTreeList.SortBy("EmployeeName"))">Sort By Employee Name</DxButton>
<DxButton Click="@(() => MyTreeList.SortBy("EmployeeName", TreeListColumnSortOrder.Descending))">
Sort By Employee Name (Descending Order)
</DxButton>
<DxButton Click="@(() => MyTreeList.SortBy("EmployeeName", TreeListColumnSortOrder.Descending, 0))">
Sort By Employee Name (Descending Order, SortIndex = 0)
</DxButton>
@code {
ITreeList MyTreeList { get; set; }
List<EmployeeTask> TreeListData { get; set; }
protected override void OnInitialized() {
TreeListData = EmployeeTaskService.GenerateData();
}
}
For more information about data sorting in the TreeList component, refer to the following topic: Sort Data in Blazor TreeList.