Excel.TableSort class

Verwaltet Sortiervorgänge für Table Objekte.

Extends

Hinweise

[API-Satz: ExcelApi 1.2 ]

Eigenschaften

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office Hostanwendung verbunden.

fields

Gibt die aktuellen Bedingungen an, die zum letzten Sortieren der Tabelle verwendet werden.

matchCase

Gibt an, ob sich die Groß-/Kleinschreibung auf die letzte Sortierung der Tabelle auswirkt.

method

Stellt die chinesische Zeichensortiermethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde.

Methoden

apply(fields, matchCase, method)

Führt einen Sortiervorgang aus.

apply(fields, matchCase, methodString)

Führt einen Sortiervorgang aus.

clear()

Löscht die Sortierung, die derzeit in der Tabelle enthalten ist. Dies ändert nicht die Sortierung der Tabelle, löscht jedoch den Zustand der Kopfzeilen-Schaltflächen.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

reapply()

Wendet die aktuellen Sortierparameter erneut auf die Tabelle an.

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während die ursprüngliche Excel. TableSort-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt zurück (typisiert alsExcel.Interfaces.TableSortData), die flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

fields

Gibt die aktuellen Bedingungen an, die zum letzten Sortieren der Tabelle verwendet werden.

readonly fields: Excel.SortField[];

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.2 ]

matchCase

Gibt an, ob sich die Groß-/Kleinschreibung auf die letzte Sortierung der Tabelle auswirkt.

readonly matchCase: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.2 ]

method

Stellt die chinesische Zeichensortiermethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde.

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

Eigenschaftswert

Excel.SortMethod | "PinYin" | "StrokeCount"

Hinweise

[API-Satz: ExcelApi 1.2 ]

Details zur Methode

apply(fields, matchCase, method)

Führt einen Sortiervorgang aus.

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

Parameter

fields

Excel.SortField[]

Die Liste der Bedingungen, nach denen sortiert werden soll.

matchCase

boolean

Optional. Gibt an, ob sich die Groß-/Kleinschreibung auf die Zeichenfolgensortierung auswirkt.

method
Excel.SortMethod

Optional. Die Sortiermethode für chinesische Zeichen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2 ]

Beispiele

Excel.run(function (ctx) { 
    var tableName = 'Table1';
    var table = ctx.workbook.tables.getItem(tableName);
    table.sort.apply([ 
            {
                key: 2,
                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));
    }
});

apply(fields, matchCase, methodString)

Führt einen Sortiervorgang aus.

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

Parameter

fields

Excel.SortField[]

Die Liste der Bedingungen, nach denen sortiert werden soll.

matchCase

boolean

Optional. Gibt an, ob sich die Groß-/Kleinschreibung auf die Zeichenfolgensortierung auswirkt.

methodString

"PinYin" | "StrokeCount"

Optional. Die Sortiermethode für chinesische Zeichen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2 ]

clear()

Löscht die Sortierung, die derzeit in der Tabelle enthalten ist. Dies ändert nicht die Sortierung der Tabelle, löscht jedoch den Zustand der Kopfzeilen-Schaltflächen.

clear(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options
Excel.Interfaces.TableSortLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

reapply()

Wendet die aktuellen Sortierparameter erneut auf die Tabelle an.

reapply(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2 ]

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während die ursprüngliche Excel. TableSort-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt zurück (typisiert alsExcel.Interfaces.TableSortData), die flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.TableSortData;

Gibt zurück