ExcelScript.TableSort interface

Paket:

ExcelScript

Verwaltet Sortiervorgänge für Table Objekte.

Methoden

apply(fields, matchCase, method)	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.
getFields()	Gibt die aktuellen Bedingungen an, die zum letzten Sortieren der Tabelle verwendet werden.
getMatchCase()	Gibt an, ob sich die Groß-/Kleinschreibung auf die letzte Sortierung der Tabelle auswirkt.
getMethod()	Stellt die Chinesische Zeichenreihenfolgemethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde.
reapply()	Wendet die aktuellen Sortierparameter erneut auf die Tabelle an.

Details zur Methode

apply(fields, matchCase, method)

Führt einen Sortiervorgang aus.

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

Parameter

fields

ExcelScript.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

ExcelScript.SortMethod

Optional. Die Sortiermethode für chinesische Zeichen.

Gibt zurück

void

Beispiele

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

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

getFields()

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

getFields(): SortField[];

Gibt zurück

ExcelScript.SortField[]

getMatchCase()

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

getMatchCase(): boolean;

Gibt zurück

boolean

getMethod()

Stellt die Chinesische Zeichenreihenfolgemethode dar, die zuletzt zum Sortieren der Tabelle verwendet wurde.

getMethod(): SortMethod;

Gibt zurück

ExcelScript.SortMethod

reapply()

Wendet die aktuellen Sortierparameter erneut auf die Tabelle an.

reapply(): void;

Gibt zurück

void

Beispiele

/**
 * This script reapplies all the current sorting criteria to existing tables.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the tables.
  const tables = workbook.getTables();

  // For each table, reapply that table's current sorting parameters.
  tables.forEach((table) => {
    const sort: ExcelScript.TableSort = table.getSort();
    sort.reapply();
  });
}