Excel.FunctionResult class

Ein Objekt, das das Ergebnis einer Funktionsauswertungsoperation enthält

Extends

Hinweise

API-Satz: ExcelApi 1.2

Verwendet von

Eigenschaften

context

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

error

Fehlerwert (z. B. "#DIV/0"), der den Fehler darstellt. Wenn die Fehlerzeichenfolge nicht festgelegt ist, war die Funktion erfolgreich, und das Ergebnis wird in das Feld Wert geschrieben. Der Fehler liegt immer im englischen Gebietsschema.

value

Der Wert der Funktionsauswertung. Das Wertfeld wird nur ausgefüllt, wenn kein Fehler aufgetreten ist (d. h. die Error-Eigenschaft ist nicht festgelegt).

Methoden

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.

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 sie übergeben wird.) Während das ursprüngliche FunctionResult<T> Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Interfaces.FunctionResultData<T>) zurück, das 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

error

Fehlerwert (z. B. "#DIV/0"), der den Fehler darstellt. Wenn die Fehlerzeichenfolge nicht festgelegt ist, war die Funktion erfolgreich, und das Ergebnis wird in das Feld Wert geschrieben. Der Fehler liegt immer im englischen Gebietsschema.

readonly error: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.2

value

Der Wert der Funktionsauswertung. Das Wertfeld wird nur ausgefüllt, wenn kein Fehler aufgetreten ist (d. h. die Error-Eigenschaft ist nicht festgelegt).

readonly value: T;

Eigenschaftswert

T

Hinweise

API-Satz: ExcelApi 1.2

Details zur Methode

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.FunctionResultLoadOptions): FunctionResult<T>;

Parameter

options
Excel.Interfaces.FunctionResultLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

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[]): FunctionResult<T>;

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;
        }): FunctionResult<T>;

Parameter

propertyNamesAndPaths

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

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

Gibt zurück

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 sie übergeben wird.) Während das ursprüngliche FunctionResult<T> Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Interfaces.FunctionResultData<T>) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Interfaces.FunctionResultData<T>;

Gibt zurück