Excel.Range class

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]

Eigenschaften

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.
conditionalFormats	Die Sammlung dieser `ConditionalFormats` Schnittmenge den Bereich.
context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
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.
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.
sort	Stellt die Bereichssortierung des aktuellen Bereichs dar.
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. Gebietsschemaförmige Zeichenfolgen (z. B. das Datum "19-8-2025" in nl-NL oder fr-FR, Format TT-MM-JJJJ) werden als Text statt als Datumsangaben gespeichert. Um sicherzustellen, dass Datumsangaben als Datumsangaben gespeichert werden, verwenden Sie eine gebietsschemaabhängige API wie `formulasLocal` oder ein gebietsschemaneutrales Format wie ISO (JJJJ-MM-TT) oder eine numerische Datumsreihe.
valuesAsJson	Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz `Range.values`zu 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.values`zu 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.

Methoden

autoFill(destinationRange, autoFillType)	Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein `null` oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt. Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.
autoFill(destinationRange, autoFillType)	Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein `null` oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt. Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.
calculate()	Berechnet einen Zellbereich auf einem Arbeitsblatt.
clear(applyTo)	Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.
clear(applyTo)	Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.
clearOrResetContents()	Löscht die Werte der Zellen im Bereich, wobei Zellen, die Steuerelemente enthalten, besonders berücksichtigt werden. Wenn der Bereich nur leere Werte und auf ihren Standardwert festgelegte Steuerelemente enthält, werden die Werte und die Formatierung des Steuerelements entfernt. Andernfalls werden die Zellen mit Steuerelementen auf ihren Standardwert festgelegt, und die Werte der anderen Zellen im Bereich werden gelöscht.
convertDataTypeToText()	Konvertiert die Bereichszellen mit Datentypen in Text.
convertToLinkedDataType(serviceID, languageCulture)	Konvertiert die Bereichszellen in verknüpfte Datentypen im Arbeitsblatt.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder `RangeAreas` in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder `RangeAreas`. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder `RangeAreas` in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder `RangeAreas`. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.
delete(shift)	Löscht die dem Bereich zugeordneten Zellen.
delete(shift)	Löscht die dem Bereich zugeordneten Zellen.
find(text, criteria)	Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle.
findOrNullObject(text, criteria)	Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
flashFill()	Führt eine Blitzvorschau auf den aktuellen Bereich aus. Die Blitzvorschau füllt Daten automatisch aus, wenn sie ein Muster erkennt. Daher muss es sich bei dem Bereich um einen Bereich mit einer einzelnen Spalte handeln, der von Daten umgeben ist, um ein Muster zu finden.
getAbsoluteResizedRange(numRows, numColumns)	Ruft ein `Range` Objekt mit derselben Zelle oben links wie das aktuelle `Range` Objekt ab, jedoch mit der angegebenen Anzahl von Zeilen und Spalten.
getBoundingRect(anotherRange)	Ruft das kleinste Bereichsobjekt ab, das die angegebenen Bereiche umfasst. Beispielsweise ist die `GetBoundingRect` von "B2:C5" und "D10:E15" "B2:E15".
getCell(row, column)	Ruft das Bereichsobjekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltenanzahl enthält. Die Zelle kann sich außerhalb der Grenzen des übergeordneten Bereichs befinden, solange sie innerhalb des Arbeitsblattrasters bleibt. Die zurückgegebene Zelle befindet sich relativ zur obersten linken Zelle des Bereichs.
getCellProperties(cellPropertiesLoadOptions)	Gibt ein 2D-Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zelle kapselt.
getColumn(column)	Ruft eine Spalte ab, die im Bereich enthalten ist.
getColumnProperties(columnPropertiesLoadOptions)	Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Spalte kapselt. Für Eigenschaften, die innerhalb einer bestimmten Spalte nicht für alle Zellen konsistent sind, wird NULL zurückgegeben.
getColumnsAfter(count)	Ruft eine bestimmte Anzahl von Spalten rechts neben dem aktuellen `Range` Objekt ab.
getColumnsBefore(count)	Ruft eine bestimmte Anzahl von Spalten links vom aktuellen `Range` Objekt ab.
getDependents()	Gibt ein `WorkbookRangeAreas` Objekt zurück, das den Bereich darstellt, der alle abhängigen Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Gibt einen `ItemNotFound` Fehler aus, wenn keine abhängigen Personen gefunden werden.
getDirectDependents()	Gibt ein `WorkbookRangeAreas` Objekt zurück, das den Bereich darstellt, der alle direkt abhängigen Zellen eines angegebenen Bereichs im gleichen Arbeitsblatt oder auf mehreren Arbeitsblättern enthält. Gibt einen `ItemNotFound` Fehler aus, wenn keine abhängigen Personen gefunden werden.
getDirectPrecedents()	Gibt ein `WorkbookRangeAreas` Objekt zurück, das den Bereich darstellt, der alle unmittelbar vorhergehenden Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Gibt einen `ItemNotFound` Fehler aus, wenn keine Präzedenzfälle gefunden werden.
getDisplayedCellProperties(cellPropertiesLoadOptions)	Gibt ein 2D-Array zurück, das die Anzeigedaten für die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften jeder Zelle kapselt. Im Gegensatz `getCellProperties`zu , das nur Eigenschaften anzeigt, die direkt für die Zelle festgelegt sind, werden Eigenschaften zurückgegeben, die aus indirekten Quellen angezeigt werden, z. B. bedingte Formatierungen oder Formatvorlagen.
getEntireColumn()	Ruft ein Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. die Zellen "B4:E11" darstellt, ist es `getEntireColumn` ein Bereich, der die Spalten "B:E" darstellt).
getEntireRow()	Ruft ein Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. die Zellen "B4:E11" darstellt, ist dies `GetEntireRow` ein Bereich, der die Zeilen "4:11" darstellt).
getExtendedRange(direction, activeCell)	Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.
getExtendedRange(direction, activeCell)	Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.
getImage()	Rendert den Bereich als Base64-codiertes PNG-Bild.
getIntersection(anotherRange)	Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt.
getIntersectionOrNullObject(anotherRange)	Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLastCell()	Ruft die letzte Zelle im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs „B2: D5“ „D5“.
getLastColumn()	Ruft die letzte Spalte im Bereich ab. Beispielsweise lautet die letzte Spalte von „B2:D5“ „D2:D5“.
getLastRow()	Ruft die letzte Zeile im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs "B2: D5" "B5:D5".
getMergedAreasOrNullObject()	Gibt ein `RangeAreas` Objekt zurück, das die verbundenen Bereiche in diesem Bereich darstellt. Beachten Sie, dass diese Methode das Ergebnis nicht zurückgeben kann, wenn die Anzahl der zusammengeführten Bereiche in diesem Bereich größer als 512 ist. Wenn das `RangeAreas` Objekt nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getOffsetRange(rowOffset, columnOffset)	Ruft ein Objekt ab, das einen Bereich darstellt, der aus dem angegebenen Bereich versetzt ist. Die Dimension des zurückgegebenen Bereichs entspricht diesem Bereich. Wenn der resultierende Bereich außerhalb des Arbeitsblatt-Rasters erzwungen wird, wird ein Fehler ausgelöst.
getPivotTables(fullyContained)	Ruft eine bereichsbezogene Auflistung von PivotTables ab, die sich mit dem Bereich überschneiden.
getPrecedents()	Gibt ein `WorkbookRangeAreas` Objekt zurück, das den Bereich darstellt, der alle vorhergehenden Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder auf mehreren Arbeitsblättern enthält. Gibt einen `ItemNotFound` Fehler aus, wenn keine Präzedenzfälle gefunden werden.
getRangeEdge(direction, activeCell)	Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.
getRangeEdge(direction, activeCell)	Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.
getResizedRange(deltaRows, deltaColumns)	Ruft ein `Range` Objekt ab, das dem aktuellen `Range` Objekt ähnelt, aber mit einer vergrößerten unteren rechten Ecke um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder zusammengezogen).
getRow(row)	Ruft eine Zelle ab, die im Bereich enthalten ist.
getRowProperties(rowPropertiesLoadOptions)	Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zeile kapselt. Für Eigenschaften, die nicht in jeder Zelle innerhalb einer bestimmten Zeile konsistent sind, `null` werden zurückgegeben.
getRowsAbove(count)	Ruft eine bestimmte Anzahl von Zeilen über dem aktuellen `Range` Objekt ab.
getRowsBelow(count)	Ruft eine bestimmte Anzahl von Zeilen unterhalb des aktuellen `Range` Objekts ab.
getSpecialCells(cellType, cellValueType)	Ruft das `RangeAreas` Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein `ItemNotFound` Fehler ausgelöst.
getSpecialCells(cellType, cellValueType)	Ruft das `RangeAreas` Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein `ItemNotFound` Fehler ausgelöst.
getSpecialCellsOrNullObject(cellType, cellValueType)	Ruft das `RangeAreas` Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpecialCellsOrNullObject(cellType, cellValueType)	Ruft das `RangeAreas` Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpillingToRange()	Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. Schlägt bei Anwendung auf einen Bereich mit mehr als einer Zelle fehl.
getSpillingToRangeOrNullObject()	Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. Wenn der Bereich keine Ankerzelle ist oder der Überlaufbereich nicht gefunden werden kann, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpillParent()	Ruft das Bereichsobjekt ab, das die Ankerzelle für eine Zelle enthält, in die ein Überlauf erfolgen kann. Schlägt bei Anwendung auf einen Bereich mit mehr als einer Zelle fehl.
getSpillParentOrNullObject()	Ruft das Bereichsobjekt ab, das die Ankerzelle enthält, in die die Zelle überläuft. Wenn es sich nicht um eine übergelaufene Zelle handelt oder mehr als eine Zelle angegeben ist, dann gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSurroundingRegion()	Gibt ein `Range` Objekt zurück, das den umgebenden Bereich für die obere linke Zelle in diesem Bereich darstellt. Eine umgebende Region ist ein Bereich, der von einer Kombination von leeren Zeilen und leeren Spalten relativ zu diesem Bereich begrenzt wird.
getTables(fullyContained)	Ruft eine bereichsbezogene Sammlung von Tabellen ab, die sich mit dem Bereich überschneidet.
getUsedRange(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, löst diese Funktion einen `ItemNotFound` Fehler aus.
getUsedRangeOrNullObject(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, gibt diese Methode ein Objekt zurück, dessen `isNullObject` Eigenschaft auf festgelegt ist `true`. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getVisibleView()	Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.
group(groupOption)	Gruppiert Spalten und Zeilen für eine Gliederung.
group(groupOption)	Gruppiert Spalten und Zeilen für eine Gliederung.
hideGroupDetails(groupOption)	Blendet die Details der Zeile oder Spaltengruppe aus.
hideGroupDetails(groupOption)	Blendet die Details der Zeile oder Spaltengruppe aus.
insert(shift)	Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues `Range` Objekt an dem jetzt leeren Bereich zurück.
insert(shift)	Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues `Range` Objekt an dem jetzt leeren Bereich zurück.
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.
merge(across)	Führt die Zellen des Bereichs in eine Region im Arbeitsblatt zusammen.
moveTo(destinationRange)	Verschiebt Zellwerte, Formatierungen und Formeln aus dem aktuellen Bereich in den Zielbereich und ersetzt die alten Informationen in diesen Zellen. Der Zielbereich wird automatisch erweitert, wenn er kleiner als der aktuelle Bereich ist. Zellen im Zielbereich, die außerhalb des ursprünglichen Bereichs liegen, werden nicht geändert. Hinweis: Wenn ein Bereich mit dieser API an eine neue Adresse verschoben wird, sollte das neue Bereichsobjekt mithilfe der neuen Adresse abgerufen werden.
removeDuplicates(columns, includesHeader)	Entfernt doppelte Werte aus dem durch die Spalten angegebenen Bereich.
replaceAll(text, replacement, criteria)	Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der im aktuellen Bereich angegebenen Kriterien.
select()	Wählt den angegebenen Bereich in der Excel-Benutzeroberfläche aus.
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.
setCellProperties(cellPropertiesData)	Updates den Bereich basierend auf einem 2D-Array von Zelleigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.
setColumnProperties(columnPropertiesData)	Updates den Bereich basierend auf einem eindimensionalen Array von Spalteneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.
setDirty()	Legt für einen Bereich Neuberechnung bei der nächsten auszuführenden Neuberechnung fest.
setRowProperties(rowPropertiesData)	Updates den Bereich basierend auf einem eindimensionalen Array von Zeileneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.
showCard()	Zeigt die Karte für eine aktive Zelle an, wenn sie einen hohen Wertinhalt hat.
showGroupDetails(groupOption)	Zeigt die Details der Zeile oder Spaltengruppe an.
showGroupDetails(groupOption)	Zeigt die Details der Zeile oder Spaltengruppe an.
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 sie übergeben wird.) Während das ursprüngliche `Excel.Range` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `Excel.Interfaces.RangeData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend `.sync` und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde.
ungroup(groupOption)	Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.
ungroup(groupOption)	Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.
unmerge()	Hebt den Zellverbund des Bereichs in einzelne Zellen auf.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

address

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

readonly address: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.1]

addressLocal

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

readonly addressLocal: string;

Eigenschaftswert

string

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.

readonly cellCount: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.1]

columnCount

Gibt die Gesamtanzahl der Spalten im Bereich an.

readonly columnCount: number;

Eigenschaftswert

number

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.

readonly columnIndex: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.1]

conditionalFormats

Die Sammlung dieser ConditionalFormats Schnittmenge den Bereich.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Excel.ConditionalFormatCollection

Hinweise

[API-Satz: ExcelApi 1.6]

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

control

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

control: CellControl;

Eigenschaftswert

Excel.CellControl

Hinweise

[API-Satz: ExcelApi 1.18]

dataValidation

Gibt ein Datenüberprüfungsobjekt zurück.

readonly dataValidation: Excel.DataValidation;

Eigenschaftswert

Excel.DataValidation

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.

readonly format: Excel.RangeFormat;

Eigenschaftswert

Excel.RangeFormat

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: any[][];

Eigenschaftswert

any[][]

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: any[][];

Eigenschaftswert

any[][]

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: any[][];

Eigenschaftswert

any[][]

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.

readonly 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.

readonly height: number;

Eigenschaftswert

number

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.

readonly hidden: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.2]

hyperlink

Stellt den Hyperlink für den aktuellen Bereich dar.

hyperlink: Excel.RangeHyperlink;

Eigenschaftswert

Excel.RangeHyperlink

Hinweise

[API-Satz: ExcelApi 1.7]

isEntireColumn

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

readonly isEntireColumn: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.7]

isEntireRow

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

readonly 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.

readonly left: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.10]

linkedDataTypeState

Stellt den Datentypstatus der einzelnen Zellen dar.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Eigenschaftswert

Excel.LinkedDataTypeState[][]

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: any[][];

Eigenschaftswert

any[][]

Hinweise

[API-Satz: ExcelApi 1.1]

numberFormatCategories

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

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Eigenschaftswert

Excel.NumberFormatCategory[][]

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: any[][];

Eigenschaftswert

any[][]

Hinweise

[API-Satz: ExcelApi 1.7]

rowCount

Gibt die Anzahl der Zeilen im Bereich zurück.

readonly rowCount: number;

Eigenschaftswert

number

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.

readonly rowIndex: number;

Eigenschaftswert

number

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.

readonly savedAsArray: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.12]

sort

Stellt die Bereichssortierung des aktuellen Bereichs dar.

readonly sort: Excel.RangeSort;

Eigenschaftswert

Excel.RangeSort

Hinweise

[API-Satz: ExcelApi 1.2]

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: string;

Eigenschaftswert

string

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.

readonly text: string[][];

Eigenschaftswert

string[][]

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.

readonly top: number;

Eigenschaftswert

number

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. Gebietsschemaförmige Zeichenfolgen (z. B. das Datum "19-8-2025" in nl-NL oder fr-FR, Format TT-MM-JJJJ) werden als Text statt als Datumsangaben gespeichert. Um sicherzustellen, dass Datumsangaben als Datumsangaben gespeichert werden, verwenden Sie eine gebietsschemaabhängige API wie formulasLocal oder ein gebietsschemaneutrales Format wie ISO (JJJJ-MM-TT) oder eine numerische Datumsreihe.

values: any[][];

Eigenschaftswert

any[][]

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: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

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: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

Hinweise

[API-Satz: ExcelApi 1.16]

valueTypes

Gibt den Datentyp in jeder Zelle an.

readonly valueTypes: Excel.RangeValueType[][];

Eigenschaftswert

Excel.RangeValueType[][]

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.

readonly width: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.10]

worksheet

Das Arbeitsblatt, das den aktuellen Bereich enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

[API-Satz: ExcelApi 1.1]

autoFill(destinationRange, autoFillType)

Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein null oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt.

Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.

autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;

Parameter

destinationRange: Excel.Range | string

Der Zielbereich für AutoFill. Wenn der Zielbereich ist null, werden die Daten basierend auf den umgebenden Zellen ausgefüllt (dies ist das Verhalten beim Doppelklicken auf das Bereichsfüllkästchen der Benutzeroberfläche).

autoFillType: Excel.AutoFillType

Der Typ des AutoAusfüllens. Gibt an, wie der Zielbereich auf der Grundlage des Inhalts des aktuellen Bereichs gefüllt werden soll. Der Standardwert ist "FillDefault".

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9, ExcelApi-Vorschau für NULL destinationRange]

autoFill(destinationRange, autoFillType)

Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein null oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt.

Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Parameter

destinationRange: Excel.Range | string

Der Zielbereich für AutoFill. Wenn der Zielbereich ist null, werden die Daten basierend auf den umgebenden Zellen ausgefüllt (dies ist das Verhalten beim Doppelklicken auf das Bereichsfüllkästchen der Benutzeroberfläche).

autoFillType: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

Der Typ des AutoAusfüllens. Gibt an, wie der Zielbereich auf der Grundlage des Inhalts des aktuellen Bereichs gefüllt werden soll. Der Standardwert ist "FillDefault".

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9, ExcelApi-Vorschau für NULL destinationRange]

calculate()

Berechnet einen Zellbereich auf einem Arbeitsblatt.

calculate(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.6]

clear(applyTo)

Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.

clear(applyTo?: Excel.ClearApplyTo): void;

Parameter

applyTo: Excel.ClearApplyTo

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen findest du hier Excel.ClearApplyTo .

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.1]

clear(applyTo)

Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Parameter

applyTo: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Parameter

serviceID: number

Die Dienst-ID, die zum Abfragen der Daten verwendet wird.

languageCulture: string

Sprachkultur, nach der der Dienst abgefragt werden soll.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Parameter

sourceRange: Excel.Range | Excel.RangeAreas | string

Der Quellbereich oder RangeAreas aus dem kopiert werden soll. Wenn die Quelle RangeAreas mehrere Bereiche enthält, muss deren Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyType: Excel.RangeCopyType

Der Typ der Zelldaten oder Formatierungen, die kopiert werden sollen. Der Standardwert ist "Alle".

skipBlanks: boolean

WAHR, wenn leere Zellen im Quellbereich übersprungen werden sollen. Der Standardwert ist „false“.

transpose: boolean

WAHR, wenn die Zellen im Zielbereich transponiert werden sollen. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;

Parameter

sourceRange: Excel.Range | Excel.RangeAreas | string

Der Quellbereich oder RangeAreas aus dem kopiert werden soll. Wenn die Quelle RangeAreas mehrere Bereiche enthält, muss deren Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyType: "All" | "Formulas" | "Values" | "Formats" | "Link"

Der Typ der Zelldaten oder Formatierungen, die kopiert werden sollen. Der Standardwert ist "Alle".

skipBlanks: boolean

WAHR, wenn leere Zellen im Quellbereich übersprungen werden sollen. Der Standardwert ist „false“.

transpose: boolean

WAHR, wenn die Zellen im Zielbereich transponiert werden sollen. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

delete(shift)

Löscht die dem Bereich zugeordneten Zellen.

delete(shift: Excel.DeleteShiftDirection): void;

Parameter

shift: Excel.DeleteShiftDirection

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen findest du hier Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.1]

delete(shift)

Löscht die dem Bereich zugeordneten Zellen.

delete(shift: "Up" | "Left"): void;

Parameter

shift: "Up" | "Left"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen findest du hier Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.1]

find(text, criteria)

Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle.

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parameter

text: string

Die zu suchende Zeichenfolge.

criteria: Excel.SearchCriteria

Zusätzliche Suchkriterien, einschließlich der Suchrichtung und ob die Suche mit der gesamten Zelle übereinstimmen oder die Groß-/Kleinschreibung beachten muss.

Gibt zurück

Excel.Range

Das Range Objekt, das die erste Zelle darstellt, die einen Wert enthält, der dem Suchtext und den Suchkriterien entspricht.

Hinweise

[API-Satz: ExcelApi 1.9]

findOrNullObject(text, criteria)

Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parameter

text: string

Die zu suchende Zeichenfolge.

criteria: Excel.SearchCriteria

Zusätzliche Suchkriterien, einschließlich der Suchrichtung und ob die Suche mit der gesamten Zelle übereinstimmen oder die Groß-/Kleinschreibung beachten muss.

Gibt zurück

Excel.Range

Die Range den Suchkriterien entsprachen.

Hinweise

[API-Satz: ExcelApi 1.9]

flashFill()

Führt eine Blitzvorschau auf den aktuellen Bereich aus. Die Blitzvorschau füllt Daten automatisch aus, wenn sie ein Muster erkennt. Daher muss es sich bei dem Bereich um einen Bereich mit einer einzelnen Spalte handeln, der von Daten umgeben ist, um ein Muster zu finden.

flashFill(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

getAbsoluteResizedRange(numRows, numColumns)

Ruft ein Range Objekt mit derselben Zelle oben links wie das aktuelle Range Objekt ab, jedoch mit der angegebenen Anzahl von Zeilen und Spalten.

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

Parameter

numRows: number

Die Anzahl der Zeilen der neuen Bereichsgröße.

numColumns: number

Die Anzahl der Spalten der neuen Bereichsgröße.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.7]

getBoundingRect(anotherRange)

Ruft das kleinste Bereichsobjekt ab, das die angegebenen Bereiche umfasst. Beispielsweise ist die GetBoundingRect von "B2:C5" und "D10:E15" "B2:E15".

getBoundingRect(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

Das Bereichsobjekt, die Adresse oder der Bereichsname.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getCell(row, column)

Ruft das Bereichsobjekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltenanzahl enthält. Die Zelle kann sich außerhalb der Grenzen des übergeordneten Bereichs befinden, solange sie innerhalb des Arbeitsblattrasters bleibt. Die zurückgegebene Zelle befindet sich relativ zur obersten linken Zelle des Bereichs.

getCell(row: number, column: number): Excel.Range;

Parameter

row: number

Zeilenanzahl der abzurufenden Zelle. Nullindiziert.

column: number

Spaltenanzahl der abzurufenden Zelle. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getCellProperties(cellPropertiesLoadOptions)

Gibt ein 2D-Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zelle kapselt.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parameter

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Ein Objekt, das darstellt, welche Zelleigenschaften geladen werden sollen.

Gibt zurück

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Ein 2D-Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Zelle darstellt.

Hinweise

[API-Satz: ExcelApi 1.9]

getColumn(column)

Ruft eine Spalte ab, die im Bereich enthalten ist.

getColumn(column: number): Excel.Range;

Parameter

column: number

Spaltenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getColumnProperties(columnPropertiesLoadOptions)

Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Spalte kapselt. Für Eigenschaften, die innerhalb einer bestimmten Spalte nicht für alle Zellen konsistent sind, wird NULL zurückgegeben.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Parameter

columnPropertiesLoadOptions: Excel.ColumnPropertiesLoadOptions

Ein Objekt, das darstellt, welche Spalteneigenschaften geladen werden sollen.

Gibt zurück

OfficeExtension.ClientResult<Excel.ColumnProperties[]>

Ein Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Spalte darstellt.

Hinweise

[API-Satz: ExcelApi 1.9]

getColumnsAfter(count)

Ruft eine bestimmte Anzahl von Spalten rechts neben dem aktuellen Range Objekt ab.

getColumnsAfter(count?: number): Excel.Range;

Parameter

count: number

Optional. Die Anzahl von Spalten, die in den Ergebnisbereich aufgenommen werden soll. Grundsätzlich verwenden Sie eine positive Zahl, um einen Bereich außerhalb des aktuellen Bereichs zu erstellen. Sie können auch eine negative Zahl verwenden, um einen Bereich innerhalb des aktuellen Bereichs zu erstellen. Der Standardwert ist 1.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.2]

getColumnsBefore(count)

Ruft eine bestimmte Anzahl von Spalten links vom aktuellen Range Objekt ab.

getColumnsBefore(count?: number): Excel.Range;

Parameter

count: number

getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parameter

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Ein Objekt, das darstellt, welche Zelleigenschaften geladen werden sollen.

Gibt zurück

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Ein 2D-Array, in dem jedes Element die angeforderten Anzeigeeigenschaften der entsprechenden Zelle darstellt.

Hinweise

[API-Satz: ExcelApi 1.19]

getEntireColumn()

Ruft ein Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. die Zellen "B4:E11" darstellt, ist es getEntireColumn ein Bereich, der die Spalten "B:E" darstellt).

getEntireColumn(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getEntireRow()

Ruft ein Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. die Zellen "B4:E11" darstellt, ist dies GetEntireRow ein Bereich, der die Zeilen "4:11" darstellt).

getEntireRow(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getExtendedRange(direction, activeCell)

Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parameter

direction: Excel.KeyboardDirection

Die Richtung von der aktiven Zelle.

activeCell: Excel.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die obere linke Zelle des Bereichs die aktive Zelle. Ein Fehler wird ausgelöst, wenn sich die aktive Zelle außerhalb dieses Bereichs befindet.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.13]

getExtendedRange(direction, activeCell)

Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parameter

direction: "Left" | "Right" | "Up" | "Down"

Die Richtung von der aktiven Zelle.

activeCell: Excel.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die obere linke Zelle des Bereichs die aktive Zelle. Ein Fehler wird ausgelöst, wenn sich die aktive Zelle außerhalb dieses Bereichs befindet.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.13]

getImage()

Rendert den Bereich als Base64-codiertes PNG-Bild.

getImage(): OfficeExtension.ClientResult<string>;

Gibt zurück

OfficeExtension.ClientResult<string>

Hinweise

[API-Satz: ExcelApi 1.7]

getIntersection(anotherRange)

Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt.

getIntersection(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

Das Bereichsobjekt oder die Bereichsadresse, die verwendet wird, um die Schnittmenge der Bereiche zu ermitteln.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getIntersectionOrNullObject(anotherRange)

Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

Parameter

rowOffset: number

Die Anzahl der Zeilen (positiv, negativ oder 0), um die der Bereich versetzt werden soll. Bei positiven Werten erfolgt der Versatz nach unten, bei negativen Werten nach oben.

columnOffset: number

Die Anzahl der Spalten (positiv, negativ oder 0), um die der Bereich versetzt werden soll. Bei positiven Werten erfolgt der Versatz nach rechts, bei negativen Werten nach links.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getPivotTables(fullyContained)

Ruft eine bereichsbezogene Auflistung von PivotTables ab, die sich mit dem Bereich überschneiden.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Parameter

fullyContained: boolean

If truegibt nur PivotTables zurück, die vollständig innerhalb der Bereichsgrenzen enthalten sind. Der Standardwert ist false.

Gibt zurück

Excel.PivotTableScopedCollection

Hinweise

[API-Satz: ExcelApi 1.12]

getPrecedents()

Gibt ein WorkbookRangeAreas Objekt zurück, das den Bereich darstellt, der alle vorhergehenden Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder auf mehreren Arbeitsblättern enthält. Gibt einen ItemNotFound Fehler aus, wenn keine Präzedenzfälle gefunden werden.

getPrecedents(): Excel.WorkbookRangeAreas;

Gibt zurück

Excel.WorkbookRangeAreas

Hinweise

[API-Satz: ExcelApi 1.14]

getRangeEdge(direction, activeCell)

Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parameter

direction: Excel.KeyboardDirection

Die Richtung von der aktiven Zelle.

activeCell: Excel.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die obere linke Zelle des Bereichs die aktive Zelle. Ein Fehler wird ausgelöst, wenn sich die aktive Zelle außerhalb dieses Bereichs befindet.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.13]

getRangeEdge(direction, activeCell)

Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parameter

direction: "Left" | "Right" | "Up" | "Down"

Die Richtung von der aktiven Zelle.

activeCell: Excel.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die obere linke Zelle des Bereichs die aktive Zelle. Ein Fehler wird ausgelöst, wenn sich die aktive Zelle außerhalb dieses Bereichs befindet.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.13]

getResizedRange(deltaRows, deltaColumns)

Ruft ein Range Objekt ab, das dem aktuellen Range Objekt ähnelt, aber mit einer vergrößerten unteren rechten Ecke um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder zusammengezogen).

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

Parameter

deltaRows: number

Die Anzahl von Zeilen, um die die untere rechte Ecke relativ zum aktuellen Bereich zu erweitern ist. Verwenden Sie eine positive Zahl, um den Bereich zu erweitern, oder eine negative Zahl, um ihn zu verkleinern.

deltaColumns: number

Die Anzahl der Spalten, um die die untere rechte Ecke relativ zum aktuellen Bereich erweitert werden soll. Verwenden Sie eine positive Zahl, um den Bereich zu erweitern, oder eine negative Zahl, um ihn zu verkleinern.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.2]

getRow(row)

Ruft eine Zelle ab, die im Bereich enthalten ist.

getRow(row: number): Excel.Range;

Parameter

row: number

Zeilenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getRowProperties(rowPropertiesLoadOptions)

Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zeile kapselt. Für Eigenschaften, die nicht in jeder Zelle innerhalb einer bestimmten Zeile konsistent sind, null werden zurückgegeben.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Parameter

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

Ein Objekt, das darstellt, welche Zeileneigenschaften geladen werden sollen.

Gibt zurück

OfficeExtension.ClientResult<Excel.RowProperties[]>

Ein Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Zeile darstellt.

Hinweise

[API-Satz: ExcelApi 1.9]

getRowsAbove(count)

Ruft eine bestimmte Anzahl von Zeilen über dem aktuellen Range Objekt ab.

getRowsAbove(count?: number): Excel.Range;

Parameter

count: number

Optional. Die Anzahl von Zeilen, die in den Ergebnisbereich aufgenommen werden soll. Grundsätzlich verwenden Sie eine positive Zahl, um einen Bereich außerhalb des aktuellen Bereichs zu erstellen. Sie können auch eine negative Zahl verwenden, um einen Bereich innerhalb des aktuellen Bereichs zu erstellen. Der Standardwert ist 1.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.2]

getRowsBelow(count)

Ruft eine bestimmte Anzahl von Zeilen unterhalb des aktuellen Range Objekts ab.

getRowsBelow(count?: number): Excel.Range;

Parameter

count: number

Optional. Die Anzahl von Zeilen, die in den Ergebnisbereich aufgenommen werden soll. Grundsätzlich verwenden Sie eine positive Zahl, um einen Bereich außerhalb des aktuellen Bereichs zu erstellen. Sie können auch eine negative Zahl verwenden, um einen Bereich innerhalb des aktuellen Bereichs zu erstellen. Der Standardwert ist 1.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.2]

getSpecialCells(cellType, cellValueType)

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein ItemNotFound Fehler ausgelöst.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parameter

cellType: Excel.SpecialCellType

Der einzubeziehende Zelltyp.

cellValueType: Excel.SpecialCellValueType

Wenn cellType ist entweder constants oder formulas, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Excel.RangeAreas

Hinweise

[API-Satz: ExcelApi 1.9]

getSpecialCells(cellType, cellValueType)

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein ItemNotFound Fehler ausgelöst.

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parameter

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Der einzubeziehende Zelltyp.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Wenn cellType ist entweder constants oder formulas, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Excel.RangeAreas

Hinweise

[API-Satz: ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parameter

cellType: Excel.SpecialCellType

Der einzubeziehende Zelltyp.

cellValueType: Excel.SpecialCellValueType

Wenn cellType ist entweder constants oder formulas, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Excel.RangeAreas

Hinweise

[API-Satz: ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parameter

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Der einzubeziehende Zelltyp.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parameter

fullyContained: boolean

If truegibt nur Tabellen zurück, die vollständig innerhalb der Bereichsgrenzen enthalten sind. Der Standardwert ist false.

Gibt zurück

Excel.TableScopedCollection

Hinweise

[API-Satz: ExcelApi 1.9]

getUsedRange(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, löst diese Funktion einen ItemNotFound Fehler aus.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Betrachtet nur Zellen mit Werten als verwendet. [API-Satz: ExcelApi 1.2]

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

getUsedRangeOrNullObject(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Betrachtet nur Zellen mit Werten als verwendet.

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.4]

getVisibleView()

Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.

getVisibleView(): Excel.RangeView;

Gibt zurück

Excel.RangeView

Hinweise

[API-Satz: ExcelApi 1.3]

group(groupOption)

Gruppiert Spalten und Zeilen für eine Gliederung.

group(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

Gibt an, wie der Bereich nach Zeilen oder Spalten gruppiert werden kann. Ein InvalidArgument Fehler wird ausgelöst, wenn die Gruppierungsoption von der ODER-Eigenschaft isEntireColumn des isEntireRow Bereichs abweicht (d. h. range.isEntireRow ist wahr und groupOption ist "NachSpalten" oder range.isEntireColumn ist wahr und groupOption ist "NachZeilen").

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

group(groupOption)

Gruppiert Spalten und Zeilen für eine Gliederung.

group(groupOption: "ByRows" | "ByColumns"): void;

Parameter

groupOption: "ByRows" | "ByColumns"

Gibt an, wie der Bereich nach Zeilen oder Spalten gruppiert werden kann. Ein InvalidArgument Fehler wird ausgelöst, wenn die Gruppierungsoption von der ODER-Eigenschaft isEntireColumn des isEntireRow Bereichs abweicht (d. h. range.isEntireRow ist wahr und groupOption ist "NachSpalten" oder range.isEntireColumn ist wahr und groupOption ist "NachZeilen").

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

hideGroupDetails(groupOption)

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

Gibt an, ob die Details von gruppierten Zeilen oder gruppierten Spalten ausgeblendet werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

hideGroupDetails(groupOption)

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parameter

groupOption: "ByRows" | "ByColumns"

Gibt an, ob die Details von gruppierten Zeilen oder gruppierten Spalten ausgeblendet werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

insert(shift)

Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues Range Objekt an dem jetzt leeren Bereich zurück.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Parameter

shift: Excel.InsertShiftDirection

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen findest du hier Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

insert(shift)

Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues Range Objekt an dem jetzt leeren Bereich zurück.

insert(shift: "Down" | "Right"): Excel.Range;

Parameter

shift: "Down" | "Right"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen findest du hier Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

[API-Satz: ExcelApi 1.1]

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.RangeLoadOptions): Excel.Range;

Parameter

options: Excel.Interfaces.RangeLoadOptions

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

Gibt zurück

Excel.Range

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

Excel.Range

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

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

Excel.Range

merge(across)

Führt die Zellen des Bereichs in eine Region im Arbeitsblatt zusammen.

merge(across?: boolean): void;

Parameter

across: boolean

Optional. Legen Sie diese Einstellung fest, true um Zellen in jeder Zeile des angegebenen Bereichs als separate verbundene Zellen zu verbinden. Der Standardwert ist false.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2]

moveTo(destinationRange)

Verschiebt Zellwerte, Formatierungen und Formeln aus dem aktuellen Bereich in den Zielbereich und ersetzt die alten Informationen in diesen Zellen. Der Zielbereich wird automatisch erweitert, wenn er kleiner als der aktuelle Bereich ist. Zellen im Zielbereich, die außerhalb des ursprünglichen Bereichs liegen, werden nicht geändert. Hinweis: Wenn ein Bereich mit dieser API an eine neue Adresse verschoben wird, sollte das neue Bereichsobjekt mithilfe der neuen Adresse abgerufen werden.

moveTo(destinationRange: Range | string): void;

Parameter

destinationRange: Excel.Range | string

destinationRange Gibt den Bereich an, in den die Informationen in diesem Bereich verschoben werden.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.11]

removeDuplicates(columns, includesHeader)

Entfernt doppelte Werte aus dem durch die Spalten angegebenen Bereich.

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

Parameter

columns: number[]

Die Spalten innerhalb des Bereichs, die Duplikate enthalten können. Mindestens eine Spalte muss angegeben werden. Nullindiziert.

includesHeader: boolean

TRUE, wenn die Eingabedaten einen Header enthalten. Der Standardwert ist „false“.

Gibt zurück

Excel.RemoveDuplicatesResult

Das resultierende Objekt, das die Anzahl der entfernten Zeilen und die Anzahl der verbleibenden eindeutigen Zeilen enthält.

Hinweise

[API-Satz: ExcelApi 1.9]

replaceAll(text, replacement, criteria)

Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der im aktuellen Bereich angegebenen Kriterien.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parameter

text: string

Zu findende Zeichenfolge.

replacement: string

Die Zeichenfolge, die die ursprüngliche Zeichenfolge ersetzt.

criteria: Excel.ReplaceCriteria

Zusätzliche Ersetzungskriterien.

Gibt zurück

OfficeExtension.ClientResult<number>

Die Anzahl der durchgeführten Ersetzungen.

Hinweise

[API-Satz: ExcelApi 1.9]

select()

Wählt den angegebenen Bereich in der Excel-Benutzeroberfläche aus.

select(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.1]

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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.RangeUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.Range): void;

Parameter

properties: Excel.Range

Gibt zurück

void

setCellProperties(cellPropertiesData)

Updates den Bereich basierend auf einem 2D-Array von Zelleigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Parameter

cellPropertiesData: Excel.SettableCellProperties[][]

Ein 2D-Array, das darstellt, welche Eigenschaften in jeder Zelle festgelegt werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

setColumnProperties(columnPropertiesData)

Updates den Bereich basierend auf einem eindimensionalen Array von Spalteneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parameter

columnPropertiesData: Excel.SettableColumnProperties[]

Ein Array, das angibt, welche Eigenschaften in jeder Spalte festgelegt werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

setDirty()

Legt für einen Bereich Neuberechnung bei der nächsten auszuführenden Neuberechnung fest.

setDirty(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

setRowProperties(rowPropertiesData)

Updates den Bereich basierend auf einem eindimensionalen Array von Zeileneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Parameter

rowPropertiesData: Excel.SettableRowProperties[]

Ein Array, das angibt, welche Eigenschaften in jeder Zeile festgelegt werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9]

showCard()

Zeigt die Karte für eine aktive Zelle an, wenn sie einen hohen Wertinhalt hat.

showCard(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.7]

showGroupDetails(groupOption)

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

Gibt an, ob die Details von gruppierten Zeilen oder gruppierten Spalten angezeigt werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

showGroupDetails(groupOption)

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parameter

groupOption: "ByRows" | "ByColumns"

Gibt an, ob die Details von gruppierten Zeilen oder gruppierten Spalten angezeigt werden sollen.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

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

toJSON(): Excel.Interfaces.RangeData;

Gibt zurück

Excel.Interfaces.RangeData

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde.

track(): Excel.Range;

Gibt zurück

Excel.Range

ungroup(groupOption)

Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.

ungroup(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

Gibt an, wie der Bereich nach Zeilen oder Spalten unterteilt werden kann.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

ungroup(groupOption)

Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Parameter

groupOption: "ByRows" | "ByColumns"

Gibt an, wie der Bereich nach Zeilen oder Spalten unterteilt werden kann.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.10]

unmerge()

Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

unmerge(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.2]

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Eigenschaften

Methoden

Details zur Eigenschaft

address

Eigenschaftswert

Hinweise

addressLocal

Eigenschaftswert

Hinweise

cellCount

Eigenschaftswert

Hinweise

columnCount

Eigenschaftswert

Hinweise

columnHidden

Eigenschaftswert

Hinweise

columnIndex

Eigenschaftswert

Hinweise

conditionalFormats

Eigenschaftswert

Hinweise

context

Eigenschaftswert

control

Eigenschaftswert

Hinweise

dataValidation

Eigenschaftswert

Hinweise

format

Eigenschaftswert

Hinweise

formulas

Eigenschaftswert

Hinweise

formulasLocal

Eigenschaftswert

Hinweise

formulasR1C1

Eigenschaftswert

Hinweise

hasSpill

Eigenschaftswert

Hinweise

height

Eigenschaftswert

Hinweise

hidden

Eigenschaftswert

Hinweise

hyperlink

Eigenschaftswert

Hinweise

isEntireColumn

Eigenschaftswert

Hinweise

isEntireRow

Eigenschaftswert

Hinweise

left

Eigenschaftswert

Hinweise

linkedDataTypeState

Eigenschaftswert

Hinweise

numberFormat

Eigenschaftswert

Hinweise

numberFormatCategories

Eigenschaftswert

Hinweise

numberFormatLocal

Eigenschaftswert

Hinweise

rowCount