ExcelScript.Range interface

Paket:

ExcelScript

Range stellt eine Gruppe von einer oder mehreren zusammenhängenden Zellen dar, z. B. eine Zelle, eine Zeile, eine Spalte oder einen Zellblock.

Hinweise

Beispiele

/**
 * This script logs the address of the used range in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the range containing all the cells with data or formatting.
  let usedRange = currentWorksheet.getUsedRange();

  // Log the range's address to the console.
  console.log(usedRange.getAddress());
}

Methoden

addConditionalFormat(type)	Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.
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.
calculate()	Berechnet einen Zellbereich auf einem Arbeitsblatt.
clear(applyTo)	Löscht Bereichswerte, Format, Füllung, Rahmen usw.
clearAllConditionalFormats()	Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.
convertDataTypeToText()	Konvertiert die Bereichszellen mit Datentypen in Text.
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.
delete(shift)	Löscht die dem Bereich zugeordneten Zellen.
find(text, criteria)	Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls deckt die Suche das gesamte Blatt ab, das nach dieser Zelle beginnt. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode zurück undefined.
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.
getAddress()	Gibt den Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").
getAddressLocal()	Stellt den Bereichsverweis für den angegebenen Bereich in der Sprache des Benutzers dar.
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.
getCellCount()	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.
getColumn(column)	Ruft eine Spalte ab, die im Bereich enthalten ist.
getColumnCount()	Gibt die Gesamtanzahl der Spalten im Bereich an.
getColumnHidden()	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.
getColumnIndex()	Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.
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.
getConditionalFormat(id)	Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.
getConditionalFormats()	Die Auflistung von ConditionalFormats , die den Bereich überschneidet.
getDataValidation()	Gibt ein Datenüberprüfungsobjekt zurück.
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.
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).
getExtendedRange(direction, activeCell)	Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs enthält, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel-Benutzeroberfläche unter Windows.
getFormat()	Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.
getFormula()	Stellt die Zellformel in der A1-Schreibweise dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getFormulaLocal()	Stellt die Zellformel in A1-Schreibweise in der Sprache und dem Gebietsschema für die Zahlenformatierung des Benutzers dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getFormulaR1C1()	Stellt die Zellformel in R1C1-Schreibweise dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getFormulas()	Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
getFormulasLocal()	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.
getFormulasR1C1()	Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
getHasSpill()	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.
getHeight()	Gibt den Abstand in Punkt für einen Zoom von 100 % vom oberen Rand des Bereichs bis zum unteren Rand des Bereichs zurück.
getHidden()	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.
getHyperlink()	Stellt den Link für den aktuellen Bereich dar.
getImage()	Rendert den Bereich als base64-codiertes PNG-Bild.
getIntersection(anotherRange)	Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode zurück undefined.
getIsEntireColumn()	Gibt an, ob der angegebene Bereich eine ganze Spalte ist.
getIsEntireRow()	Gibt an, ob der angegebene Bereich eine ganze Zeile ist.
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".
getLeft()	Gibt den Abstand in Punkt für 100 % Zoom vom linken Rand des Arbeitsblatts zum linken Rand des Bereichs zurück.
getLinkedDataTypeState()	Stellt den Datentypzustand der Zelle dar.
getLinkedDataTypeStates()	Stellt den Datentypstatus der einzelnen Zellen dar.
getMergedAreas()	Gibt ein RangeAreas -Objekt zurück, das die zusammengeführten Bereiche in diesem Bereich darstellt. Beachten Sie, dass diese Methode das Ergebnis nicht zurückgibt, wenn die Anzahl der zusammengeführten Bereiche in diesem Bereich mehr als 512 beträgt. Wenn das RangeAreas Objekt nicht vorhanden ist, gibt diese Methode zurück undefined.
getNumberFormat()	Stellt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getNumberFormatCategories()	Stellt die Kategorie des Zahlenformats jeder Zelle dar.
getNumberFormatCategory()	Gibt die Zahlenformatkategorie der ersten Zelle im Bereich an (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0).
getNumberFormatLocal()	Stellt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich dar, basierend auf den Spracheinstellungen des Benutzers. 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. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getNumberFormats()	Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar.
getNumberFormatsLocal()	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.
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.
getPredefinedCellStyle()	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.
getRangeEdge(direction, activeCell)	Gibt ein Bereichsobjekt zurück, das die Randzelle des Datenbereichs ist, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten von STRG+NACH-UNTEN-TASTE in der Excel-Benutzeroberfläche unter Windows.
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.
getRowCount()	Gibt die Anzahl der Zeilen im Bereich zurück.
getRowHidden()	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.
getRowIndex()	Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.
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.
getSavedAsArray()	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.
getSort()	Stellt die Bereichssortierung des aktuellen Bereichs dar.
getSpecialCells(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 zurück undefined.
getSpillingToRange()	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 zurück undefined.
getSpillParent()	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 zurück undefined.
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.
getText()	Stellt den Textwert des angegebenen Bereichs dar. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getTexts()	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.
getTop()	Gibt den Abstand in Punkt für 100 % Zoom vom oberen Rand des Arbeitsblatts bis zum oberen Rand des Bereichs zurück.
getUsedRange(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode zurück undefined.
getValue()	Stellt den Unformatierten Wert des angegebenen Bereichs dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getValues()	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.
getValueType()	Stellt den Datentyp in der Zelle dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.
getValueTypes()	Gibt den Datentyp in jeder Zelle an.
getVisibleView()	Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.
getWidth()	Gibt den Abstand in Punkt für 100 % Zoom vom linken Rand des Bereichs bis zum rechten Rand des Bereichs zurück.
getWorksheet()	Das Arbeitsblatt, das den aktuellen Bereich enthält.
group(groupOption)	Gruppen Spalten und Zeilen für eine Gliederung.
hideGroupDetails(groupOption)	Blendet die Details der Zeile oder Spaltengruppe aus.
insert(shift)	Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues Range -Objekt am jetzt leeren Platz zurück.
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.
setColumnHidden(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.
setDirty()	Legt für einen Bereich Neuberechnung bei der nächsten auszuführenden Neuberechnung fest.
setFormula(formula)	Legt die Zellformel in der A1-Schreibweise fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setFormulaLocal(formulaLocal)	Legen Sie die Zellformel in der A1-Schreibweise in der Sprache und dem Gebietsschema für die Zahlenformatierung des Benutzers fest. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setFormulaR1C1(formulaR1C1)	Legt die Zellformel im R1C1-Format fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setFormulas(formulas)	Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
setFormulasLocal(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.
setFormulasR1C1(formulasR1C1)	Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
setHyperlink(hyperlink)	Stellt den Link für den aktuellen Bereich dar.
setNumberFormat(numberFormat)	Legt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setNumberFormatLocal(numberFormatLocal)	Legt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich basierend auf den Spracheinstellungen des Benutzers fest. 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. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setNumberFormats(numberFormats)	Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar.
setNumberFormatsLocal(numberFormatsLocal)	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.
setPredefinedCellStyle(predefinedCellStyle)	Stellt die Formatvorlage des aktuellen Bereichs dar.
setRowHidden(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.
setValue(value)	Legt den Rohwert des angegebenen Bereichs fest. Die festzulegenden Daten können vom Typ string, number oder ein boolescher Wert sein. null -Wert wird ignoriert (nicht festgelegt oder in Excel überschrieben). Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.
setValues(values)	Legt die Rohwerte des angegebenen Bereichs fest. Bei den bereitgestellten Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Wenn der angegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
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.
ungroup(groupOption)	Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.
unmerge()	Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

Details zur Methode

addConditionalFormat(type)

Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parameter

type

ExcelScript.ConditionalFormatType

Der Typ des bedingten Formats, das hinzugefügt wird. Weitere Informationen finden Sie unter ExcelScript.ConditionalFormatType .

Gibt zurück

ExcelScript.ConditionalFormat

Beispiele

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

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.

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

Parameter

destinationRange

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

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

Beispiele

/**
 * This script uses the autofill feature to complete a table.
 * See https://support.microsoft.com/74e31bdd-d993-45da-aa82-35a236c5b5db
 * for examples of autofill scenarios.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range that shows the pattern.
  let dataRange = currentWorksheet.getRange("C2:C3");

  // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
  // This uses the default behavior to match a pattern with the table's contents.
  dataRange.autoFill("C2:C14");
}

calculate()

Berechnet einen Zellbereich auf einem Arbeitsblatt.

calculate(): void;

Gibt zurück

void

Beispiele

/**
 * This script recalculates the used range of a specific worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Only recalculate if the calculation mode is not set to automatic.
  if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
    // Get the used range from a worksheet named "Monthly Report".
    const sheet = workbook.getWorksheet("Monthly Report");
    const range = sheet.getUsedRange();
    console.log(`Calculating ${range.getAddress()}`);

    // Force all the used cells in that worksheet to calculate.
    sheet.getUsedRange().calculate();
  }
}

clear(applyTo)

Löscht Bereichswerte, Format, Füllung, Rahmen usw.

clear(applyTo?: ClearApplyTo): void;

Parameter

applyTo

ExcelScript.ClearApplyTo

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

Gibt zurück

void

Beispiele

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.

clearAllConditionalFormats(): void;

Gibt zurück

void

convertDataTypeToText()

Konvertiert die Bereichszellen mit Datentypen in Text.

convertDataTypeToText(): void;

Gibt zurück

void

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?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Parameter

sourceRange

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

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

Beispiele

/**
 * This script copies a table from one worksheet to a new worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "TableTemplate".
  let base = workbook.getWorksheet("TableTemplate");
  
  // Get the range to be copied based on the first table.
  let tableRange = base.getTables()[0].getRange();

  // Get the area in a new worksheet for the new table.
  let newWorksheet = workbook.addWorksheet();
  let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());

  // Copy the existing data into the new range.
  newRange.copyFrom(tableRange);
}

delete(shift)

Löscht die dem Bereich zugeordneten Zellen.

delete(shift: DeleteShiftDirection): void;

Parameter

shift

ExcelScript.DeleteShiftDirection

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

Gibt zurück

void

Beispiele

/**
 * This sample creates a sample range, then deletes
 * "A1" using different DeleteShiftDirection values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add sample data to better visualize the delete changes.
  const currentSheet = workbook.getActiveWorksheet();
  currentSheet.getRange("A1:D4").setValues([
    [1,2,3,4],
    [5,6,7,8],
    [9,10,11,12],
    [13,14,15,16]]);

  // Delete A1 and shift the cells from the right to fill the space.
  // The value being deleted is 1.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);

  // Delete A1 and shift the cells from the bottom to fill the space.
  // The value being deleted is 2.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);

  // Log the sample range. The values should be:
  /*
    5, 3, 4, "",
    9, 6, 7, 8,
    13, 10, 11, 12,
    "", 14, 15, 16
  */
  console.log(currentSheet.getRange("A1:D4").getValues()); 
}

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. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode zurück undefined.

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

Parameter

text

string

Die zu suchde Zeichenfolge.

criteria

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

ExcelScript.Range

Beispiele

/**
 * This script searches through a table column and finds cells marked "no change". 
 * Those cells have "no change" replaced with the value from the cell to the left.
 * This script uses Range.find instead of Worksheet.findAll 
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("March").getRange();

  // Find all cells with the value "no change".
  let cellToOverwrite = range.find("no change", { completeMatch: true });
  while (cellToOverwrite) {
    let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
    cellToOverwrite.setValue(cellToCopyFrom.getValue());
    cellToOverwrite = range.find("no change", { completeMatch: true });
  }
}

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

Beispiele

/**
 * This script uses the Flash Fill feature to complete a table.
 * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
 * for the example table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
  let dataRange = currentWorksheet.getRange("C2:C6");

  // Flash fill the connected range. 
  dataRange.flashFill();
}

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): 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

ExcelScript.Range

getAddress()

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

getAddress(): string;

Gibt zurück

string

Beispiele

/**
 * This script logs the address of the used range in each worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over every worksheet in the workbook.
  workbook.getWorksheets().forEach((sheet) => {
    // Get the used range for a single worksheet.
    let range = sheet.getUsedRange();

    // Print the address of the used range to the console.
    console.log(range.getAddress());
  });
}

getAddressLocal()

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

getAddressLocal(): string;

Gibt zurück

string

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

Parameter

anotherRange

ExcelScript.Range | string

Das Bereichsobjekt, die Adresse oder der Bereichsname.

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script gets the bounding range of two existing ranges and puts a border around it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let sheet = workbook.getActiveWorksheet();

  // Create two range objects for the sample.
  let range1 = sheet.getRange("B2:C5");
  let range2 = sheet.getRange("D10:E15");

  // Get the rectangular range that fully includes both ranges.
  let boundingRectangle = range1.getBoundingRect(range2);

  // Add a border around the whole bounding range (B2:E15).
  let format = boundingRectangle.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

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

Parameter

row

number

Zeilenanzahl der abzurufenden Zelle. Nullindiziert.

column

number

Spaltenanzahl der abzurufenden Zelle. Nullindiziert.

Gibt zurück

ExcelScript.Range

getCellCount()

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.

getCellCount(): number;

Gibt zurück

number

getColumn(column)

Ruft eine Spalte ab, die im Bereich enthalten ist.

getColumn(column: number): Range;

Parameter

column

number

Spaltenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

ExcelScript.Range

getColumnCount()

Gibt die Gesamtanzahl der Spalten im Bereich an.

getColumnCount(): number;

Gibt zurück

number

Beispiele

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

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.

getColumnHidden(): boolean;

Gibt zurück

boolean

getColumnIndex()

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

getColumnIndex(): number;

Gibt zurück

number

getColumnsAfter(count)

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

getColumnsAfter(count?: number): 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

ExcelScript.Range

getColumnsBefore(count)

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

getColumnsBefore(count?: number): 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

ExcelScript.Range

getConditionalFormat(id)

Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Parameter

id

string

Die ID des bedingten Formats.

Gibt zurück

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

Die Auflistung von ConditionalFormats , die den Bereich überschneidet.

getConditionalFormats(): ConditionalFormat[];

Gibt zurück

ExcelScript.ConditionalFormat[]

getDataValidation()

Gibt ein Datenüberprüfungsobjekt zurück.

getDataValidation(): DataValidation;

Gibt zurück

ExcelScript.DataValidation

Beispiele

/**
 * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the values for data validation.
  let selectedRange = workbook.getSelectedRange();
  let rangeValues = selectedRange.getValues();

  // Convert the values into a comma-delimited string.
  let dataValidationListString = "";
  rangeValues.forEach((rangeValueRow) => {
    rangeValueRow.forEach((value) => {
      dataValidationListString += value + ",";
    });
  });

  // Clear the old range.
  selectedRange.clear(ExcelScript.ClearApplyTo.contents);

  // Apply the data validation to the first cell in the selected range.
  let targetCell = selectedRange.getCell(0,0);
  let dataValidation = targetCell.getDataValidation();

  // Set the content of the drop-down list.
  dataValidation.setRule({
      list: {
        inCellDropDown: true,
        source: dataValidationListString
      }
    });
}

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.

getDirectPrecedents(): WorkbookRangeAreas;

Gibt zurück

ExcelScript.WorkbookRangeAreas

Beispiele

/**
 * This script finds the direct precedents of the active cell.
 * It changes the font and color of those precedent cells. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  const selected = workbook.getActiveCell();
  
  // Get the cells that are direct precedents of the current cell.
  const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();

  // Set the font to bold and the fill color to orange for all the precedent cells.
  precedents.getRanges().forEach(range => {
    range.getFormat().getFill().setColor("orange");
    range.getFormat().getFont().setBold(true);
  });
}

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(): Range;

Gibt zurück

ExcelScript.Range

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(): Range;

Gibt zurück

ExcelScript.Range

getExtendedRange(direction, activeCell)

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

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

Parameter

direction

ExcelScript.KeyboardDirection

Die Richtung aus der aktiven Zelle.

activeCell

ExcelScript.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die aktive Zelle die obere linke Zelle des Bereichs. Wenn sich die aktive Zelle nicht in diesem Bereich befindet, wird ein Fehler ausgelöst.

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script makes the font bold on all the contiguous cells between 
 * A1 and the bottom of the used range of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get every cell that's used between A1 and the end of the column.
  // This recreates the Ctrl+Shift+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);

  // Set the font to bold in that range.
  firstColumn.getFormat().getFont().setBold(true);
}

getFormat()

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

getFormat(): RangeFormat;

Gibt zurück

ExcelScript.RangeFormat

Beispiele

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

getFormula()

Stellt die Zellformel in der A1-Schreibweise dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getFormula(): string;

Gibt zurück

string

Beispiele

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

Stellt die Zellformel in A1-Schreibweise in der Sprache und dem Gebietsschema für die Zahlenformatierung des Benutzers dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getFormulaLocal(): string;

Gibt zurück

string

getFormulaR1C1()

Stellt die Zellformel in R1C1-Schreibweise dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getFormulaR1C1(): string;

Gibt zurück

string

getFormulas()

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

getFormulas(): string[][];

Gibt zurück

string[][]

getFormulasLocal()

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.

getFormulasLocal(): string[][];

Gibt zurück

string[][]

getFormulasR1C1()

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

getFormulasR1C1(): string[][];

Gibt zurück

string[][]

getHasSpill()

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.

getHasSpill(): boolean;

Gibt zurück

boolean

getHeight()

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

getHeight(): number;

Gibt zurück

number

getHidden()

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.

getHidden(): boolean;

Gibt zurück

boolean

getHyperlink()

Stellt den Link für den aktuellen Bereich dar.

getHyperlink(): RangeHyperlink;

Gibt zurück

ExcelScript.RangeHyperlink

Beispiele

/**
 * This sample clears all of the hyperlinks from the current worksheet
 * and removes the usual hyperlink formatting.
 */
function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
  // Get the active worksheet. 
  let sheet = workbook.getWorksheet(sheetName);

  // Get the used range to operate on.
  // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
  const targetRange = sheet.getUsedRange(true);
  console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);

  const rowCount = targetRange.getRowCount();
  const colCount = targetRange.getColumnCount();
  console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);

  // Go through each individual cell looking for a hyperlink. 
  // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
  let clearedCount = 0;
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < colCount; j++) {
      const cell = targetRange.getCell(i, j);
      const hyperlink = cell.getHyperlink();
      if (hyperlink) {
        cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
        cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
        cell.getFormat().getFont().setColor('Black');
        clearedCount++;
      }
    }
  }

  console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
}

getImage()

Rendert den Bereich als base64-codiertes PNG-Bild.

getImage(): string;

Gibt zurück

string

getIntersection(anotherRange)

Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode zurück undefined.

getIntersection(anotherRange: Range | string): Range;

Parameter

anotherRange

ExcelScript.Range | string

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

Gibt zurück

ExcelScript.Range

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Gibt zurück

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Gibt zurück

boolean

getLastCell()

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

getLastCell(): Range;

Gibt zurück

ExcelScript.Range

getLastColumn()

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

getLastColumn(): Range;

Gibt zurück

ExcelScript.Range

getLastRow()

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

getLastRow(): Range;

Gibt zurück

ExcelScript.Range

getLeft()

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

getLeft(): number;

Gibt zurück

number

getLinkedDataTypeState()

Stellt den Datentypzustand der Zelle dar.

getLinkedDataTypeState(): LinkedDataTypeState;

Gibt zurück

ExcelScript.LinkedDataTypeState

getLinkedDataTypeStates()

Stellt den Datentypstatus der einzelnen Zellen dar.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

Gibt zurück

ExcelScript.LinkedDataTypeState[][]

getMergedAreas()

Gibt ein RangeAreas -Objekt zurück, das die zusammengeführten Bereiche in diesem Bereich darstellt. Beachten Sie, dass diese Methode das Ergebnis nicht zurückgibt, wenn die Anzahl der zusammengeführten Bereiche in diesem Bereich mehr als 512 beträgt. Wenn das RangeAreas Objekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getMergedAreas(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

getNumberFormat()

Stellt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getNumberFormat(): string;

Gibt zurück

string

getNumberFormatCategories()

Stellt die Kategorie des Zahlenformats jeder Zelle dar.

getNumberFormatCategories(): NumberFormatCategory[][];

Gibt zurück

ExcelScript.NumberFormatCategory[][]

Beispiele

/**
 * This script finds cells in a table column that are not formatted as currency
 * and sets the fill color to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Cost" column from the "Expenses" table.
  const table = workbook.getTable("Expenses");
  const costColumn = table.getColumnByName("Cost");
  const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();

  // Get the number format categories for the column's range.
  const numberFormatCategories = costColumnRange.getNumberFormatCategories();

  // If any cell in the column doesn't have a currency format, make the cell red.
  numberFormatCategories.forEach((category, index) =>{
    if (category[0] != ExcelScript.NumberFormatCategory.currency) {
      costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
    }
  }); 
}

getNumberFormatCategory()

Gibt die Zahlenformatkategorie der ersten Zelle im Bereich an (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0).

getNumberFormatCategory(): NumberFormatCategory;

Gibt zurück

ExcelScript.NumberFormatCategory

getNumberFormatLocal()

Stellt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich dar, basierend auf den Spracheinstellungen des Benutzers. 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. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getNumberFormatLocal(): string;

Gibt zurück

string

getNumberFormats()

Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar.

getNumberFormats(): string[][];

Gibt zurück

string[][]

getNumberFormatsLocal()

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.

getNumberFormatsLocal(): string[][];

Gibt zurück

string[][]

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): 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

ExcelScript.Range

Beispiele

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

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

getPivotTables(fullyContained?: boolean): PivotTable[];

Parameter

fullyContained

boolean

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

Gibt zurück

ExcelScript.PivotTable[]

getPredefinedCellStyle()

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.

getPredefinedCellStyle(): string;

Gibt zurück

string

getRangeEdge(direction, activeCell)

Gibt ein Bereichsobjekt zurück, das die Randzelle des Datenbereichs ist, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten von STRG+NACH-UNTEN-TASTE in der Excel-Benutzeroberfläche unter Windows.

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

Parameter

direction

ExcelScript.KeyboardDirection

Die Richtung aus der aktiven Zelle.

activeCell

ExcelScript.Range | string

Die aktive Zelle in diesem Bereich. Standardmäßig ist die aktive Zelle die obere linke Zelle des Bereichs. Wenn sich die aktive Zelle nicht in diesem Bereich befindet, wird ein Fehler ausgelöst.

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script adds the value "Total" after the end of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the last used cell at the end of the column.
  // This recreates the Ctrl+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
  let cellAfter = firstColumn.getOffsetRange(1, 0);

  // Set the value of the cell after the current end of the used column to "Total".
  cellAfter.setValue("Total");
}

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): 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

ExcelScript.Range

Beispiele

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
  );
}

getRow(row)

Ruft eine Zelle ab, die im Bereich enthalten ist.

getRow(row: number): Range;

Parameter

row

number

Zeilenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

ExcelScript.Range

getRowCount()

Gibt die Anzahl der Zeilen im Bereich zurück.

getRowCount(): number;

Gibt zurück

number

Beispiele

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

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.

getRowHidden(): boolean;

Gibt zurück

boolean

getRowIndex()

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

getRowIndex(): number;

Gibt zurück

number

getRowsAbove(count)

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

getRowsAbove(count?: number): 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

ExcelScript.Range

getRowsBelow(count)

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

getRowsBelow(count?: number): 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

ExcelScript.Range

getSavedAsArray()

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.

getSavedAsArray(): boolean;

Gibt zurück

boolean

getSort()

Stellt die Bereichssortierung des aktuellen Bereichs dar.

getSort(): RangeSort;

Gibt zurück

ExcelScript.RangeSort

getSpecialCells(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 zurück undefined.

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

Parameter

cellType

ExcelScript.SpecialCellType

Der Typ der einzuschließenden Zellen.

cellValueType

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

ExcelScript.RangeAreas

Beispiele

/**
 * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current used range.
    let range = workbook.getActiveWorksheet().getUsedRange();
    
    // Get all the blank cells.
    let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
    // Highlight the blank cells with a yellow background.
    blankCells.getFormat().getFill().setColor("yellow");
}

getSpillingToRange()

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 zurück undefined.

getSpillingToRange(): Range;

Gibt zurück

ExcelScript.Range

getSpillParent()

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 zurück undefined.

getSpillParent(): Range;

Gibt zurück

ExcelScript.Range

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(): Range;

Gibt zurück

ExcelScript.Range

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

Parameter

fullyContained

boolean

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

Gibt zurück

ExcelScript.Table[]

getText()

Stellt den Textwert des angegebenen Bereichs dar. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getText(): string;

Gibt zurück

string

getTexts()

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.

getTexts(): string[][];

Gibt zurück

string[][]

getTop()

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

getTop(): number;

Gibt zurück

number

getUsedRange(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode zurück undefined.

getUsedRange(valuesOnly?: boolean): Range;

Parameter

valuesOnly

boolean

Betrachtet nur Zellen mit Werten als verwendet.

Gibt zurück

ExcelScript.Range

getValue()

Stellt den Unformatierten Wert des angegebenen Bereichs dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getValue(): string | number | boolean;

Gibt zurück

string | number | boolean

Beispiele

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getValues()

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.

getValues(): (string | number | boolean)[][];

Gibt zurück

(string | number | boolean)[][]

getValueType()

Stellt den Datentyp in der Zelle dar. Wenn der Bereich mehrere Zellen enthält, werden die Daten aus der ersten Zelle (dargestellt durch den Zeilenindex 0 und den Spaltenindex 0) zurückgegeben.

getValueType(): RangeValueType;

Gibt zurück

ExcelScript.RangeValueType

Beispiele

/**
 * This script formats rows in a worksheet based on the first value in that row. 
 * If it's the boolean value TRUE, the row is bolded. 
 * If it's FALSE, nothing is changed. 
 * If the value type isn't a boolean, the row is italicized.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get the values in the first column.
  const firstColumnValues = usedRange.getColumn(0).getValues();

  // Look at the first cell in each row.
  const rowCount = usedRange.getRowCount();
  for (let i = 0; i < rowCount; i++) {
    // Get the type of the first cell to make sure it's a boolean.
    let firstValueType = usedRange.getCell(i, 0).getValueType();

    // Set the bold or italic of the row as described earlier.
    if (firstValueType === ExcelScript.RangeValueType.boolean) {
      if (firstColumnValues[i][0] as boolean === true) {
        usedRange.getRow(i).getFormat().getFont().setBold(true);
      } else {
        usedRange.getRow(i).getFormat().getFont().setBold(false);
      }
    } else {
      usedRange.getRow(i).getFormat().getFont().setItalic(true);
    }
  }
}

getValueTypes()

Gibt den Datentyp in jeder Zelle an.

getValueTypes(): RangeValueType[][];

Gibt zurück

ExcelScript.RangeValueType[][]

getVisibleView()

Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.

getVisibleView(): RangeView;

Gibt zurück

ExcelScript.RangeView

Beispiele

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getWidth()

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

getWidth(): number;

Gibt zurück

number

getWorksheet()

Das Arbeitsblatt, das den aktuellen Bereich enthält.

getWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

group(groupOption)

Gruppen Spalten und Zeilen für eine Gliederung.

group(groupOption: GroupOption): void;

Parameter

groupOption

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

Beispiele

/**
 * This script creates a two-level column-based outline on Sheet1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Group columns A-F in the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const firstLevel = sheet.getRange("A:F");
  firstLevel.group(ExcelScript.GroupOption.byColumns);
  
  // Create a second level to the outline by grouping subsections.
  sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
  sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}

hideGroupDetails(groupOption)

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: GroupOption): void;

Parameter

groupOption

ExcelScript.GroupOption

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

Gibt zurück

void

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: InsertShiftDirection): Range;

Parameter

shift

ExcelScript.InsertShiftDirection

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

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script inserts headers at the top of the worksheet.
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Create headers for 3 columns.
  let myHeaders = [["NAME", "ID", "ROLE"]];

  // Add a blank first row and push existing data down a row.
  let firstRow = currentSheet.getRange("1:1");
  firstRow.insert(ExcelScript.InsertShiftDirection.down);

  // Add the headers.
  currentSheet.getRange("A1:C1").setValues(myHeaders);
}

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

Beispiele

/**
 * This script merges a group of cells into a single region.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Merge cells A1 through A4.
  const range = selectedSheet.getRange("A1:A4");
  range.merge();
}

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

ExcelScript.Range | string

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

Gibt zurück

void

removeDuplicates(columns, includesHeader)

Entfernt doppelte Werte aus dem durch die Spalten angegebenen Bereich.

removeDuplicates(
            columns: number[],
            includesHeader: boolean
        ): 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

ExcelScript.RemoveDuplicatesResult

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: ReplaceCriteria
        ): number;

Parameter

text

string

Zeichenfolge, die gesucht werden soll.

replacement

string

Die Zeichenfolge, die die ursprüngliche Zeichenfolge ersetzt.

criteria

ExcelScript.ReplaceCriteria

Zusätzliche Ersatzkriterien.

Gibt zurück

number

Beispiele

/**
 * This script searches through a table column and replaces  
 * cells marked "monthly special" with "parsnip".
 * This script uses Range.replaceAll instead of Worksheet.replaceAll
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("Vegetable").getRange();
  
  // Change the value of any cells with the value "monthly special".
  range.replaceAll("monthly special", "parsnip", {completeMatch: true});
}

select()

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

select(): void;

Gibt zurück

void

Beispiele

/**
 * This script selects the first row of a table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const sheet = workbook.getActiveWorksheet()
  const table = sheet.getTables()[0];

  // Get the first data row in the table.
  const row = table.getRangeBetweenHeaderAndTotal().getRow(0);

  // Select the first data row.
  row.select();
}

setColumnHidden(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.

setColumnHidden(columnHidden: boolean): void;

Parameter

columnHidden

boolean

Gibt zurück

void

setDirty()

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

setDirty(): void;

Gibt zurück

void

setFormula(formula)

Legt die Zellformel in der A1-Schreibweise fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setFormula(formula: string): void;

Parameter

formula

string

Gibt zurück

void

Beispiele

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

Legen Sie die Zellformel in der A1-Schreibweise in der Sprache und dem Gebietsschema für die Zahlenformatierung des Benutzers fest. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setFormulaLocal(formulaLocal: string): void;

Parameter

formulaLocal

string

Gibt zurück

void

setFormulaR1C1(formulaR1C1)

Legt die Zellformel im R1C1-Format fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setFormulaR1C1(formulaR1C1: string): void;

Parameter

formulaR1C1

string

Gibt zurück

void

setFormulas(formulas)

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

setFormulas(formulas: string[][]): void;

Parameter

formulas

string[][]

Gibt zurück

void

Beispiele

/**
 * This script sets the values of a range, then adds SUM formulas to calculate
 * the totals for each row of that range. 
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Set the values of a range.
  let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
  let valueRange = currentSheet.getRange("A1:C3");
  valueRange.setValues(values);

  // Set the formulas of a range.
  let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
  let formulaRange = currentSheet.getRange("D1:D3");
  formulaRange.setFormulas(formulas);
}

setFormulasLocal(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.

setFormulasLocal(formulasLocal: string[][]): void;

Parameter

formulasLocal

string[][]

Gibt zurück

void

setFormulasR1C1(formulasR1C1)

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

setFormulasR1C1(formulasR1C1: string[][]): void;

Parameter

formulasR1C1

string[][]

Gibt zurück

void

setHyperlink(hyperlink)

Stellt den Link für den aktuellen Bereich dar.

setHyperlink(hyperlink: RangeHyperlink): void;

Parameter

hyperlink

ExcelScript.RangeHyperlink

Gibt zurück

void

Beispiele

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

Legt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich fest. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setNumberFormat(numberFormat: string): void;

Parameter

numberFormat

string

Gibt zurück

void

Beispiele

/**
 * This script sets the number format in column C to show the data as a percentage.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column C to a percentage that rounds to the nearest percentage point.
  selectedSheet.getRange("C:C").setNumberFormat("0%");
}

setNumberFormatLocal(numberFormatLocal)

Legt den Excel-Zahlenformatcode der Zelle für den angegebenen Bereich basierend auf den Spracheinstellungen des Benutzers fest. 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. Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setNumberFormatLocal(numberFormatLocal: string): void;

Parameter

numberFormatLocal

string

Gibt zurück

void

Beispiele

/**
 * This script sets the number format in column D to show the data as a percentage with a decimal.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
  selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
}

setNumberFormats(numberFormats)

Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar.

setNumberFormats(numberFormats: string[][]): void;

Parameter

numberFormats

string[][]

Gibt zurück

void

setNumberFormatsLocal(numberFormatsLocal)

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.

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Parameter

numberFormatsLocal

string[][]

Gibt zurück

void

setPredefinedCellStyle(predefinedCellStyle)

Stellt die Formatvorlage des aktuellen Bereichs dar.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parameter

predefinedCellStyle

string

Gibt zurück

void

setRowHidden(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.

setRowHidden(rowHidden: boolean): void;

Parameter

rowHidden

boolean

Gibt zurück

void

setValue(value)

Legt den Rohwert des angegebenen Bereichs fest. Die festzulegenden Daten können vom Typ string, number oder ein boolescher Wert sein. null -Wert wird ignoriert (nicht festgelegt oder in Excel überschrieben). Wenn der Bereich mehrere Zellen enthält, wird jede Zelle im angegebenen Bereich mit den Eingabedaten aktualisiert.

setValue(value: any): void;

Parameter

value

any

Gibt zurück

void

setValues(values)

Legt die Rohwerte des angegebenen Bereichs fest. Bei den bereitgestellten Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Wenn der angegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.

setValues(values: (string | number | boolean)[][]): void;

Parameter

values

(string | number | boolean)[][]

Gibt zurück

void

Beispiele

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

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

showCard(): void;

Gibt zurück

void

showGroupDetails(groupOption)

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: GroupOption): void;

Parameter

groupOption

ExcelScript.GroupOption

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

Gibt zurück

void

ungroup(groupOption)

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

ungroup(groupOption: GroupOption): void;

Parameter

groupOption

ExcelScript.GroupOption

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

Gibt zurück

void

unmerge()

Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

unmerge(): void;

Gibt zurück

void

Beispiele

/**
 * This script unmerges every used cell in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Separate all regions into single cells in the currently used range.
  const range = selectedSheet.getUsedRange();
  range.unmerge();
}