Excel.RangeSort class

Manages sorting operations on Range objects.

[ API set: ExcelApi 1.2 ]

Extends
OfficeExtension.ClientObject

Methods

apply(fields, matchCase, hasHeaders, orientation, method)

Perform a sort operation.

[ API set: ExcelApi 1.2 ]

toJSON()

Method Details

apply(fields, matchCase, hasHeaders, orientation, method)

Perform a sort operation.

[ API set: ExcelApi 1.2 ]

apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod): void;
Parameters
fields
Excel.SortField[]

The list of conditions to sort on.

matchCase
boolean

Optional. Whether to have the casing impact string ordering.

hasHeaders
boolean

Optional. Whether the range has a header.

orientation
Excel.SortOrientation

Optional. Whether the operation is sorting rows or columns.

method
Excel.SortMethod

Optional. The ordering method used for Chinese characters.

Returns
void

toJSON()

toJSON:
Returns
{ [key: string]: string; }