Class GridSortSettings

Configures grid sorting.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
GridSortSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridSortSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

GridSortSettings()

Declaration
public GridSortSettings()

Properties

AllowUnsort

If AllowUnsort set to false the user can not get the grid in unsorted state by clicking the sorted column header.

Declaration
[Parameter]
public bool AllowUnsort { get; set; }
Property Value
Type
bool

Columns

Specifies the columns to sort at initial rendering of Grid. Also user can get current sorted columns, use GridSortColumn component to set initial sort columns.

Declaration
[Parameter]
public List<GridSortColumn>? Columns { get; set; }
Property Value
Type
List<GridSortColumn>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Invoked during component initialization. Sets the main parent reference, updates sort settings in the parent grid, and initializes internal state.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Invoked when component parameters are set or updated. Synchronizes properties such as AllowUnsort and Columns with their previous values, and resets sort column change tracking if no child content is provided.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements