Excel.RangeSort class

  • Referenz
Paket:
excel

Verwaltet Sortiervorgänge für Range Objekte.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Eigenschaften

context

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

Methoden

apply(fields, matchCase, hasHeaders, orientation, method)

Führt einen Sortiervorgang aus.
apply(fields, matchCase, hasHeaders, orientationString, methodString)

Führt einen Sortiervorgang aus.
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.RangeSort-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeSortData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

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

Excel.RequestContext

Details zur Methode

apply(fields, matchCase, hasHeaders, orientation, method)

Führt einen Sortiervorgang aus.

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

hasHeaders

boolean

Optional. Gibt an, ob der Bereich eine Kopfzeile aufweist.

orientation
Excel.SortOrientation

Optional. Gibt an, ob der Vorgang Zeilen oder Spalten sortiert.

method
Excel.SortMethod

Optional. Die Sortiermethode für chinesische Zeichen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

apply(fields, matchCase, hasHeaders, orientationString, methodString)

Führt einen Sortiervorgang aus.

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

hasHeaders

boolean

Optional. Gibt an, ob der Bereich eine Kopfzeile aufweist.

orientationString

"Rows" | "Columns"

Optional. Gibt an, ob der Vorgang Zeilen oder Spalten sortiert.

methodString

"PinYin" | "StrokeCount"

Optional. Die Sortiermethode für chinesische Zeichen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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.RangeSort-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeSortData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): {
            [key: string]: string;
        };

Gibt zurück

{ [key: string]: string; }