Excel.TableSort class
Verwaltet Sortiervorgänge für Table Objekte.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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. |
| match |
Gibt an, ob sich die Groß-/Kleinschreibung auf die letzte Sortierung der Tabelle auswirkt. |
| method | Stellt die Chinesische Zeichenreihenfolgemethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde. |
Methoden
| apply(fields, match |
Führt einen Sortiervorgang aus. |
| apply(fields, match |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| reapply() | Wendet die aktuellen Sortierparameter erneut auf die Tabelle an. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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
matchCase
Gibt an, ob sich die Groß-/Kleinschreibung auf die letzte Sortierung der Tabelle auswirkt.
readonly matchCase: boolean;Eigenschaftswert
boolean
Hinweise
method
Stellt die Chinesische Zeichenreihenfolgemethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde.
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";Eigenschaftswert
Excel.SortMethod | "PinYin" | "StrokeCount"
Hinweise
Details zur Methode
apply(fields, matchCase, method)
Führt einen Sortiervorgang aus.
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;Parameter
- fields
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
Beispiele
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)
Führt einen Sortiervorgang aus.
apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;Parameter
- fields
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
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
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.TableSort Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TableSortData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.TableSortData;Gibt zurück
Office Add-ins