Excel.TableSort class

Package:

excel

Manages sorting operations on Table objects.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.2 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
fields	Specifies the current conditions used to last sort the table.
matchCase	Specifies if the casing impacts the last sort of the table.
method	Represents the Chinese character ordering method last used to sort the table.

Methods

apply(fields, matchCase, method)	Perform a sort operation.
apply(fields, matchCase, methodString)	Perform a sort operation.
clear()	Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
reapply()	Reapplies the current sorting parameters to the table.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.TableSort object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TableSortData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

TypeScript

context: RequestContext;

Property Value

Excel.RequestContext

fields

Specifies the current conditions used to last sort the table.

TypeScript

readonly fields: Excel.SortField[];

Property Value

Excel.SortField[]

Remarks

[ API set: ExcelApi 1.2 ]

matchCase

Specifies if the casing impacts the last sort of the table.

TypeScript

readonly matchCase: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

method

Represents the Chinese character ordering method last used to sort the table.

TypeScript

readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";

Property Value

Excel.SortMethod | "PinYin" | "StrokeCount"

Remarks

[ API set: ExcelApi 1.2 ]

Method Details

apply(fields, matchCase, method)

Perform a sort operation.

TypeScript

apply(fields: Excel.SortField[], matchCase?: boolean, 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.

method

Excel.SortMethod

Optional. The ordering method used for Chinese characters.

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

Examples

TypeScript

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.sort.apply([ 
            {
                key: 2,
                ascending: true
            },
        ], true);
    await context.sync(); 
});

apply(fields, matchCase, methodString)

Perform a sort operation.

TypeScript

apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;

Parameters

fields

Excel.SortField[]

The list of conditions to sort on.

matchCase

boolean

Optional. Whether to have the casing impact string ordering.

methodString

"PinYin" | "StrokeCount"

Optional. The ordering method used for Chinese characters.

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

clear()

Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons.

TypeScript

clear(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;

Parameters

options

Excel.Interfaces.TableSortLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.TableSort

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(propertyNames?: string | string[]): Excel.TableSort;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.TableSort

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableSort;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.TableSort

reapply()

Reapplies the current sorting parameters to the table.

TypeScript

reapply(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.TableSort object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TableSortData) that contains shallow copies of any loaded child properties from the original object.

TypeScript

toJSON(): Excel.Interfaces.TableSortData;

Returns

Excel.Interfaces.TableSortData