SortCommand Class
Represents a command to sort a range in a spreadsheet, supporting undo and redo operations.
Inheritance
Inherited Members
Namespace: Radzen.Blazor.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public class SortCommand : Spreadsheet.RangeSnapshotCommandBase, Spreadsheet.ICommand, Spreadsheet.IProtectedCommandConstructors
SortCommandlink
Initializes a new instance of the SortCommand class.
Declaration
public SortCommand(Documents.Spreadsheet.Worksheet sheet, Documents.Spreadsheet.RangeRef range, SortOrder order, int keyIndex, bool skipHeaderRow)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Worksheet | sheet | The sheet containing the range to sort. |
| Documents.Spreadsheet.RangeRef | range | The range to sort. |
| SortOrder | order | The sort order (ascending or descending). |
| int | keyIndex | The column index to sort by. |
| bool | skipHeaderRow | If true, skips the first row (header) when sorting. |
Properties
Featurelink
Declaration
public Spreadsheet.SpreadsheetFeature? Feature { get; }Property Value
| Type | Description |
|---|---|
| Spreadsheet.SpreadsheetFeature? |
RequiredActionlink
Declaration
public Documents.Spreadsheet.SheetAction RequiredAction { get; }Property Value
| Type | Description |
|---|---|
| Documents.Spreadsheet.SheetAction |
Methods
MultiKeylink
Convenience factory for the multi-key sort variant.
Declaration
public static Spreadsheet.MultiKeySortCommand MultiKey(Documents.Spreadsheet.Worksheet sheet, Documents.Spreadsheet.RangeRef range, Documents.Spreadsheet.SortKey[] keys, bool skipHeaderRow)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Worksheet | sheet | |
| Documents.Spreadsheet.RangeRef | range | |
| Documents.Spreadsheet.SortKey[] | keys | |
| bool | skipHeaderRow |
Returns
| Type | Description |
|---|---|
| Spreadsheet.MultiKeySortCommand |