Class SortedEventArgs

Provides information about the Sorted event.

Inheritance
System.Object
GridEventBaseArgs
SortedEventArgs
SortingEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class SortedEventArgs : GridEventBaseArgs

Constructors

SortedEventArgs()

Declaration
public SortedEventArgs()

Properties

Action

Gets a value indicating the sorting action.

Declaration
public NotifyCollectionChangedAction Action { get; }
Property Value
Type Description
System.Collections.Specialized.NotifyCollectionChangedAction

Add sorts the grid data based on the specified column and direction. Remove Removes sorting from the specified column. Replace when the sort column direction changes from Ascending to Descending or vice versa for the same column. Reset Clears sorting from all columns in the grid using ClearSortingAsync() Method.

ColumnName

Gets the field name of the column which is associated with sorting.

Declaration
public string ColumnName { get; }
Property Value
Type Description
System.String

The string value that represents the field name of column which is associated with sorting.
Remarks

This property returns the field name of the column currently associated with sorting, even in cases of multi-sorting.

Direction

Gets or sets the direction of the sorted column.

Declaration
public SortDirection Direction { get; set; }
Property Value
Type
SortDirection
Remarks

The available sort directions are: SortDirection.None: Default, no sorting is applied or when sorting is removed. SortDirection.Ascending: Sorts records in ascending order. SortDirection.Descending: Sorts records in descending order.

SortedColumns

Gets the list of sorted columns field name and it's sort direction.

Declaration
public List<SortColumn> SortedColumns { get; }
Property Value
Type Description
System.Collections.Generic.List<SortColumn>

The list of SortColumn objects. By default, it is null.
Remarks

The list of sorted columns field name and it's sort direction will be available when columns are sorted using SortColumnsAsync(List<SortColumn>, Boolean) method.