Excel.RangeView class
RangeView stellt einen Satz von sichtbaren Zellen des übergeordneten Bereichs dar.
- Extends
Hinweise
Eigenschaften
cell |
Stellt die Zellenadressen des |
column |
Die Anzahl der sichtbaren Spalten. |
context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
formulas | Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben. |
formulas |
Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben. |
formulasR1C1 | Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben. |
index | Gibt einen Wert zurück, der den Index des |
number |
Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar. |
row |
Die Anzahl der sichtbaren Zeilen. |
rows | Stellt eine Sammlung der mit dem Bereich verknüpften Bereichsansichten dar. |
text | Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus. |
values | Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. |
values |
Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu |
values |
Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu |
value |
Stellt den Datentyp in jeder Zelle dar. |
Methoden
get |
Ruft den übergeordneten Bereich ab, der dem aktuellen |
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 " |
set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
cellAddresses
Stellt die Zellenadressen des RangeView
dar.
readonly cellAddresses: any[][];
Eigenschaftswert
any[][]
Hinweise
columnCount
Die Anzahl der sichtbaren Spalten.
readonly columnCount: number;
Eigenschaftswert
number
Hinweise
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
formulas
Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
formulas: any[][];
Eigenschaftswert
any[][]
Hinweise
formulasLocal
Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
formulasLocal: any[][];
Eigenschaftswert
any[][]
Hinweise
formulasR1C1
Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
formulasR1C1: any[][];
Eigenschaftswert
any[][]
Hinweise
index
Gibt einen Wert zurück, der den Index des RangeView
darstellt.
readonly index: number;
Eigenschaftswert
number
Hinweise
numberFormat
Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar.
numberFormat: any[][];
Eigenschaftswert
any[][]
Hinweise
rowCount
Die Anzahl der sichtbaren Zeilen.
readonly rowCount: number;
Eigenschaftswert
number
Hinweise
rows
Stellt eine Sammlung der mit dem Bereich verknüpften Bereichsansichten dar.
readonly rows: Excel.RangeViewCollection;
Eigenschaftswert
Hinweise
text
Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.
readonly text: string[][];
Eigenschaftswert
string[][]
Hinweise
values
Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück.
values: any[][];
Eigenschaftswert
any[][]
Hinweise
valuesAsJson
Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu RangeView.values
unterstützt RangeView.valuesAsJson
alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie RangeView.valuesAsJsonLocal
, um Daten im Anzeigegebietsschema des Benutzers abzurufen.
valuesAsJson: CellValue[][];
Eigenschaftswert
Excel.CellValue[][]
Hinweise
valuesAsJsonLocal
Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu RangeView.values
unterstützt RangeView.valuesAsJsonLocal
alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen 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 RangeView.valuesAsJson
.
valuesAsJsonLocal: CellValue[][];
Eigenschaftswert
Excel.CellValue[][]
Hinweise
valueTypes
Stellt den Datentyp in jeder Zelle dar.
readonly valueTypes: Excel.RangeValueType[][];
Eigenschaftswert
Hinweise
Details zur Methode
getRange()
Ruft den übergeordneten Bereich ab, der dem aktuellen RangeView
zugeordnet ist.
getRange(): Excel.Range;
Gibt zurück
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.RangeViewLoadOptions): Excel.RangeView;
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.RangeView;
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.RangeView;
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
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameter
- properties
- Excel.Interfaces.RangeViewUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.RangeView): void;
Parameter
- properties
- Excel.RangeView
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON()
, um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()
übergeben wird. (JSON.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeView
Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeViewData
) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.RangeViewData;
Gibt zurück
Office Add-ins