Excel.Interfaces.RangeLoadOptions interface

Paket:

excel

Range stellt eine Gruppe von einer oder mehreren zusammenhängenden Zellen dar, z. B. eine Zelle, eine Zeile, eine Spalte oder einen Zellblock. Wenn Sie mehr darüber erfahren möchten, wie Bereiche in der API verwendet werden, beginnen Sie mit Bereiche in der Excel-JavaScript-API.

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

$all	Wenn Sie für loadOptions angeben$all, werden alle skalaren Eigenschaften (z. B.Range.address ) geladen, aber nicht die Navigationseigenschaften (z. B.: Range.format.fill.color).
address	Gibt den Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").
addressLocal	Stellt den Bereichsverweis 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	Stellt dar, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Spalten im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet sind und andere Spalten im gleichen Bereich nicht ausgeblendet werden.
columnIndex	Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.
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.
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 , wenn alle Zellen einen Überlaufrahmen haben oder false wenn alle Zellen keinen Überlaufrahmen haben. Gibt zurück null , wenn sich Zellen mit und ohne Überlaufrahmen innerhalb des Bereichs befinden.
height	Gibt den Abstand in Punkt für einen Zoom von 100 % vom oberen Rand des Bereichs bis zum unteren Rand des Bereichs zurück.
hidden	Stellt dar, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zellen im Bereich ausgeblendet werden. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im gleichen Bereich nicht ausgeblendet werden.
hyperlink	Stellt den Link 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 Punkt für 100 % Zoom vom linken Rand des Arbeitsblatts zum linken Rand des Bereichs zurück.
linkedDataTypeState	Stellt den Datentypstatus der einzelnen Zellen dar.
numberFormat	Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar. Weitere Informationen zur Excel-Zahlenformatierung finden Sie unter Zahlenformatcodes.
numberFormatCategories	Stellt die Kategorie des Zahlenformats jeder Zelle dar.
numberFormatLocal	Stellt den Excel-Zahlenformatcode für den angegebenen Bereich basierend auf den Spracheinstellungen des Benutzers dar. Excel führt beim Abrufen oder Festlegen der numberFormatLocal Eigenschaft keine Sprach- oder Formatkoersion 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	Stellt dar, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Value ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zeilen im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im gleichen Bereich nicht ausgeblendet werden.
rowIndex	Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.
savedAsArray	Stellt dar, ob alle Zellen als Arrayformel gespeichert würden. Gibt zurück true , wenn alle Zellen als Arrayformel gespeichert würden oder false wenn nicht alle Zellen als Arrayformel gespeichert würden. Gibt zurück null , wenn einige Zellen als Arrayformel gespeichert würden und 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 Enumeration darstellt.
text	Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des Nummernzeichens (#), die in der Excel-Benutzeroberfläche erfolgt, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.
top	Gibt den Abstand in Punkt für 100 % Zoom 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 eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
valuesAsJson	Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu Range.valuesunterstützt Range.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 Range.valuesAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.
valuesAsJsonLocal	Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu Range.valuesunterstützt Range.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 Range.valuesAsJson.
valueTypes	Gibt den Datentyp in jeder Zelle an.
width	Gibt den Abstand in Punkt für 100 % Zoom vom linken Rand des Bereichs bis zum rechten Rand des Bereichs zurück.
worksheet	Das Arbeitsblatt, das den aktuellen Bereich enthält.

Details zur Eigenschaft

$all

Wenn Sie für loadOptions 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 Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").

address?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

addressLocal

Stellt den Bereichsverweis 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

Stellt dar, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Spalten im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet sind und andere Spalten im gleichen Bereich nicht ausgeblendet werden.

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 ]

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 ]

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 , wenn alle Zellen einen Überlaufrahmen haben oder false wenn alle Zellen keinen Überlaufrahmen haben. Gibt zurück null , wenn sich Zellen mit und ohne Überlaufrahmen innerhalb des Bereichs befinden.

hasSpill?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.12 ]

height

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

height?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.10 ]

hidden

Stellt dar, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zellen im Bereich ausgeblendet werden. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im gleichen Bereich nicht ausgeblendet werden.

hidden?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.2 ]

hyperlink

Stellt den Link 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 Punkt für 100 % Zoom vom linken Rand des Arbeitsblatts zum linken Rand des Bereichs 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 Zahlenformatcode von Excel 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 jeder Zelle dar.

numberFormatCategories?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.12 ]

numberFormatLocal

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich basierend auf den Spracheinstellungen des Benutzers dar. Excel führt beim Abrufen oder Festlegen der numberFormatLocal Eigenschaft keine Sprach- oder Formatkoersion 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

Stellt dar, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Value ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zeilen im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im gleichen Bereich nicht ausgeblendet werden.

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

Stellt dar, ob alle Zellen als Arrayformel gespeichert würden. Gibt zurück true , wenn alle Zellen als Arrayformel gespeichert würden oder false wenn nicht alle Zellen als Arrayformel gespeichert würden. Gibt zurück null , wenn einige Zellen als Arrayformel gespeichert würden und 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 Enumeration 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. Die Ersetzung des Nummernzeichens (#), die in der Excel-Benutzeroberfläche erfolgt, 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 Punkt für 100 % Zoom 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 eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder 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 zu Range.valuesunterstützt Range.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 Range.valuesAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.

valuesAsJson?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.16 ]

valuesAsJsonLocal

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz zu Range.valuesunterstützt Range.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 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 den Abstand in Punkt für 100 % Zoom vom linken Rand des Bereichs bis zum rechten Rand des Bereichs 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 ]