ExcelScript.Worksheet interface

Referenz

Paket:: ExcelScript

Ein Excel-Arbeitsblatt ist ein Raster von Zellen. Es kann Daten, Tabellen, Diagramme usw. enthalten.

Hinweise

Beispiele

/**
 * This script creates a new worksheet named "Plum" and sets its tab color to purple.
 */
function main(workbook: ExcelScript.Workbook) {
  const newSheet = workbook.addWorksheet("Plum")
  newSheet.setTabColor("purple");
}

Methoden

activate()	Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.
addChart(type, sourceData, seriesBy)	Erstellt ein neues Diagramm.
addComment(cellAddress, content, contentType)	Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein `InvalidArgument` Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.
addGeometricShape(geometricShapeType)	Fügt dem Arbeitsblatt eine geometrische Form hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Form darstellt.
addGroup(values)	Gruppiert eine Teilmenge von Formen auf dem Arbeitsblatt dieser Sammlung. Gibt ein `Shape` -Objekt zurück, das die neue Gruppe von Formen darstellt.
addHorizontalPageBreak(pageBreakRange)	Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.
addImage(base64ImageString)	Erstellt ein Bild aus einer base64-codierten Zeichenfolge und fügt es dem Arbeitsblatt hinzu. Gibt das `Shape` -Objekt zurück, das das neue Bild darstellt.
addLine(startLeft, startTop, endLeft, endTop, connectorType)	Fügt einem Arbeitsblatt eine Linie hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Zeile darstellt.
addNamedItem(name, reference, comment)	Fügt einen neuen Namen zur Auflistung des angegebenen Bereichs hinzu.
addNamedItemFormulaLocal(name, formula, comment)	Fügt einen neuen Namen zu der Auflistung des angegebenen Bereichs unter Verwendung des Gebietsschemas des Benutzers für die Formel hinzu.
addNamedSheetView(name)	Erstellt eine neue Blattansicht mit dem angegebenen Namen.
addPivotTable(name, source, destination)	Fügen Sie eine PivotTable basierend auf den angegebenen Quelldaten hinzu, und fügen Sie sie in der linken oberen Zelle des Zielbereichs ein.
addSlicer(slicerSource, sourceField, slicerDestination)	Fügt der Arbeitsmappe einen neuen Datenschnitt hinzu.
addTable(address, hasHeaders)	Erstellt eine neue Tabelle. Das Bereichsobjekt oder die Quelladresse bestimmt das Arbeitsblatt, unter dem die Tabelle hinzugefügt wird. Wenn die Tabelle nicht hinzugefügt werden kann (z. B. weil die Adresse ungültig ist oder sich die Tabelle mit einer anderen Tabelle überschneidet), wird ein Fehler ausgelöst.
addTextBox(text)	Fügt dem Arbeitsblatt ein Textfeld mit dem angegebenen Text als Inhalt hinzu. Gibt ein `Shape` -Objekt zurück, das das neue Textfeld darstellt.
addVerticalPageBreak(pageBreakRange)	Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.
addWorksheetCustomProperty(key, value)	Fügt eine neue benutzerdefinierte Eigenschaft hinzu, die dem angegebenen Schlüssel zugeordnet ist. Dadurch werden vorhandene benutzerdefinierte Eigenschaften mit diesem Schlüssel überschrieben.
calculate(markAllDirty)	Berechnet alle Zellen auf einem Arbeitsblatt.
copy(positionType, relativeTo)	Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.
delete()	Löscht das Arbeitsblatt aus der Arbeitsmappe. Beachten Sie, dass der Löschvorgang mit einer `InvalidOperation` Ausnahme fehlschlägt, wenn die Sichtbarkeit des Arbeitsblatts auf "VeryHidden" festgelegt ist. Sie sollten die Sichtbarkeit zuerst in ausgeblendet oder sichtbar ändern, bevor Sie sie löschen.
enterTemporaryNamedSheetView()	Erstellt und aktiviert eine neue temporäre Blattansicht. Temporäre Ansichten werden entfernt, wenn Sie die Anwendung schließen, die temporäre Ansicht mit der Exitmethode beenden oder zu einer anderen Blattansicht wechseln. Auf die temporäre Blattansicht kann auch mit der leeren Zeichenfolge ("") zugegriffen werden, wenn die temporäre Ansicht vorhanden ist.
exitActiveNamedSheetView()	Beendet die aktuell aktive Blattansicht.
findAll(text, criteria)	Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als `RangeAreas` Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.
getActiveNamedSheetView()	Ruft die aktuell aktive Blattansicht des Arbeitsblatts ab.
getAutoFilter()	Stellt das `AutoFilter` -Objekt des Arbeitsblatts dar.
getCell(row, column)	Ruft das `Range` -Objekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltennummern enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt.
getChart(name)	Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben. Wenn das Diagramm nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getCharts()	Gibt eine Auflistung von Diagrammen zurück, die Teil des Arbeitsblatts sind.
getComment(commentId)	Ruft einen Kommentar aus der Sammlung basierend auf der ID ab. Wenn das Comment-Objekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getCommentByCell(cellAddress)	Ruft den Kommentar aus der angegebenen Zelle ab. Wenn in der Zelle kein Kommentar vorhanden ist, wird ein Fehler ausgelöst.
getCommentByReplyId(replyId)	Ruft den Kommentar ab, mit dem die angegebene Antwort verbunden ist.
getComments()	Gibt eine Sammlung aller Kommentarobjekte auf dem Arbeitsblatt zurück.
getCustomProperties()	Ruft eine Auflistung von benutzerdefinierten Eigenschaften auf Arbeitsblattebene ab.
getEnableCalculation()	Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.
getFreezePanes()	Ruft ein -Objekt ab, das zum Bearbeiten von fixierten Bereichen auf dem Arbeitsblatt verwendet werden kann.
getHorizontalPageBreaks()	Ruft die Sammlung der horizontalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.
getId()	Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.
getName()	Der Anzeigename des Arbeitsblatts.
getNamedItem(name)	Ruft ein `NamedItem` -Objekt unter Verwendung seines Namens ab. Wenn das Objekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getNamedSheetView(key)	Ruft eine Blattansicht unter Verwendung ihres Namens ab. Wenn das Blattansichtsobjekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getNamedSheetViews()	Gibt eine Auflistung von Blattansichten zurück, die im Arbeitsblatt vorhanden sind.
getNames()	Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.
getNext(visibleOnly)	Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, gibt diese Methode zurück `undefined`.
getPageLayout()	Ruft das `PageLayout` -Objekt des Arbeitsblatts ab.
getPivotTable(name)	Ruft eine PivotTable anhand des Namens ab. Wenn die PivotTable nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getPivotTables()	Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.
getPosition()	Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.
getPrevious(visibleOnly)	Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode zurück `undefined`.
getProtection()	Gibt das Blattschutzobjekt für ein Arbeitsblatt zurück.
getRange(address)	Ruft das `Range` -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Ruft das `Range` -Objekt ab, das bei einem bestimmten Zeilen- und Spaltenindex beginnt und eine bestimmte Anzahl von Zeilen und Spalten umfasst.
getRanges(address)	Ruft das `RangeAreas` -Objekt ab, das einen oder mehrere Blöcke rechteckiger Bereiche darstellt, die durch die Adresse oder den Namen angegeben werden.
getShape(key)	Ruft ein Shape unter Verwendung seines Namens oder seiner ID ab. Wenn das Shape-Objekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getShapes()	Gibt die Sammlung aller Formobjekte auf dem Arbeitsblatt zurück.
getShowGridlines()	Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.
getShowHeadings()	Gibt an, ob Überschriften für den Benutzer sichtbar sind.
getSlicer(key)	Ruft einen Datenschnitt unter Verwendung seines Namens oder seiner ID ab. Wenn der Slicer nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getSlicers()	Gibt eine Auflistung von Datenschnitten zurück, die Teil des Arbeitsblatts sind.
getStandardHeight()	Gibt die Standardhöhe (Standard) aller Zeilen in der Arbeitsmappe in Punkt zurück.
getStandardWidth()	Gibt die Standardbreite aller Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.
getTabColor()	Die Registerkartenfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerkartenfarbe nicht sichtbar ist, lautet `null`der Wert . Wenn das Arbeitsblatt sichtbar ist, aber die Registerkartenfarbe auf Auto festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenfolge, um eine "auto"-Farbe festzulegen, andernfalls eine echte Farbe.
getTabId()	Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt, das von Open Office XML gelesen werden kann. Dies ist ein ganzzahliger Wert, der sich von `worksheet.id` (der einen global eindeutigen Bezeichner zurückgibt) und `worksheet.name` (der einen Wert wie "Sheet1" zurückgibt).
getTable(key)	Ruft eine Tabelle anhand des Namens oder der ID ab. Wenn die Tabelle nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getTables()	Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.
getUsedRange(valuesOnly)
getVerticalPageBreaks()	Ruft die Sammlung der vertikalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.
getVisibility()	Die Sichtbarkeit des Arbeitsblatts.
getWorksheetCustomProperty(key)	Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Methode zurück `undefined`.
refreshAllPivotTables()	Aktualisiert alle PivotTables in der Sammlung.
removeAllHorizontalPageBreaks()	Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.
removeAllVerticalPageBreaks()	Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.
replaceAll(text, replacement, criteria)	Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der auf dem aktuellen Arbeitsblatt angegebenen Kriterien.
setEnableCalculation(enableCalculation)	Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.
setName(name)	Der Anzeigename des Arbeitsblatts.
setPosition(position)	Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.
setShowGridlines(showGridlines)	Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.
setShowHeadings(showHeadings)	Gibt an, ob Überschriften für den Benutzer sichtbar sind.
setStandardWidth(standardWidth)	Gibt die Standardbreite aller Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.
setTabColor(tabColor)	Die Registerkartenfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerkartenfarbe nicht sichtbar ist, lautet `null`der Wert . Wenn das Arbeitsblatt sichtbar ist, aber die Registerkartenfarbe auf Auto festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenfolge, um eine "auto"-Farbe festzulegen, andernfalls eine echte Farbe.
setVisibility(visibility)	Die Sichtbarkeit des Arbeitsblatts.
showOutlineLevels(rowLevels, columnLevels)	Zeigt Zeilen- oder Spaltengruppen anhand ihrer Gliederungsebenen an. Beschreibt Gruppen und fasst eine Liste der Daten im Arbeitsblatt zusammen. Die `rowLevels` Parameter und `columnLevels` geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Der Wert 0 ändert die aktuelle Anzeige nicht. Ein Wert, der größer als die aktuelle Anzahl von Ebenen ist, zeigt alle Ebenen an.

Details zur Methode

activate()

Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

void

Beispiele

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

addChart(type, sourceData, seriesBy)

Erstellt ein neues Diagramm.

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

Parameter

type: ExcelScript.ChartType

Stellt die Art des Diagramms dar. Weitere Informationen finden Sie unter ExcelScript.ChartType .

sourceData: ExcelScript.Range

Das Range -Objekt, das den Quelldaten entspricht.

seriesBy: ExcelScript.ChartSeriesBy

Optional. Gibt an, wie Spalten oder Zeilen als Datenreihen im Diagramm verwendet werden. Weitere Informationen finden Sie unter ExcelScript.ChartSeriesBy .

Gibt zurück

ExcelScript.Chart

Beispiele

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

addComment(cellAddress, content, contentType)

Erstellt einen neuen Kommentar mit dem angegebenen Inhalt auf der angegebenen Zelle. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Parameter

cellAddress: ExcelScript.Range | string

Die Zelle, der der Kommentar hinzugefügt wird. Dies kann ein Range Objekt oder eine Zeichenfolge sein. Wenn es sich um eine Zeichenfolge handelt, muss sie die vollständige Adresse einschließlich des Blattnamens enthalten. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.

content: ExcelScript.CommentRichContent | string

Der Inhalt des Kommentars. Dies kann entweder eine Zeichenfolge oder CommentRichContent ein Objekt sein. Zeichenfolgen werden für Nur-Text verwendet. CommentRichContent -Objekte ermöglichen andere Kommentarfeatures, z. B. Erwähnungen.

contentType: ExcelScript.ContentType

Optional. Der Inhaltstyp, der im Kommentar enthalten ist. Der Standardwert ist enum ContentType.Plain.

Gibt zurück

ExcelScript.Comment

addGeometricShape(geometricShapeType)

Fügt dem Arbeitsblatt eine geometrische Form hinzu. Gibt ein Shape -Objekt zurück, das die neue Form darstellt.

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Parameter

geometricShapeType: ExcelScript.GeometricShapeType

Stellt den Typ der geometrischen Form dar. Weitere Informationen finden Sie unter ExcelScript.GeometricShapeType .

Gibt zurück

ExcelScript.Shape

Beispiele

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

addGroup(values)

Gruppiert eine Teilmenge von Formen auf dem Arbeitsblatt dieser Sammlung. Gibt ein Shape -Objekt zurück, das die neue Gruppe von Formen darstellt.

addGroup(values: Array<string | Shape>): Shape;

Parameter

values: Array<string | ExcelScript.Shape>

Ein Array von Shape-IDs oder Shape-Objekten.

Gibt zurück

ExcelScript.Shape

addHorizontalPageBreak(pageBreakRange)

Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Parameter

pageBreakRange: ExcelScript.Range | string

Der Bereich unmittelbar nach dem hinzuzufügenden Seitenwechsel.

Gibt zurück

ExcelScript.PageBreak

addImage(base64ImageString)

Erstellt ein Bild aus einer base64-codierten Zeichenfolge und fügt es dem Arbeitsblatt hinzu. Gibt das Shape -Objekt zurück, das das neue Bild darstellt.

addImage(base64ImageString: string): Shape;

Parameter

base64ImageString: string

Eine base64-codierte Zeichenfolge, die ein Bild im JPEG- oder PNG-Format darstellt.

Gibt zurück

ExcelScript.Shape

Beispiele

/**
 * This sample copies an image from a URL. 
 * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
 */
async function main(workbook: ExcelScript.Workbook) {
  // Fetch the image from a URL.
  const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
  const response = await fetch(link);

  // Store the response as an ArrayBuffer, since it is a raw image file.
  const data = await response.arrayBuffer();

  // Convert the image data into a base64-encoded string.
  const image = convertToBase64(data);

  // Add the image to the current worksheet.
  workbook.getActiveWorksheet().addImage(image);
}

/**
 * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
 */
function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;

  // Allocate the necessary space up front.
  const charCodeArray = new Array<string>(count) 
  
  // Convert every entry in the array to a character.
  for (let i = count; i >= 0; i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }

  // Convert the characters to base64.
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Fügt einem Arbeitsblatt eine Linie hinzu. Gibt ein Shape -Objekt zurück, das die neue Zeile darstellt.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType
        ): Shape;

Parameter

startLeft: number

Der Abstand in Punkt vom Anfang der Zeile zur linken Seite des Arbeitsblatts.

startTop: number

Der Abstand in Punkt vom Anfang der Zeile bis zum oberen Rand des Arbeitsblatts.

endLeft: number

Der Abstand in Punkt vom Ende der Zeile zur linken Seite des Arbeitsblatts.

endTop: number

Der Abstand in Punkt vom Ende der Zeile bis zum oberen Rand des Arbeitsblatts.

connectorType: ExcelScript.ConnectorType

Stellt den Connectortyp dar. Weitere Informationen finden Sie unter ExcelScript.ConnectorType .

Gibt zurück

ExcelScript.Shape

addNamedItem(name, reference, comment)

Fügt einen neuen Namen zur Auflistung des angegebenen Bereichs hinzu.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Parameter

name: string

Der Name des benannten Elements.

reference: ExcelScript.Range | string

Die Formel oder der Bereich, auf die bzw. den der Name verweist.

comment: string

Optional. Der Kommentar, der dem benannten Element zugeordnet ist.

Gibt zurück

ExcelScript.NamedItem

addNamedItemFormulaLocal(name, formula, comment)

Fügt einen neuen Namen zu der Auflistung des angegebenen Bereichs unter Verwendung des Gebietsschemas des Benutzers für die Formel hinzu.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Parameter

name: string

Der Name des benannten Elements.

formula: string

Die Formel im Gebietsschema des Benutzers, auf die der Name verweist.

comment: string

Optional. Der Kommentar, der dem benannten Element zugeordnet ist.

Gibt zurück

ExcelScript.NamedItem

addNamedSheetView(name)

Erstellt eine neue Blattansicht mit dem angegebenen Namen.

addNamedSheetView(name: string): NamedSheetView;

Parameter

name: string

Der Name der zu erstellenden Blattansicht. Löst einen Fehler aus, wenn der angegebene Name bereits vorhanden ist, leer ist oder ein vom Arbeitsblatt reservierter Name ist.

Gibt zurück

ExcelScript.NamedSheetView

addPivotTable(name, source, destination)

Fügen Sie eine PivotTable basierend auf den angegebenen Quelldaten hinzu, und fügen Sie sie in der linken oberen Zelle des Zielbereichs ein.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Parameter

name: string

Der Name der neuen PivotTable.

source: ExcelScript.Range | string | ExcelScript.Table

Die Quelldaten für die neue PivotTable können entweder ein Bereich (oder eine Zeichenfolgenadresse einschließlich des Arbeitsblattnamens) oder eine Tabelle sein.

destination: ExcelScript.Range | string

Die Zelle in der oberen linken Ecke des Zielbereichs des PivotTable-Berichts (der Bereich auf dem Arbeitsblatt, in dem der resultierende Bericht platziert wird).

Gibt zurück

ExcelScript.PivotTable

Beispiele

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));

  // Switch to the new worksheet.
  newSheet.activate();
}

addSlicer(slicerSource, sourceField, slicerDestination)

Fügt der Arbeitsmappe einen neuen Datenschnitt hinzu.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Parameter

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

Die Datenquelle, auf der der neue Slicer basiert. Dabei kann es sich um ein PivotTable Objekt, ein Table Objekt oder eine Zeichenfolge handeln. Wenn ein PivotTable-Objekt übergeben wird, ist die Datenquelle die Quelle des PivotTable Objekts. Wenn ein Table Objekt übergeben wird, ist die Datenquelle das Table -Objekt. Wenn eine Zeichenfolge übergeben wird, wird sie als Name oder ID einer PivotTable oder Tabelle interpretiert.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

Das Feld in der Datenquelle, nach dem gefiltert werden soll. Dabei kann es sich um ein PivotField Objekt, ein TableColumn Objekt, die ID eines PivotField oder den Namen oder die ID eines handeln TableColumn.

slicerDestination: string | ExcelScript.Worksheet

Optional. Das Arbeitsblatt, in dem der neue Slicer erstellt wird. Es kann sich um ein Worksheet Objekt oder den Namen oder die ID eines Arbeitsblatts handeln. Dieser Parameter kann weggelassen werden, wenn die Slicerauflistung aus einem Arbeitsblatt abgerufen wird.

Gibt zurück

ExcelScript.Slicer

Beispiele

/**
 * This script adds a slicer for an existing PivotTable on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable from the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const pivot = currentSheet.getPivotTables()[0];

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const slicer = currentSheet.addSlicer(
    pivot, /* The table or PivotTale to be sliced. */
    pivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  slicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  slicer.setLeft(400);
}

addTable(address, hasHeaders)

Erstellt eine neue Tabelle. Das Bereichsobjekt oder die Quelladresse bestimmt das Arbeitsblatt, unter dem die Tabelle hinzugefügt wird. Wenn die Tabelle nicht hinzugefügt werden kann (z. B. weil die Adresse ungültig ist oder sich die Tabelle mit einer anderen Tabelle überschneidet), wird ein Fehler ausgelöst.

addTable(address: Range | string, hasHeaders: boolean): Table;

Parameter

address: ExcelScript.Range | string

Ein Range -Objekt oder eine Zeichenfolgenadresse oder ein Name des Bereichs, der die Datenquelle darstellt. Wenn die Adresse keinen Arbeitsblattnamen enthält, wird das aktuell aktive Blatt verwendet.

hasHeaders: boolean

Ein boolescher Wert, der angibt, ob die importierten Daten Spaltenbeschriftungen aufweisen. Wenn die Quelle keine Header enthält (d. h. wenn diese Eigenschaft auf falsefestgelegt ist), generiert Excel automatisch eine Kopfzeile und verschiebt die Daten um eine Zeile nach unten.

Gibt zurück

ExcelScript.Table

Beispiele

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

addTextBox(text)

Fügt dem Arbeitsblatt ein Textfeld mit dem angegebenen Text als Inhalt hinzu. Gibt ein Shape -Objekt zurück, das das neue Textfeld darstellt.

addTextBox(text?: string): Shape;

Parameter

text: string

Stellt den Text dar, der im erstellten Textfeld angezeigt wird.

Gibt zurück

ExcelScript.Shape

addVerticalPageBreak(pageBreakRange)

Fügt vor der oberen linken Zelle des angegebenen Bereichs einen Seitenumbruch hinzu.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Parameter

pageBreakRange: ExcelScript.Range | string

Der Bereich unmittelbar nach dem hinzuzufügenden Seitenwechsel.

Gibt zurück

ExcelScript.PageBreak

addWorksheetCustomProperty(key, value)

Fügt eine neue benutzerdefinierte Eigenschaft hinzu, die dem angegebenen Schlüssel zugeordnet ist. Dadurch werden vorhandene benutzerdefinierte Eigenschaften mit diesem Schlüssel überschrieben.

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

Parameter

key: string

Der Schlüssel, der das benutzerdefinierte Eigenschaftenobjekt identifiziert. Die Groß-/Kleinschreibung wird nicht beachtet. Der Schlüssel ist auf 255 Zeichen beschränkt (größere Werte führen dazu, dass ein InvalidArgument Fehler ausgelöst wird.)

value: string

Der Wert dieser benutzerdefinierten Eigenschaft.

Gibt zurück

ExcelScript.WorksheetCustomProperty

calculate(markAllDirty)

Berechnet alle Zellen auf einem Arbeitsblatt.

calculate(markAllDirty: boolean): void;

Parameter

markAllDirty: boolean

True, um alle als modifiziert zu markieren.

Gibt zurück

void

copy(positionType, relativeTo)

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

copy(
            positionType?: WorksheetPositionType,
            relativeTo?: Worksheet
        ): Worksheet;

Parameter

positionType: ExcelScript.WorksheetPositionType

Der Speicherort in der Arbeitsmappe, an dem das neu erstellte Arbeitsblatt platziert werden soll. Der Standardwert ist "None", wodurch das Arbeitsblatt am Anfang des Arbeitsblatts eingefügt wird.

relativeTo: ExcelScript.Worksheet

Das vorhandene Arbeitsblatt, das die Position des neu erstellten Arbeitsblatts bestimmt. Dies ist nur erforderlich, wenn positionType "Vorher" oder "Nach" ist.

Gibt zurück

ExcelScript.Worksheet

Beispiele

/**
 * This script duplicates a worksheet named "Template". 
 * The new worksheet is added after the template.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "Template".
  let template = workbook.getWorksheet("Template");

  // Copy the worksheet.
  let newSheet = template.copy(
    ExcelScript.WorksheetPositionType.after,
    template
  );

  // Name the worksheet using the current date.
  let date = new Date(Date.now());
  newSheet.setName(`${date.toDateString()}`);
}

delete()

Löscht das Arbeitsblatt aus der Arbeitsmappe. Beachten Sie, dass der Löschvorgang mit einer InvalidOperation Ausnahme fehlschlägt, wenn die Sichtbarkeit des Arbeitsblatts auf "VeryHidden" festgelegt ist. Sie sollten die Sichtbarkeit zuerst in ausgeblendet oder sichtbar ändern, bevor Sie sie löschen.

delete(): void;

Gibt zurück

void

Beispiele

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

enterTemporaryNamedSheetView()

Erstellt und aktiviert eine neue temporäre Blattansicht. Temporäre Ansichten werden entfernt, wenn Sie die Anwendung schließen, die temporäre Ansicht mit der Exitmethode beenden oder zu einer anderen Blattansicht wechseln. Auf die temporäre Blattansicht kann auch mit der leeren Zeichenfolge ("") zugegriffen werden, wenn die temporäre Ansicht vorhanden ist.

enterTemporaryNamedSheetView(): NamedSheetView;

Gibt zurück

ExcelScript.NamedSheetView

exitActiveNamedSheetView()

Beendet die aktuell aktive Blattansicht.

exitActiveNamedSheetView(): void;

Gibt zurück

void

findAll(text, criteria)

Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.

findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;

Parameter

text: string

Die zu suchde Zeichenfolge.

criteria: ExcelScript.WorksheetSearchCriteria

Zusätzliche Suchkriterien, z. B. ob die Suche mit der gesamten Zelle übereinstimmen oder die Groß-/Kleinschreibung beachtet werden muss.

Gibt zurück

ExcelScript.RangeAreas

Beispiele

/**
 * This script searches through a worksheet and finds cells containing "No". 
 * Those cells are filled red.
 * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let noCells = worksheet.findAll("No", { completeMatch: true });

  // Set the fill color to red.
  noCells.getFormat().getFill().setColor("red");
}

getActiveNamedSheetView()

Ruft die aktuell aktive Blattansicht des Arbeitsblatts ab.

getActiveNamedSheetView(): NamedSheetView;

Gibt zurück

ExcelScript.NamedSheetView

getAutoFilter()

Stellt das AutoFilter -Objekt des Arbeitsblatts dar.

getAutoFilter(): AutoFilter;

Gibt zurück

ExcelScript.AutoFilter

Beispiele

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile 
 * (of column D values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the top 10% of values in column D
  // (index 3, assuming the used range spans from at least A:D).
  currentSheet.getAutoFilter().apply(dataRange, 3, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.topPercent
  });
}

getCell(row, column)

Ruft das Range -Objekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltennummern enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt.

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

Parameter

row: number

Die Zeilenanzahl der abzurufenden Zelle. Nullindiziert.

column: number

Die Spaltenanzahl der abzurufenden Zelle. Nullindiziert.

Gibt zurück

ExcelScript.Range

getChart(name)

Ruft ein Diagramm über seinen Namen ab. Wenn mehrere Diagramme mit demselben Namen vorhanden sind, wird das erste zurückgegeben. Wenn das Diagramm nicht vorhanden ist, gibt diese Methode zurück undefined.

getChart(name: string): Chart | undefined;

Parameter

name: string

Der Name des abzurufenden Diagramms.

Gibt zurück

ExcelScript.Chart | undefined

Beispiele

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

getCharts()

Gibt eine Auflistung von Diagrammen zurück, die Teil des Arbeitsblatts sind.

getCharts(): Chart[];

Gibt zurück

ExcelScript.Chart[]

getComment(commentId)

Ruft einen Kommentar aus der Sammlung basierend auf der ID ab. Wenn das Comment-Objekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getComment(commentId: string): Comment | undefined;

Parameter

commentId: string

Der Bezeichner für den Kommentar.

Gibt zurück

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

Ruft den Kommentar aus der angegebenen Zelle ab. Wenn in der Zelle kein Kommentar vorhanden ist, wird ein Fehler ausgelöst.

getCommentByCell(cellAddress: Range | string): Comment;

Parameter

cellAddress: ExcelScript.Range | string

Die Zelle, in der sich der Kommentar befindet. Dies kann ein Range Objekt oder eine Zeichenfolge sein. Wenn es sich um eine Zeichenfolge handelt, muss sie die vollständige Adresse einschließlich des Blattnamens enthalten. Ein InvalidArgument Fehler wird ausgelöst, wenn der angegebene Bereich größer als eine Zelle ist.

Gibt zurück

ExcelScript.Comment

getCommentByReplyId(replyId)

Ruft den Kommentar ab, mit dem die angegebene Antwort verbunden ist.

getCommentByReplyId(replyId: string): Comment;

Parameter

replyId: string

Der Bezeichner der Kommentarantwort.

Gibt zurück

ExcelScript.Comment

getComments()

Gibt eine Sammlung aller Kommentarobjekte auf dem Arbeitsblatt zurück.

getComments(): Comment[];

Gibt zurück

ExcelScript.Comment[]

getCustomProperties()

Ruft eine Auflistung von benutzerdefinierten Eigenschaften auf Arbeitsblattebene ab.

getCustomProperties(): WorksheetCustomProperty[];

Gibt zurück

ExcelScript.WorksheetCustomProperty[]

getEnableCalculation()

Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.

getEnableCalculation(): boolean;

Gibt zurück

boolean

getFreezePanes()

Ruft ein -Objekt ab, das zum Bearbeiten von fixierten Bereichen auf dem Arbeitsblatt verwendet werden kann.

getFreezePanes(): WorksheetFreezePanes;

Gibt zurück

ExcelScript.WorksheetFreezePanes

getHorizontalPageBreaks()

Ruft die Sammlung der horizontalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

getHorizontalPageBreaks(): PageBreak[];

Gibt zurück

ExcelScript.PageBreak[]

getId()

Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.

getId(): string;

Gibt zurück

string

getName()

Der Anzeigename des Arbeitsblatts.

getName(): string;

Gibt zurück

string

Beispiele

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

getNamedItem(name)

Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab. Wenn das Objekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getNamedItem(name: string): NamedItem | undefined;

Parameter

name: string

Name des benannten Elements.

Gibt zurück

ExcelScript.NamedItem | undefined

getNamedSheetView(key)

Ruft eine Blattansicht unter Verwendung ihres Namens ab. Wenn das Blattansichtsobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getNamedSheetView(key: string): NamedSheetView | undefined;

Parameter

key: string

Der Name der Blattansicht, bei dem die Groß-/Kleinschreibung beachtet wird. Verwenden Sie die leere Zeichenfolge (""), um die temporäre Blattansicht abzurufen, wenn die temporäre Ansicht vorhanden ist.

Gibt zurück

ExcelScript.NamedSheetView | undefined

getNamedSheetViews()

Gibt eine Auflistung von Blattansichten zurück, die im Arbeitsblatt vorhanden sind.

getNamedSheetViews(): NamedSheetView[];

Gibt zurück

ExcelScript.NamedSheetView[]

getNames()

Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.

getNames(): NamedItem[];

Gibt zurück

ExcelScript.NamedItem[]

getNext(visibleOnly)

Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, gibt diese Methode zurück undefined.

getNext(visibleOnly?: boolean): Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

ExcelScript.Worksheet

getPageLayout()

Ruft das PageLayout -Objekt des Arbeitsblatts ab.

getPageLayout(): PageLayout;

Gibt zurück

ExcelScript.PageLayout

Beispiele

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

getPivotTable(name)

Ruft eine PivotTable anhand des Namens ab. Wenn die PivotTable nicht vorhanden ist, gibt diese Methode zurück undefined.

getPivotTable(name: string): PivotTable | undefined;

Parameter

name: string

Name der abzurufenden PivotTable.

Gibt zurück

ExcelScript.PivotTable | undefined

getPivotTables()

Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.

getPivotTables(): PivotTable[];

Gibt zurück

ExcelScript.PivotTable[]

getPosition()

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

getPosition(): number;

Gibt zurück

number

getPrevious(visibleOnly)

Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode zurück undefined.

getPrevious(visibleOnly?: boolean): Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

ExcelScript.Worksheet

getProtection()

Gibt das Blattschutzobjekt für ein Arbeitsblatt zurück.

getProtection(): WorksheetProtection;

Gibt zurück

ExcelScript.WorksheetProtection

Beispiele

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

getRange(address)

Ruft das Range -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.

getRange(address?: string): Range;

Parameter

address: string

Optional. Die Zeichenfolge, die die Adresse oder den Namen des Bereichs darstellt. Beispiel: "A1:B2". Wenn nichts angegeben ist, wird der gesamte Arbeitsblattbereich zurückgegeben.

Gibt zurück

ExcelScript.Range

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());
}

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Ruft das Range -Objekt ab, das bei einem bestimmten Zeilen- und Spaltenindex beginnt und eine bestimmte Anzahl von Zeilen und Spalten umfasst.

getRangeByIndexes(
            startRow: number,
            startColumn: number,
            rowCount: number,
            columnCount: number
        ): Range;

Parameter

startRow: number

Startzeile (nullindiziert).

startColumn: number

Startspalte (nullindiziert).

rowCount: number

Anzahl der Zeilen, die in den Bereich eingeschlossen werden sollen.

columnCount: number

Anzahl der Spalten, die in den Bereich eingeschlossen werden sollen.

Gibt zurück

ExcelScript.Range

getRanges(address)

Ruft das RangeAreas -Objekt ab, das einen oder mehrere Blöcke rechteckiger Bereiche darstellt, die durch die Adresse oder den Namen angegeben werden.

getRanges(address?: string): RangeAreas;

Parameter

address: string

Optional. Eine Zeichenfolge, die die durch Trennzeichen oder Semikolons getrennten Adressen oder Namen der einzelnen Bereiche enthält. Beispiel: "A1:B2, A5:B5" oder "A1:B2; A5:B5". Wenn keine Angabe erfolgt, wird ein RangeAreas -Objekt für das gesamte Arbeitsblatt zurückgegeben.

Gibt zurück

ExcelScript.RangeAreas

getShape(key)

Ruft ein Shape unter Verwendung seines Namens oder seiner ID ab. Wenn das Shape-Objekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getShape(key: string): Shape | undefined;

Parameter

key: string

Der Name oder die ID des abzurufenden Shapes.

Gibt zurück

ExcelScript.Shape | undefined

getShapes()

Gibt die Sammlung aller Formobjekte auf dem Arbeitsblatt zurück.

getShapes(): Shape[];

Gibt zurück

ExcelScript.Shape[]

getShowGridlines()

Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.

getShowGridlines(): boolean;

Gibt zurück

boolean

getShowHeadings()

Gibt an, ob Überschriften für den Benutzer sichtbar sind.

getShowHeadings(): boolean;

Gibt zurück

boolean

getSlicer(key)

Ruft einen Datenschnitt unter Verwendung seines Namens oder seiner ID ab. Wenn der Slicer nicht vorhanden ist, gibt diese Methode zurück undefined.

getSlicer(key: string): Slicer | undefined;

Parameter

key: string

Name oder ID des abzurufenden Slicers.

Gibt zurück

ExcelScript.Slicer | undefined

getSlicers()

Gibt eine Auflistung von Datenschnitten zurück, die Teil des Arbeitsblatts sind.

getSlicers(): Slicer[];

Gibt zurück

ExcelScript.Slicer[]

getStandardHeight()

Gibt die Standardhöhe (Standard) aller Zeilen in der Arbeitsmappe in Punkt zurück.

getStandardHeight(): number;

Gibt zurück

number

getStandardWidth()

Gibt die Standardbreite aller Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.

getStandardWidth(): number;

Gibt zurück

number

getTabColor()

Die Registerkartenfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerkartenfarbe nicht sichtbar ist, lautet nullder Wert . Wenn das Arbeitsblatt sichtbar ist, aber die Registerkartenfarbe auf Auto festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenfolge, um eine "auto"-Farbe festzulegen, andernfalls eine echte Farbe.

getTabColor(): string;

Gibt zurück

string

getTabId()

Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt, das von Open Office XML gelesen werden kann. Dies ist ein ganzzahliger Wert, der sich von worksheet.id (der einen global eindeutigen Bezeichner zurückgibt) und worksheet.name (der einen Wert wie "Sheet1" zurückgibt).

getTabId(): number;

Gibt zurück

number

getTable(key)

Ruft eine Tabelle anhand des Namens oder der ID ab. Wenn die Tabelle nicht vorhanden ist, gibt diese Methode zurück undefined.

getTable(key: string): Table | undefined;

Parameter

key: string

Name oder ID der abzurufenden Tabelle.

Gibt zurück

ExcelScript.Table | undefined

getTables()

Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.

getTables(): Table[];

Gibt zurück

ExcelScript.Table[]

getUsedRange(valuesOnly)

getUsedRange(valuesOnly?: boolean): Range;

Parameter

valuesOnly: boolean

Optional. Betrachtet nur Zellen mit Werten als verwendet.

Gibt zurück

ExcelScript.Range

getVerticalPageBreaks()

Ruft die Sammlung der vertikalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

getVerticalPageBreaks(): PageBreak[];

Gibt zurück

ExcelScript.PageBreak[]

getVisibility()

Die Sichtbarkeit des Arbeitsblatts.

getVisibility(): SheetVisibility;

Gibt zurück

ExcelScript.SheetVisibility

getWorksheetCustomProperty(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Methode zurück undefined.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Parameter

key: string

Der Schlüssel, der das benutzerdefinierte Eigenschaftenobjekt identifiziert. Die Groß-/Kleinschreibung wird nicht beachtet.

Gibt zurück

ExcelScript.WorksheetCustomProperty | undefined

refreshAllPivotTables()

Aktualisiert alle PivotTables in der Sammlung.

refreshAllPivotTables(): void;

Gibt zurück

void

removeAllHorizontalPageBreaks()

Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.

removeAllHorizontalPageBreaks(): void;

Gibt zurück

void

removeAllVerticalPageBreaks()

Setzt alle manuellen Seitenumbrüche in der Sammlung zurück.

removeAllVerticalPageBreaks(): void;

Gibt zurück

void

replaceAll(text, replacement, criteria)

Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der auf dem aktuellen Arbeitsblatt 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

setEnableCalculation(enableCalculation)

Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.

setEnableCalculation(enableCalculation: boolean): void;

Parameter

enableCalculation: boolean

Gibt zurück

void

setName(name)

Der Anzeigename des Arbeitsblatts.

setName(name: string): void;

Parameter

name: string

Gibt zurück

void

Beispiele

/**
 * This sample renames a worksheet from "Sheet1" to "SALES".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "Sheet1".
  const sheet = workbook.getWorksheet('Sheet1'); 

  // Set its name to SALES.
  sheet.setName('SALES');
}

setPosition(position)

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

setPosition(position: number): void;

Parameter

position: number

Gibt zurück

void

Beispiele

/**
 * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "SALES".
  const sheet = workbook.getWorksheet('SALES'); 
  // Position the worksheet at the beginning of the workbook.
  sheet.setPosition(0);
}

setShowGridlines(showGridlines)

Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.

setShowGridlines(showGridlines: boolean): void;

Parameter

showGridlines: boolean

Gibt zurück

void

setShowHeadings(showHeadings)

Gibt an, ob Überschriften für den Benutzer sichtbar sind.

setShowHeadings(showHeadings: boolean): void;

Parameter

showHeadings: boolean

Gibt zurück

void

setStandardWidth(standardWidth)

setStandardWidth(standardWidth: number): void;

Parameter

standardWidth: number

Gibt zurück

void

setTabColor(tabColor)

setTabColor(tabColor: string): void;

Parameter

tabColor: string

Gibt zurück

void

Beispiele

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

setVisibility(visibility)

Die Sichtbarkeit des Arbeitsblatts.

setVisibility(visibility: SheetVisibility): void;

Parameter

visibility: ExcelScript.SheetVisibility

Gibt zurück

void

Beispiele

/**
 * This script unhides all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over each worksheet.
  workbook.getWorksheets().forEach((worksheet) => {
    // Set the worksheet visibility to visible.
    worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
  });
}

showOutlineLevels(rowLevels, columnLevels)

Zeigt Zeilen- oder Spaltengruppen anhand ihrer Gliederungsebenen an. Beschreibt Gruppen und fasst eine Liste der Daten im Arbeitsblatt zusammen. Die rowLevels Parameter und columnLevels geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Der Wert 0 ändert die aktuelle Anzeige nicht. Ein Wert, der größer als die aktuelle Anzahl von Ebenen ist, zeigt alle Ebenen an.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parameter

rowLevels: number

Die Anzahl der zeilenebenen einer Gliederung, die angezeigt werden soll.

columnLevels: number

Die Anzahl der anzuzeigenden Spaltenebenen einer Gliederung.

Gibt zurück

void