Excel. Range class

Beispiele

// Get a Range object by its address.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

Eigenschaften

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.
conditionalFormats	Die Auflistung von `ConditionalFormats` , die den Bereich überschneidet.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
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.
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` 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.
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.

Methoden

autoFill(destinationRange, autoFillType)	Füllt einen Bereich vom aktuellen Bis zum Zielbereich unter Verwendung der angegebenen AutoFill-Logik aus. Der Zielbereich kann `null` sein oder den Quellbereich horizontal oder vertikal erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt. Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzausfüllen.
autoFill(destinationRange, autoFillTypeString)	Füllt einen Bereich vom aktuellen Bis zum Zielbereich unter Verwendung der angegebenen AutoFill-Logik aus. Der Zielbereich kann `null` sein oder den Quellbereich horizontal oder vertikal erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt. Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzausfüllen.
calculate()	Berechnet einen Zellbereich auf einem Arbeitsblatt.
clear(applyTo)	Löschen Sie Bereichswerte und Formatierungen, z. B. Füllung und Rahmen.
clear(applyToString)	Löschen Sie Bereichswerte und Formatierungen, z. B. Füllung und Rahmen.
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 aufweisen als der Quellbereich oder `RangeAreas`. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wenn der Zielbereich genau um ein Vielfaches größer als der Quellbereich in Zeilen oder Spalten ist, wird der Quellinhalt wie bei der Kopierfunktion in der Excel-Benutzeroberfläche mehrmals repliziert. Beispielsweise führt eine 2x2-Bereichskopie in einen 2x6-Bereich zu drei Kopien des ursprünglichen 2x2-Bereichs.
copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)	Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder `RangeAreas` in den aktuellen Bereich. Der Zielbereich kann eine andere Größe aufweisen als der Quellbereich oder `RangeAreas`. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wenn der Zielbereich genau um ein Vielfaches größer als der Quellbereich in Zeilen oder Spalten ist, wird der Quellinhalt wie bei der Kopierfunktion in der Excel-Benutzeroberfläche mehrmals repliziert. Beispielsweise führt eine 2x2-Bereichskopie in einen 2x6-Bereich zu drei Kopien des ursprünglichen 2x2-Bereichs.
delete(shift)	Löscht die dem Bereich zugeordneten Zellen.
delete(shiftString)	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 deckt die Suche das gesamte Blatt ab, das nach dieser Zelle beginnt.
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 deckt die Suche das gesamte Blatt ab, das nach dieser Zelle beginnt. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
flashFill()	Führt eine Blitzfüllung auf den aktuellen Bereich aus. Flash Fill füllt Daten automatisch aus, wenn sie ein Muster erkennt. Daher muss der Bereich ein einzelner Spaltenbereich sein und Daten um ihn herum enthalten, um ein Muster zu finden.
getAbsoluteResizedRange(numRows, numColumns)	Ruft ein `Range` -Objekt mit der gleichen oberen linken Zelle wie das aktuelle `Range` Objekt ab, aber 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 ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt. 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 vom aktuellen `Range` -Objekt ab.
getColumnsBefore(count)	Ruft eine bestimmte Anzahl von Spalten links vom aktuellen `Range` -Objekt ab.
getDirectPrecedents()	Gibt ein `WorkbookRangeAreas` -Objekt zurück, das den Bereich darstellt, der alle direkten Präzedenzzellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Hinweis: Diese API gibt einen `ItemNotFound` Fehler zurück, wenn keine Präzedenzfälle gefunden werden.
getEntireColumn()	Ruft ein -Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es `getEntireColumn` ein Bereich, der spalten "B:E") darstellt.
getEntireRow()	Ruft ein -Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es `GetEntireRow` ein Bereich, der die Zeilen "4:11" darstellt).
getImage()	Rendert den Bereich als Base64-codiertes PNG-Bild. Wichtig*: Diese API wird derzeit in Excel für Mac nicht unterstützt. Informationen zum aktuellen status finden Sie unter OfficeDev/office-js Issue #235.
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 `true`festgelegt ist. 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".
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 überlappen.
getResizedRange(deltaRows, deltaColumns)	Ruft ein `Range` -Objekt ab, das dem aktuellen `Range` -Objekt ähnelt, aber mit der unteren rechten Ecke, die um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder kontrahiert) ist.
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 in jeder Zelle innerhalb einer bestimmten Zeile nicht konsistent sind, `null` wird 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 einen oder mehrere rechteckige Bereiche umfasst und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein `ItemNotFound` Fehler ausgelöst.
getSpecialCells(cellTypeString, cellValueTypeString)	Ruft das `RangeAreas` -Objekt ab, das einen oder mehrere rechteckige Bereiche umfasst 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 einen oder mehrere Bereiche umfasst 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 `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	Ruft das `RangeAreas` -Objekt ab, das einen oder mehrere Bereiche umfasst 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 `true`festgelegt ist. 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 `true`festgelegt ist. 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 für die Zelle enthält, in die übergelaufen wird. Wenn es sich nicht um eine übergelaufene Zelle handelt oder mehr als eine Zelle angegeben ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. 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 innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, löst diese Funktion einen Fehler aus `ItemNotFound` .
getUsedRangeOrNullObject(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getVisibleView()	Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.
group(groupOption)	Gruppen Spalten und Zeilen für eine Gliederung.
group(groupOptionString)	Gruppen Spalten und Zeilen für eine Gliederung.
hideGroupDetails(groupOption)	Blendet die Details der Zeile oder Spaltengruppe aus.
hideGroupDetails(groupOptionString)	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 am jetzt leeren Platz zurück.
insert(shiftString)	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 am jetzt leeren Platz 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, wobei die alten Informationen in diesen Zellen ersetzt werden. Der Zielbereich wird automatisch erweitert, wenn er kleiner als der aktuelle Bereich ist. Alle Zellen im Zielbereich, die sich außerhalb des ursprünglichen Bereichs befinden, werden nicht geändert.
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 Zelleneigenschaften und kapselt Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung.
setColumnProperties(columnPropertiesData)	Updates den Bereich basierend auf einem eindimensionalen Array von Spalteneigenschaften und kapselt Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung.
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 und kapselt Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung.
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(groupOptionString)	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 das Objekt übergeben wird.) Während das ursprüngliche `Excel.Range` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.RangeData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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 über `.sync` Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.
ungroup(groupOption)	Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.
ungroup(groupOptionString)	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 aufrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

address

Gibt den Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").

readonly address: string;

Eigenschaftswert

string

Hinweise

addressLocal

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

readonly addressLocal: string;

Eigenschaftswert

string

Hinweise

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

columnCount

Gibt die Gesamtanzahl der Spalten im Bereich an.

readonly columnCount: number;

Eigenschaftswert

number

Hinweise

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

columnIndex

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

readonly columnIndex: number;

Eigenschaftswert

number

Hinweise

conditionalFormats

Die Auflistung von ConditionalFormats , die den Bereich überschneidet.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Excel.ConditionalFormatCollection

Hinweise

[ API-Satz: ExcelApi 1.6 ]

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

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

formulas

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

formulas: any[][];

Eigenschaftswert

any[][]

Hinweise

formulasLocal

Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

formulasLocal: any[][];

Eigenschaftswert

any[][]

Hinweise

formulasR1C1

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

formulasR1C1: any[][];

Eigenschaftswert

any[][]

Hinweise

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.

readonly hasSpill: boolean;

Eigenschaftswert

boolean

Hinweise

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.

readonly height: number;

Eigenschaftswert

number

Hinweise

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.

readonly hidden: boolean;

Eigenschaftswert

boolean

Hinweise

hyperlink

Stellt den Link für den aktuellen Bereich dar.

hyperlink: Excel.RangeHyperlink;

Eigenschaftswert

Excel.RangeHyperlink

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

isEntireColumn

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

readonly isEntireColumn: boolean;

Eigenschaftswert

boolean

Hinweise

isEntireRow

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

readonly isEntireRow: boolean;

Eigenschaftswert

boolean

Hinweise

left

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

readonly left: number;

Eigenschaftswert

number

Hinweise

linkedDataTypeState

Stellt den Datentypstatus der einzelnen Zellen dar.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Eigenschaftswert

Excel.LinkedDataTypeState[][]

Hinweise

numberFormat

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

numberFormat: any[][];

Eigenschaftswert

any[][]

Hinweise

Beispiele

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F5:G7";
    const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    const formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    await context.sync();
    
    console.log(range.text);
});

numberFormatCategories

Stellt die Kategorie des Zahlenformats jeder Zelle dar.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Eigenschaftswert

Excel.NumberFormatCategory[][]

Hinweise

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

Eigenschaftswert

any[][]

Hinweise

rowCount

Gibt die Anzahl der Zeilen im Bereich zurück.

readonly rowCount: number;

Eigenschaftswert

number

Hinweise

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

rowIndex

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

readonly rowIndex: number;

Eigenschaftswert

number

Hinweise

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.

readonly savedAsArray: boolean;

Eigenschaftswert

boolean

Hinweise

sort

Stellt die Bereichssortierung des aktuellen Bereichs dar.

readonly sort: Excel.RangeSort;

Eigenschaftswert

Excel.RangeSort

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

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

Eigenschaftswert

string

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

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.

readonly text: string[][];

Eigenschaftswert

string[][]

Hinweise

top

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

readonly top: number;

Eigenschaftswert

number

Hinweise

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

Eigenschaftswert

any[][]

Hinweise

valueTypes

Gibt den Datentyp in jeder Zelle an.

readonly valueTypes: Excel.RangeValueType[][];

Eigenschaftswert

Excel.RangeValueType[][]

Hinweise

width

Gibt den Abstand in Punkt für 100 % Zoom vom linken Rand des Bereichs bis zum rechten Rand des Bereichs zurück.

readonly width: number;

Eigenschaftswert

number

Hinweise

worksheet

Das Arbeitsblatt, das den aktuellen Bereich enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

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

Details zur Methode

autoFill(destinationRange, autoFillType)

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

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

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

Parameter

destinationRange: Excel.Range | string

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

autoFillType: Excel.AutoFillType

Der Typ von AutoAusfüllen. Gibt an, wie der Zielbereich basierend auf dem Inhalt des aktuellen Bereichs ausgefüllt werden soll. Der Standardwert ist "FillDefault".

Gibt zurück

void

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumCell = sheet.getRange("P4");
  
  // Copy everything. The formulas will be contextually updated based on their new locations.
  sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
  sumCell.format.autofitColumns();
  await context.sync();
});

autoFill(destinationRange, autoFillTypeString)

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

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

Parameter

destinationRange: Excel.Range | string

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

Der Typ von AutoAusfüllen. Gibt an, wie der Zielbereich basierend auf dem Inhalt des aktuellen Bereichs ausgefüllt werden soll. Der Standardwert ist "FillDefault".

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9, ExcelApi Preview 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 Sie Bereichswerte 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 finden Sie unter Excel.ClearApplyTo .

Gibt zurück

void

Hinweise

Beispiele

// Clear the format and contents of the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    await context.sync(); 
});

clear(applyToString)

Löschen Sie Bereichswerte und Formatierungen, z. B. Füllung und Rahmen.

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

Parameter

applyToString: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen finden Sie unter Excel.ClearApplyTo .

Gibt zurück

void

Hinweise

convertDataTypeToText()

Konvertiert die Bereichszellen mit Datentypen in Text.

convertDataTypeToText(): void;

Gibt zurück

void

Hinweise

convertToLinkedDataType(serviceID, languageCulture)

Konvertiert die Bereichszellen in verknüpfte Datentypen im Arbeitsblatt.

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 abfragt werden soll.

Gibt zurück

void

Hinweise

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 aufweisen als der Quellbereich oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wenn der Zielbereich genau um ein Vielfaches größer als der Quellbereich in Zeilen oder Spalten ist, wird der Quellinhalt wie bei der Kopierfunktion in der Excel-Benutzeroberfläche mehrmals repliziert. Beispielsweise führt eine 2x2-Bereichskopie in einen 2x6-Bereich zu drei 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 der zu kopierende Bereich. Wenn die Quelle RangeAreas über mehrere Bereiche verfügt, muss ihre Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyType: Excel.RangeCopyType

Der Typ der Zu kopierenden Zelldaten oder formatierungen. Der Standardwert ist "All".

skipBlanks: boolean

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

transpose: boolean

True, wenn die Zellen im Zielbereich transponieren sollen. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the copied data.
    sheet.getRange("F2").values = [["Copied Formula"]];

    // Copy a range preserving the formulas.
    // Note: non-formula values are copied over as is.
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

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

Parameter

sourceRange: Excel.Range | Excel.RangeAreas | string

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

Der Typ der Zu kopierenden Zelldaten oder formatierungen. Der Standardwert ist "All".

skipBlanks: boolean

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

transpose: boolean

True, wenn die Zellen im Zielbereich transponieren sollen. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

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 finden Sie unter Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    await context.sync(); 
});

delete(shiftString)

Löscht die dem Bereich zugeordneten Zellen.

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

Parameter

shiftString: "Up" | "Left"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

find(text, criteria)

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

Parameter

text: string

Die zu suchde Zeichenfolge.

criteria: Excel.SearchCriteria

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

Gibt zurück

Excel.Range

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

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const foundRange = searchRange.find($("#searchText").val().toString(), {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();


    console.log(foundRange.address);
});

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 deckt die Suche das gesamte Blatt ab, das nach dieser Zelle beginnt. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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

Parameter

text: string

Die zu suchde Zeichenfolge.

criteria: Excel.SearchCriteria

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

Gibt zurück

Excel.Range

Die Range , die den Suchkriterien entspricht.

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const foundRange = searchRange.findOrNullObject($("#searchText").val().toString(), {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

flashFill()

Führt eine Blitzfüllung auf den aktuellen Bereich aus. Flash Fill füllt Daten automatisch aus, wenn sie ein Muster erkennt. Daher muss der Bereich ein einzelner Spaltenbereich sein und Daten um ihn herum enthalten, um ein Muster zu finden.

flashFill(): void;

Gibt zurück

void

Hinweise

getAbsoluteResizedRange(numRows, numColumns)

Ruft ein Range -Objekt mit der gleichen oberen linken Zelle wie das aktuelle Range Objekt ab, aber 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

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

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:G6";
    let range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range = range.getBoundingRect("G4:H8");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // Prints Sheet1!D4:H8
});

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 ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt. 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

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

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 Zelleneigenschaften geladen werden sollen.

Gibt zurück

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

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

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Define the cell properties to get by setting the matching LoadOptions to true.
    const propertiesToGet = cell.getCellProperties({
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                color: true
            }
        },
        style: true
    });

    // Sync to get the data from the workbook.
    await context.sync();
    const cellProperties = propertiesToGet.value[0][0];
    console.log(
        `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});

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

OfficeExtension.ClientResult<Excel.ColumnProperties[]>

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet19";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    await context.sync();

    console.log(range.address); // prints Sheet1!B1:B8
});

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

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

Hinweise

getColumnsAfter(count)

Ruft eine bestimmte Anzahl von Spalten rechts vom 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

getColumnsBefore(count)

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

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

Parameter

count: number

Gibt zurück

Excel.Range

Hinweise

getDirectPrecedents()

Gibt ein WorkbookRangeAreas -Objekt zurück, das den Bereich darstellt, der alle direkten Präzedenzzellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Hinweis: Diese API gibt einen ItemNotFound Fehler zurück, wenn keine Präzedenzfälle gefunden werden.

getDirectPrecedents(): Excel.WorkbookRangeAreas;

Gibt zurück

Excel.WorkbookRangeAreas

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (let i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

getEntireColumn()

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

getEntireColumn(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    await context.sync();
    
    console.log(rangeEC.address);
});

getEntireRow()

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

getEntireRow(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "D:F"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeER = range.getEntireRow();
    rangeER.load('address');
    await context.sync();
    
    console.log(rangeER.address);
});

getImage()

Rendert den Bereich als Base64-codiertes PNG-Bild. Wichtig*: Diese API wird derzeit in Excel für Mac nicht unterstützt. Informationen zum aktuellen status finden Sie unter OfficeDev/office-js Issue #235.

getImage(): OfficeExtension.ClientResult<string>;

Gibt zurück

OfficeExtension.ClientResult<string>

Hinweise

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

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!D4:F6
});

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 truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getIntersectionOrNullObject(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.4 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getLastCell()

Ruft die letzte Zelle im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs „B2: D5“ „D5“.

getLastCell(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F8
});

getLastColumn()

Ruft die letzte Spalte im Bereich ab. Beispielsweise lautet die letzte Spalte von „B2:D5“ „D2:D5“.

getLastColumn(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F1:F8
});

getLastRow()

Ruft die letzte Zeile im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs "B2: D5" "B5:D5".

getLastRow(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A8:F8
});

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.

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

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:F6";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!H3:J5
});

getPivotTables(fullyContained)

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

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

Parameter

fullyContained: boolean

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

Gibt zurück

Excel.PivotTableScopedCollection

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  const activeRange = context.workbook.getSelectedRange();

  // Get all the PivotTables that intersect with this range.
  const partiallyContainedPivotTables = activeRange.getPivotTables();
  // Get all the PivotTables that are completely contained within this range.
  const fullyContainedPivotTables = activeRange.getPivotTables(true);

  partiallyContainedPivotTables.load("name");
  fullyContainedPivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current range:")
  partiallyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
  console.log("PivotTables completely contained in the current range:")
  fullyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

getResizedRange(deltaRows, deltaColumns)

Ruft ein Range -Objekt ab, das dem aktuellen Range -Objekt ähnelt, aber mit der unteren rechten Ecke, die um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder kontrahiert) ist.

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

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

OfficeExtension.ClientResult<Excel.RowProperties[]>

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A2:F2
});

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 in jeder Zelle innerhalb einer bestimmten Zeile nicht konsistent sind, null wird zurückgegeben.

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

Parameter

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

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

Gibt zurück

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

Hinweise

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

getRowsBelow(count)

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

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

Parameter

count: number

Gibt zurück

Excel.Range

Hinweise

getSpecialCells(cellType, cellValueType)

Ruft das RangeAreas -Objekt ab, das einen oder mehrere rechteckige Bereiche umfasst 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 Typ der einzuschließenden Zellen.

cellValueType: Excel.SpecialCellValueType

Wenn cellType entweder constants oder formulasist, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis eingeschlossen 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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

getSpecialCells(cellTypeString, cellValueTypeString)

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

Parameter

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

Der Typ der einzuschließenden Zellen.

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

Gibt zurück

Excel.RangeAreas

Hinweise

getSpecialCellsOrNullObject(cellType, cellValueType)

Ruft das RangeAreas -Objekt ab, das einen oder mehrere Bereiche umfasst 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 truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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

Parameter

cellType: Excel.SpecialCellType

Der Typ der einzuschließenden Zellen.

cellValueType: Excel.SpecialCellValueType

Gibt zurück

Excel.RangeAreas

Hinweise

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

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

Parameter

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

Der Typ der einzuschließenden Zellen.

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

Gibt zurück

Excel.RangeAreas

Hinweise

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.

getSpillingToRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/dynamic-arrays.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Set G4 to a formula that returns a dynamic array.
  const targetCell = sheet.getRange("G4");
  targetCell.formulas = [["=A4:D4"]];

  // Get the address of the cells that the dynamic array spilled into.
  const spillRange = targetCell.getSpillingToRange();
  spillRange.load("address");

  // Fit the columns for readability.
  sheet.getUsedRange().format.autofitColumns();
  await context.sync();

  console.log(`Copying the table headers spilled into ${spillRange.address}.`);
});

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 truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpillingToRangeOrNullObject(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

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.

getSpillParent(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

getSpillParentOrNullObject()

Ruft das Bereichsobjekt ab, das die Ankerzelle für die Zelle enthält, in die übergelaufen wird. Wenn es sich nicht um eine übergelaufene Zelle handelt oder mehr als eine Zelle angegeben ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpillParentOrNullObject(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

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.

getSurroundingRegion(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

getTables(fullyContained)

Ruft eine bereichsbezogene Sammlung von Tabellen ab, die sich mit dem Bereich überschneidet.

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

Parameter

fullyContained: boolean

Gibt truebei nur Tabellen zurück, die vollständig in den Bereichsgrenzen enthalten sind. Der Standardwert ist false.

Gibt zurück

Excel.TableScopedCollection

Hinweise

getUsedRange(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, löst diese Funktion einen Fehler aus ItemNotFound .

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getUsedRangeOrNullObject(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. 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 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

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)

Gruppen 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 sich die Gruppenoption von der -Eigenschaft oder isEntireColumn -Eigenschaft des Bereichs isEntireRow unterscheidet (d. h., range.isEntireRow ist true und groupOption ist "ByColumns" oder range.isEntireColumn true und groupOption ist "ByRows").

Gibt zurück

void

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // Group the larger, main level. Note that the outline controls
    // will be on row 10, meaning 4-9 will collapse and expand.
    sheet.getRange("4:9").group(Excel.GroupOption.byRows);

    // Group the smaller, sublevels. Note that the outline controls
    // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
    sheet.getRange("4:5").group(Excel.GroupOption.byRows);
    sheet.getRange("7:8").group(Excel.GroupOption.byRows);
    await context.sync();
});

group(groupOptionString)

Gruppen Spalten und Zeilen für eine Gliederung.

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

Parameter

groupOptionString: "ByRows" | "ByColumns"

Gibt zurück

void

Hinweise

hideGroupDetails(groupOption)

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

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

Gibt zurück

void

Hinweise

hideGroupDetails(groupOptionString)

Blendet die Details der Zeile oder Spaltengruppe aus.

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

Parameter

groupOptionString: "ByRows" | "ByColumns"

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

Gibt zurück

void

Hinweise

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 am jetzt leeren Platz zurück.

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

Parameter

shift: Excel.InsertShiftDirection

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert(Excel.InsertShiftDirection.down);
    await context.sync();
});

insert(shiftString)

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

Parameter

shiftString: "Down" | "Right"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Parameter

options: Excel.Interfaces.RangeLoadOptions

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

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

Beispiele

// Use the range address to get the range object.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8"; 
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

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 Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.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 fest true , um Zellen in jeder Zeile des angegebenen Bereichs als separate zusammengeführte Zellen zusammenzuführen. Der Standardwert ist false.

Gibt zurück

void

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.merge(true);
    await context.sync(); 
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Create a merged range in the first row of the table.
  const chartTitle = tableRange.getRow(0);
  chartTitle.merge(true);

  // Format the merged range.
  chartTitle.format.horizontalAlignment = "Center";

  await context.sync();
});

moveTo(destinationRange)

Verschiebt Zellwerte, Formatierungen und Formeln aus dem aktuellen Bereich in den Zielbereich, wobei die alten Informationen in diesen Zellen ersetzt werden. Der Zielbereich wird automatisch erweitert, wenn er kleiner als der aktuelle Bereich ist. Alle Zellen im Zielbereich, die sich außerhalb des ursprünglichen Bereichs befinden, werden nicht geändert.

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 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the moved data.
    sheet.getRange("F12").values = [["Moved Range:"]];

    // Move the range from A1:E1 to G12:K12.
    sheet.getRange("A1:E1").moveTo("G12");
    await context.sync();
});

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. Es muss mindestens eine Spalte angegeben werden. Nullindiziert.

includesHeader: boolean

True, wenn die Eingabedaten 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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

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

Zeichenfolge, die gesucht werden soll.

replacement: string

Die Zeichenfolge, die die ursprüngliche Zeichenfolge ersetzt.

criteria: Excel.ReplaceCriteria

Zusätzliche Ersatzkriterien.

Gibt zurück

OfficeExtension.ClientResult<number>

Die Anzahl der ausgeführten Ersetzungen.

Hinweise

select()

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

select(): void;

Gibt zurück

void

Hinweise

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    await context.sync(); 
});

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

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Range): void;

Parameter

properties: Excel.Range

Gibt zurück

void

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

setCellProperties(cellPropertiesData)

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

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Creating the SettableCellProperties objects to use for the range.
    // In your add-in, these should be created once, outside the function.
    const topHeaderProps: Excel.SettableCellProperties = {
        // The style property takes a string matching the name of an Excel style.
        // Built-in style names are listed in the `BuiltInStyle` enum.
        // Note that a style will overwrite any formatting,
        // so do not use the format property with the style property.
        style: "Heading1"
    };

    const headerProps: Excel.SettableCellProperties = {
        // Any subproperties of format that are not set will not be changed when these cell properties are set.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            }
        }
    };

    const range = sheet.getRange("A1:E5");

    // You can use empty JSON objects to avoid changing a cell's properties.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

setColumnProperties(columnPropertiesData)

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

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parameter

columnPropertiesData: Excel.SettableColumnProperties[]

Ein Array, das darstellt, welche Eigenschaften in den einzelnen Spalten festgelegt werden sollen.

Gibt zurück

void

Hinweise

setDirty()

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

setDirty(): void;

Gibt zurück

void

Hinweise

setRowProperties(rowPropertiesData)

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

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Parameter

rowPropertiesData: Excel.SettableRowProperties[]

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

Gibt zurück

void

Hinweise

showCard()

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

showCard(): void;

Gibt zurück

void

Hinweise

showGroupDetails(groupOption)

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

groupOption: Excel.GroupOption

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

Gibt zurück

void

Hinweise

showGroupDetails(groupOptionString)

Zeigt die Details der Zeile oder Spaltengruppe an.

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

Parameter

groupOptionString: "ByRows" | "ByColumns"

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

Gibt zurück

void

Hinweise

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Range Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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 über .sync Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als 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 die Gruppierung des Bereichs nach Zeilen oder Spalten aufgehoben werden kann.

Gibt zurück

void

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // This removes two levels of groups from the "A1-R10" range.
    // Any groups at the same level on the same dimension will be removed by a single call.
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    await context.sync();
});

ungroup(groupOptionString)

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

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

Parameter

groupOptionString: "ByRows" | "ByColumns"

Gibt an, wie die Gruppierung des Bereichs nach Zeilen oder Spalten aufgehoben werden kann.

Gibt zurück

void

Hinweise

unmerge()

Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

unmerge(): void;

Gibt zurück

void

Hinweise