DxTreeList.AllowSort Property

Specifies whether users can sort treelist data.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(true)]
[Parameter]
public bool AllowSort { get; set; }

Property Value

Type	Default	Description
Boolean	true	true to allow users to sort treelist data; otherwise, false.

Remarks

The component allows users to sort data as follows:

• Click a column header to sort data in ascending order and clear sort criteria for all other columns. Subsequent clicks reverse the sort order. The sort glyph indicates the column’s current sort order.
• Hold Shift and click column headers to sort data by multiple columns.
• Hold Ctrl and click a column header to clear sorting by this column.

Users can focus a column header and press Space, Shift+Space, or Ctrl+Space to change sort settings. Refer to the following topic for more information on keyboard shortcuts: Keyboard Support in Blazor TreeList.

Users can focus a column header and press Space, Shift+Space, or Ctrl+Space to change sort settings.

Set the TreeList’s AllowSort property to false to prevent users from sorting TreeList data. The column’s AllowSort property allows you to specify whether users can sort TreeList data by this column. Note that the value specified at the column level overrides that of the component level.

The following code snippet prevents users from sorting TreeList data:

<DxTreeList Data="Data"
            AllowSort="false">
    <Columns>
        <DxTreeListDataColumn FieldName="Name"/>
        <DxTreeListDataColumn FieldName="TypeOfObject" Caption="Type"/>
        <DxTreeListDataColumn FieldName="Mass10pow21kg" Caption="Mass" DisplayFormat="N2">
            <HeaderCaptionTemplate>Mass, 10<sup>21</sup> &#215; kg</HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="MeanRadiusInKM" Caption="Radius" DisplayFormat="N2">
            <HeaderCaptionTemplate>Radius, km</HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="Volume10pow9KM3" Caption="Volume" DisplayFormat="N2">
            <HeaderCaptionTemplate>Volume, 10<sup>9</sup> &#215; km<sup>3</sup></HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="SurfaceGravity" Caption="Gravity" DisplayFormat="N2">
            <HeaderCaptionTemplate>Gravity, m/s<sup>2</sup></HeaderCaptionTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="Density" Visible="false" DisplayFormat="N2">
            <HeaderCaptionTemplate>Density, g/cm<sup>3</sup></HeaderCaptionTemplate>
        </DxTreeListDataColumn>
    </Columns>
</DxTreeList>

Implements

AllowSort

AllowSort