Excel.NamedItemArrayValues class

  • Referenz
Paket:
excel

Stellt ein Objekt dar, das Werte und Typen eines benannten Elements enthält.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Eigenschaften

context

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

Stellt die Typen für jedes Element im benannten Elementarray dar.
values

Stellt die Werte der einzelnen Elemente im benannten Elementarray dar.
valuesAsJson

Eine JSON-Darstellung der Werte in diesem benannten Elementarray. Im Gegensatz zu NamedItemArrayValues.valuesunterstützt NamedItemArrayValues.valuesAsJson alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie boolesche Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie NamedItemArrayValues.valuesAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.
valuesAsJsonLocal

Eine JSON-Darstellung der Werte in diesem benannten Elementarray. Im Gegensatz zu NamedItemArrayValues.valuesunterstützt NamedItemArrayValues.valuesAsJsonLocal alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie boolesche Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten sind immer am Anzeigegebietsschema des Benutzers ausgerichtet. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItemArrayValues.valuesAsJson.

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 das Objekt übergeben wird.) Während das ursprüngliche Excel.NamedItemArrayValues-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedItemArrayValuesData) 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

types

Stellt die Typen für jedes Element im benannten Elementarray dar.

readonly types: Excel.RangeValueType[][];

Eigenschaftswert

Excel.RangeValueType[][]

Hinweise

[ API-Satz: ExcelApi 1.7 ]

values

Stellt die Werte der einzelnen Elemente im benannten Elementarray dar.

readonly values: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.7 ]

valuesAsJson

Eine JSON-Darstellung der Werte in diesem benannten Elementarray. Im Gegensatz zu NamedItemArrayValues.valuesunterstützt NamedItemArrayValues.valuesAsJson alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie boolesche Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie NamedItemArrayValues.valuesAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.

readonly valuesAsJson: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

Hinweise

[ API-Satz: ExcelApi 1.16 ]

valuesAsJsonLocal

Eine JSON-Darstellung der Werte in diesem benannten Elementarray. Im Gegensatz zu NamedItemArrayValues.valuesunterstützt NamedItemArrayValues.valuesAsJsonLocal alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie boolesche Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten sind immer am Anzeigegebietsschema des Benutzers ausgerichtet. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItemArrayValues.valuesAsJson.

readonly valuesAsJsonLocal: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

Hinweise

[ API-Satz: ExcelApi 1.16 ]

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.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

Parameter

options
Excel.Interfaces.NamedItemArrayValuesLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.NamedItemArrayValues

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.NamedItemArrayValues;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.NamedItemArrayValues

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.NamedItemArrayValues;

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

Excel.NamedItemArrayValues

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

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

Gibt zurück

Excel.Interfaces.NamedItemArrayValuesData