RangeSort Object (JavaScript API for Excel)

Manages sorting operations on Range objects.

Properties

None

Relationships

None

Methods

Method Return Type Description Req. Set
apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string) void Perform a sort operation. 1.2

Method Details

apply(fields: SortField[], matchCase: bool, hasHeaders: bool, orientation: string, method: string)

Perform a sort operation.

Syntax

rangeSortObject.apply(fields, matchCase, hasHeaders, orientation, method);

Parameters

Parameter Type Description
fields SortField[] The list of conditions to sort on.
matchCase bool Optional. Whether to have the casing impact string ordering.
hasHeaders bool Optional. Whether the range has a header.
orientation string Optional. Whether the operation is sorting rows or columns. Possible values are: Rows, Columns
method string Optional. The ordering method used for Chinese characters. Possible values are: PinYin, StrokeCount

Returns

void

"> 

Returns

void

ascending: true }, ], true); return ctx.sync(); }).catch(function(error) { console.log("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });