Excel.Interfaces.RangeLoadOptions interface

Paket:
excel

Der Bereich stellt eine Gruppe von einer oder mehreren zusammenhängenden Zellen dar, z. B. eine Zelle, eine Zeile, eine Spalte oder einen Block von Zellen. Weitere Informationen zur Verwendung von Bereichen in der API finden Sie unter "Bereiche" in der Excel-JavaScript-API.

Hinweise

API-Satz: ExcelApi 1.1

Verwendet von

Eigenschaften

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).
address

Gibt den Bereichsbezug im A1-Format an. Der Adresswert enthält den Blattbezug (z. B. "Tabelle1! A1:B4").
addressLocal

Stellt den Bereichsbezug für den angegebenen Bereich in der Sprache des Benutzers dar.
cellCount

Gibt die Anzahl der Zellen im Bereich an. Diese API gibt -1 zurück, wenn die Zellenanzahl 2^31-1 (2.147.483.647) überschreitet.
columnCount

Gibt die Gesamtanzahl der Spalten im Bereich an.
columnHidden

Gibt an, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Spalten im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet und andere Spalten im selben Bereich nicht ausgeblendet sind.
columnIndex

Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.
control

Greift auf das auf diesen Bereich angewendete Zellensteuerelement zu. Wenn der Bereich über mehrere Zellsteuerelemente verfügt, wird zurückgegeben EmptyCellControl.
dataValidation

Gibt ein Datenüberprüfungsobjekt zurück.
format

Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.
formulaArray

Gibt die Arrayformel eines Bereichs an. Wenn der angegebene Bereich keine Matrixformel enthält, gibt diese Eigenschaft zurück null.
formulas

Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
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.
formulasR1C1

Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
hasSpill

Stellt dar, ob alle Zellen einen Überlaufrahmen aufweisen. Gibt zurück true , ob alle Zellen einen Überlaufrahmen haben oder false wenn alle Zellen keinen Überlaufrahmen haben. Gibt zurück null , ob Zellen mit und ohne Überlaufrahmen innerhalb des Bereichs vorhanden sind.
height

Gibt die Entfernung in Punkten für 100 % Zoom vom oberen Rand des Bereichs bis zum unteren Rand des Bereichs zurück.
hidden

Gibt an, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zellen im Bereich ausgeblendet sind. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im selben Bereich nicht ausgeblendet sind.
hyperlink

Stellt den Hyperlink für den aktuellen Bereich dar.
isEntireColumn

Gibt an, ob der angegebene Bereich eine ganze Spalte ist.
isEntireRow

Gibt an, ob der angegebene Bereich eine ganze Zeile ist.
left

Gibt den Abstand in Punkten vom linken Rand des Arbeitsblatts bis zum linken Rand des Bereichs für einen Zoom von 100 % zurück.
linkedDataTypeState

Stellt den Datentypstatus der einzelnen Zellen dar.
numberFormat

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich dar. Weitere Informationen zur Excel-Zahlenformatierung finden Sie unter Zahlenformatcodes.
numberFormatCategories

Stellt die Kategorie des Zahlenformats für jede Zelle dar.
numberFormatLocal

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich auf der Grundlage der Spracheinstellungen des Benutzers dar. Excel führt beim Abrufen oder Festlegen der numberFormatLocal Eigenschaft keine Sprach- oder Formatkonvertierung aus. Jeder zurückgegebene Text verwendet die lokal formatierten Zeichenfolgen basierend auf der in den Systemeinstellungen angegebenen Sprache.
rowCount

Gibt die Anzahl der Zeilen im Bereich zurück.
rowHidden

Gibt an, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zeilen im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im selben Bereich nicht.
rowIndex

Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.
savedAsArray

Gibt an, ob alle Zellen als Arrayformel gespeichert werden sollen. Gibt zurück true , false ob alle Zellen als Matrixformel oder nicht alle Zellen als Matrixformel gespeichert wurden. Gibt zurück null , ob einige Zellen als Arrayformel gespeichert werden, andere nicht.
style

Stellt die Formatvorlage des aktuellen Bereichs dar. Wenn die Formatvorlagen der Zellen inkonsistent sind, null wird zurückgegeben. Bei benutzerdefinierten Formatvorlagen wird der Formatvorlagenname zurückgegeben. Bei integrierten Formatvorlagen wird eine Zeichenfolge zurückgegeben, die einen Wert in der BuiltInStyle Aufzählung darstellt.
text

Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Das Ersetzen des Nummernzeichens (#) in der Excel-Benutzeroberfläche wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.
top

Gibt den Abstand in Punkten für einen Zoom von 100 % vom oberen Rand des Arbeitsblatts bis zum oberen Rand des Bereichs zurück.
values

Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um Zeichenfolgen, Zahlen oder boolesche Werte handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), einem Minuszeichen ("-") oder einem Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
valuesAsJson

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie Range.valuesAsJsonLocal.
valuesAsJsonLocal

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie Range.valuesAsJson.
valueTypes

Gibt den Datentyp in jeder Zelle an.
width

Gibt die Entfernung in Punkten vom linken Rand des Bereichs bis zum rechten Rand des Bereichs für einen Zoom von 100 % zurück.
worksheet

Das Arbeitsblatt, das den aktuellen Bereich enthält.

Details zur Eigenschaft

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).

$all?: boolean;

Eigenschaftswert

boolean

address

Gibt den Bereichsbezug im A1-Format an. Der Adresswert enthält den Blattbezug (z. B. "Tabelle1! A1:B4").

address?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

addressLocal

Stellt den Bereichsbezug für den angegebenen Bereich in der Sprache des Benutzers dar.

addressLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

cellCount

Gibt die Anzahl der Zellen im Bereich an. Diese API gibt -1 zurück, wenn die Zellenanzahl 2^31-1 (2.147.483.647) überschreitet.

cellCount?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

columnCount

Gibt die Gesamtanzahl der Spalten im Bereich an.

columnCount?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

columnHidden

Gibt an, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Spalten im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet und andere Spalten im selben Bereich nicht ausgeblendet sind.

columnHidden?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.2

columnIndex

Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.

columnIndex?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

control

Greift auf das auf diesen Bereich angewendete Zellensteuerelement zu. Wenn der Bereich über mehrere Zellsteuerelemente verfügt, wird zurückgegeben EmptyCellControl.

control?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.18

dataValidation

Gibt ein Datenüberprüfungsobjekt zurück.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Eigenschaftswert

Excel.Interfaces.DataValidationLoadOptions

Hinweise

API-Satz: ExcelApi 1.8

format

Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.

format?: Excel.Interfaces.RangeFormatLoadOptions;

Eigenschaftswert

Excel.Interfaces.RangeFormatLoadOptions

Hinweise

API-Satz: ExcelApi 1.1

formulaArray

Gibt die Arrayformel eines Bereichs an. Wenn der angegebene Bereich keine Matrixformel enthält, gibt diese Eigenschaft zurück null.

formulaArray?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApiDesktop 1.1

formulas

Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

formulas?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

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?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

formulasR1C1

Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

formulasR1C1?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.2

hasSpill

Stellt dar, ob alle Zellen einen Überlaufrahmen aufweisen. Gibt zurück true , ob alle Zellen einen Überlaufrahmen haben oder false wenn alle Zellen keinen Überlaufrahmen haben. Gibt zurück null , ob Zellen mit und ohne Überlaufrahmen innerhalb des Bereichs vorhanden sind.

hasSpill?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.12

height

Gibt die Entfernung in Punkten für 100 % Zoom vom oberen Rand des Bereichs bis zum unteren Rand des Bereichs zurück.

height?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

hidden

Gibt an, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zellen im Bereich ausgeblendet sind. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im selben Bereich nicht ausgeblendet sind.

hidden?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.2

Stellt den Hyperlink für den aktuellen Bereich dar.

hyperlink?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

isEntireColumn

Gibt an, ob der angegebene Bereich eine ganze Spalte ist.

isEntireColumn?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

isEntireRow

Gibt an, ob der angegebene Bereich eine ganze Zeile ist.

isEntireRow?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

left

Gibt den Abstand in Punkten vom linken Rand des Arbeitsblatts bis zum linken Rand des Bereichs für einen Zoom von 100 % zurück.

left?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

linkedDataTypeState

Stellt den Datentypstatus der einzelnen Zellen dar.

linkedDataTypeState?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.9

numberFormat

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich dar. Weitere Informationen zur Excel-Zahlenformatierung finden Sie unter Zahlenformatcodes.

numberFormat?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

numberFormatCategories

Stellt die Kategorie des Zahlenformats für jede Zelle dar.

numberFormatCategories?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.12

numberFormatLocal

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich auf der Grundlage der Spracheinstellungen des Benutzers dar. Excel führt beim Abrufen oder Festlegen der numberFormatLocal Eigenschaft keine Sprach- oder Formatkonvertierung aus. Jeder zurückgegebene Text verwendet die lokal formatierten Zeichenfolgen basierend auf der in den Systemeinstellungen angegebenen Sprache.

numberFormatLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

rowCount

Gibt die Anzahl der Zeilen im Bereich zurück.

rowCount?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

rowHidden

Gibt an, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zeilen im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im selben Bereich nicht.

rowHidden?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.2

rowIndex

Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.

rowIndex?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

savedAsArray

Gibt an, ob alle Zellen als Arrayformel gespeichert werden sollen. Gibt zurück true , false ob alle Zellen als Matrixformel oder nicht alle Zellen als Matrixformel gespeichert wurden. Gibt zurück null , ob einige Zellen als Arrayformel gespeichert werden, andere nicht.

savedAsArray?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.12

style

Stellt die Formatvorlage des aktuellen Bereichs dar. Wenn die Formatvorlagen der Zellen inkonsistent sind, null wird zurückgegeben. Bei benutzerdefinierten Formatvorlagen wird der Formatvorlagenname zurückgegeben. Bei integrierten Formatvorlagen wird eine Zeichenfolge zurückgegeben, die einen Wert in der BuiltInStyle Aufzählung darstellt.

style?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

text

Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Das Ersetzen des Nummernzeichens (#) in der Excel-Benutzeroberfläche wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.

text?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

top

Gibt den Abstand in Punkten für einen Zoom von 100 % vom oberen Rand des Arbeitsblatts bis zum oberen Rand des Bereichs zurück.

top?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

values

Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um Zeichenfolgen, Zahlen oder boolesche Werte handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), einem Minuszeichen ("-") oder einem Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.

values?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

valuesAsJson

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie Range.valuesAsJsonLocal.

valuesAsJson?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.16

valuesAsJsonLocal

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie Range.valuesAsJson.

valuesAsJsonLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.16

valueTypes

Gibt den Datentyp in jeder Zelle an.

valueTypes?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

width

Gibt die Entfernung in Punkten vom linken Rand des Bereichs bis zum rechten Rand des Bereichs für einen Zoom von 100 % zurück.

width?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.10

worksheet

Das Arbeitsblatt, das den aktuellen Bereich enthält.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Eigenschaftswert

Excel.Interfaces.WorksheetLoadOptions

Hinweise

API-Satz: ExcelApi 1.1