ExcelScript.Workbook interface

Referenz

Paket:: ExcelScript

Arbeitsmappe ist das Objekt der obersten Ebene, das verwandte Arbeitsmappenobjekte wie Arbeitsblätter, Tabellen und Bereiche enthält.

Hinweise

Beispiele

/**
 * This script adds a new worksheet to the workbook, then switches to it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add a new worksheet with the default name.
  let worksheet = workbook.addWorksheet();

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

Methoden

addBinding(range, bindingType, id)	Fügt eine neue Bindung an einen bestimmten Bereich hinzu.
addBindingFromNamedItem(name, bindingType, id)	Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der `InvalidReference` Fehler zurückgegeben.
addBindingFromSelection(bindingType, id)	Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der `InvalidReference` Fehler zurückgegeben.
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.
addCustomXmlPart(xml)	Fügt der Arbeitsmappe eine neue benutzerdefinierte XML-Komponente hinzu.
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.
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.
addPivotTableStyle(name, makeUniqueName)	Erstellt einen leeren `PivotTableStyle` mit dem angegebenen Namen.
addPredefinedCellStyle(name)	Fügt der Sammlung eine neue Formatvorlage hinzu.
addSlicer(slicerSource, sourceField, slicerDestination)	Fügt der Arbeitsmappe einen neuen Datenschnitt hinzu.
addSlicerStyle(name, makeUniqueName)	Erstellt eine leere Slicerformatvorlage mit dem angegebenen Namen.
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.
addTableStyle(name, makeUniqueName)	Erstellt einen leeren `TableStyle` mit dem angegebenen Namen.
addTimelineStyle(name, makeUniqueName)	Erstellt einen leeren `TimelineStyle` mit dem angegebenen Namen.
addWorksheet(name)	Fügt der Arbeitsmappe ein neues Arbeitsblatt hinzu. Das Arbeitsblatt wird automatisch am Ende der vorhandenen Arbeitsblättern hinzugefügt. Wenn Sie das neu hinzugefügte Arbeitsblatt aktivieren möchten, rufen Sie `.activate()` darauf auf.
breakAllLinksToLinkedWorkbooks()	Unterbricht alle Links zu den verknüpften Arbeitsmappen. Sobald die Verknüpfungen unterbrochen sind, werden alle Formeln, die auf Arbeitsmappenverknüpfungen verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt.
getActiveCell()	Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab.
getActiveChart()	Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, gibt diese Methode zurück `undefined`.
getActiveSlicer()	Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, gibt diese Methode zurück `undefined`.
getActiveWorksheet()	Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.
getApplication()	Stellt die Excel-Anwendung instance dar, die diese Arbeitsmappe enthält.
getAutoSave()	Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet.
getBinding(id)	Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getBindings()	Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind.
getCalculationEngineVersion()	Gibt eine Nummer zur Version des Excel-Berechnungsmoduls zurück.
getChartDataPointTrack()	True, wenn alle Diagramme in der Arbeitsmappe die tatsächlichen Datenpunkte nachverfolgen, mit denen sie verbunden sind. False, wenn die Diagramme den Index der Datenpunkte nachverfolgen.
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()	Stellt eine Auflistung von Kommentaren dar, die der Arbeitsmappe zugeordnet sind.
getCustomXmlPart(id)	Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. Wenn nicht `CustomXmlPart` vorhanden ist, gibt diese Methode zurück `undefined`.
getCustomXmlPartByNamespace(namespaceUri)	Ruft eine neue Auflistung von benutzerdefinierten XML-Teilen ab, deren Namespaces mit dem angegebenen Namespace übereinstimmen.
getCustomXmlParts()	Stellt die Auflistung von benutzerdefinierten XML-Teilen dar, die in dieser Arbeitsmappe enthalten sind.
getCustomXmlPartsByNamespace(namespaceUri)	Ruft eine neue Auflistung von benutzerdefinierten XML-Teilen ab, deren Namespaces mit dem angegebenen Namespace übereinstimmen.
getDefaultPivotTableStyle()	Ruft die PivotTable-Standardformatvorlage für den Bereich des übergeordneten Objekts ab.
getDefaultSlicerStyle()	Ruft den Standardwert `SlicerStyle` für den Bereich des übergeordneten Objekts ab.
getDefaultTableStyle()	Ruft die Standardtabellenformatvorlage für den Bereich des übergeordneten Objekts ab.
getDefaultTimelineStyle()	Ruft die Standardformatvorlage Zeitleiste für den Bereich des übergeordneten Objekts ab.
getFirstWorksheet(visibleOnly)	Ruft das erste Arbeitsblatt in der Sammlung ab.
getIsDirty()	Gibt an, ob seit dem letzten Speichern der Arbeitsmappe Änderungen vorgenommen wurden. Sie können diese Eigenschaft auf `true` festlegen, wenn Sie eine geänderte Arbeitsmappe schließen möchten, ohne sie zu speichern oder zum Speichern aufgefordert zu werden.
getLastWorksheet(visibleOnly)	Ruft das letzte Arbeitsblatt in der Sammlung ab.
getLinkedWorkbookByUrl(key)	Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getLinkedWorkbookRefreshMode()	Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch.
getLinkedWorkbooks()	Gibt eine Auflistung verknüpfter Arbeitsmappen zurück. In Formeln können die Arbeitsmappenverknüpfungen verwendet werden, um auf Daten (Zellwerte und Namen) außerhalb der aktuellen Arbeitsmappe zu verweisen.
getName()	Ruft den Namen der Arbeitsmappe ab.
getNamedItem(name)	Ruft ein `NamedItem` -Objekt unter Verwendung seines Namens ab. Wenn das Objekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getNames()	Stellt eine Auflistung von benannten Elementen im Arbeitsmappenbereich (benannte Bereiche und Konstanten) dar.
getPivotTable(name)	Ruft eine PivotTable anhand des Namens ab. Wenn die PivotTable nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getPivotTables()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften PivotTables dar.
getPivotTableStyle(name)	Ruft einen `PivotTableStyle` anhand des Namens ab. Wenn nicht `PivotTableStyle` vorhanden ist, gibt diese Methode zurück `undefined`.
getPivotTableStyles()	Stellt eine Sammlung der mit der Arbeitsmappe verknüpften PivotTableStyles dar.
getPredefinedCellStyle(name)	Ruft eine Formatvorlage anhand des Namens ab. Wenn das Stilobjekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getPredefinedCellStyles()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Formatvorlagen dar.
getPreviouslySaved()	Gibt an, ob die Arbeitsmappe jemals lokal oder online gespeichert wurde.
getProperties()	Ruft die Arbeitsmappeneigenschaften ab.
getProtection()	Gibt das Schutzobjekt für eine Arbeitsmappe zurück.
getQueries()	Gibt eine Auflistung von Power Query Abfragen zurück, die Teil der Arbeitsmappe sind.
getQuery(key)	Ruft eine Abfrage aus der Auflistung basierend auf ihrem Namen ab.
getReadOnly()	Gibt zurück `true` , wenn die Arbeitsmappe im schreibgeschützten Modus geöffnet ist.
getSelectedRange()	Ruft den aktuell ausgewählten einzelnen Bereich aus der Arbeitsmappe ab. Wenn mehrere Bereiche ausgewählt sind, löst diese Methode einen Fehler aus.
getSelectedRanges()	Ruft die aktuell ausgewählten Bereiche (einen oder mehrere) aus der Arbeitsmappe ab. Im Gegensatz zu `getSelectedRange()`gibt diese Methode ein `RangeAreas` -Objekt zurück, das alle ausgewählten Bereiche darstellt.
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()	Stellt eine Auflistung von Slicern dar, die der Arbeitsmappe zugeordnet sind.
getSlicerStyle(name)	Ruft einen `SlicerStyle` anhand des Namens ab. Wenn der Slicerstil nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getSlicerStyles()	Stellt eine Sammlung der mit der Arbeitsmappe verknüpften SlicerStyles dar.
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()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar.
getTableStyle(name)	Ruft einen `TableStyle` anhand des Namens ab. Wenn die Tabellenformatvorlage nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getTableStyles()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TableStyles dar.
getTimelineStyle(name)	Ruft einen `TimelineStyle` anhand des Namens ab. Wenn die Zeitleiste-Formatvorlage nicht vorhanden ist, gibt diese Methode zurück`undefined`.
getTimelineStyles()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TimelineStyles dar.
getUsePrecisionAsDisplayed()	True, wenn die Berechnungen in dieser Arbeitsmappe nur mit der Genauigkeit durchgeführt werden, mit der die Zahlen angezeigt werden. Daten verlieren dauerhaft die Genauigkeit, wenn diese Eigenschaft von zu `true`wechselt`false`.
getWorksheet(key)	Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getWorksheets()	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar.
refreshAllDataConnections()	Aktualisiert alle Daten Connections.
refreshAllLinksToLinkedWorkbooks()	Sendet eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.
refreshAllPivotTables()	Aktualisiert alle PivotTables in der Sammlung.
setChartDataPointTrack(chartDataPointTrack)	True, wenn alle Diagramme in der Arbeitsmappe die tatsächlichen Datenpunkte nachverfolgen, mit denen sie verbunden sind. False, wenn die Diagramme den Index der Datenpunkte nachverfolgen.
setDefaultPivotTableStyle(newDefaultStyle)	Legt die Standardmäßige PivotTable-Formatvorlage für die Verwendung im Bereich des übergeordneten Objekts fest.
setDefaultSlicerStyle(newDefaultStyle)	Legt den Standardschnittstil für die Verwendung im Bereich des übergeordneten Objekts fest.
setDefaultTableStyle(newDefaultStyle)	Legt die Standardtabellenformatvorlage für die Verwendung im Bereich des übergeordneten Objekts fest.
setDefaultTimelineStyle(newDefaultStyle)	Legt die Standardformatvorlage Zeitleiste fest, die im Bereich des übergeordneten Objekts verwendet werden soll.
setIsDirty(isDirty)	Gibt an, ob seit dem letzten Speichern der Arbeitsmappe Änderungen vorgenommen wurden. Sie können diese Eigenschaft auf `true` festlegen, wenn Sie eine geänderte Arbeitsmappe schließen möchten, ohne sie zu speichern oder zum Speichern aufgefordert zu werden.
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch.
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	True, wenn die Berechnungen in dieser Arbeitsmappe nur mit der Genauigkeit durchgeführt werden, mit der die Zahlen angezeigt werden. Daten verlieren dauerhaft die Genauigkeit, wenn diese Eigenschaft von zu `true`wechselt`false`.

Details zur Methode

addBinding(range, bindingType, id)

Fügt eine neue Bindung an einen bestimmten Bereich hinzu.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parameter

range: ExcelScript.Range | string

Bereich für die Bindung. Kann ein Range Objekt oder eine Zeichenfolge sein. Eine Zeichenfolge muss die vollständige Adresse einschließlich des Blattnamens enthalten.

bindingType: ExcelScript.BindingType

Typ der Bindung. Weitere Informationen finden Sie unter ExcelScript.BindingType.

id: string

Name der Bindung.

Gibt zurück

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

Fügt eine neue Bindung auf Grundlage eines benannten Elements in der Arbeitsmappe hinzu. Wenn das benannte Element auf mehrere Bereiche verweist, wird der InvalidReference Fehler zurückgegeben.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Parameter

name: string

Name, aus dem die Bindung erstellt wird.

bindingType: ExcelScript.BindingType

Typ der Bindung. Weitere Informationen finden Sie unter ExcelScript.BindingType.

id: string

Name der Bindung.

Gibt zurück

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

Fügt eine neue Bindung basierend auf der aktuellen Auswahl hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der InvalidReference Fehler zurückgegeben.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Parameter

bindingType: ExcelScript.BindingType

Typ der Bindung. Weitere Informationen finden Sie unter ExcelScript.BindingType.

id: string

Name der Bindung.

Gibt zurück

ExcelScript.Binding

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

addCustomXmlPart(xml)

Fügt der Arbeitsmappe eine neue benutzerdefinierte XML-Komponente hinzu.

addCustomXmlPart(xml: string): CustomXmlPart;

Parameter

xml: string

XML-Inhalt. Muss ein gültiges XML-Fragment sein.

Gibt zurück

ExcelScript.CustomXmlPart

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

Beispiele

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

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

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

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 an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
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];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

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

addPivotTableStyle(name, makeUniqueName)

Erstellt einen leeren PivotTableStyle mit dem angegebenen Namen.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Parameter

name: string

Der eindeutige Name für die neue PivotTable-Formatvorlage. Löst einen Fehler aus InvalidArgument , wenn der Name bereits verwendet wird.

makeUniqueName: boolean

Optional. Der Standardwert ist false. Bei truefügt bei Bedarf Zahlen an den Namen an, um ihn eindeutig zu machen.

Gibt zurück

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

Fügt der Sammlung eine neue Formatvorlage hinzu.

addPredefinedCellStyle(name: string): void;

Parameter

name: string

Name der hinzuzufügenden Formatvorlage.

Gibt zurück

void

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.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

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

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

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

addSlicerStyle(name, makeUniqueName)

Erstellt eine leere Slicerformatvorlage mit dem angegebenen Namen.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Parameter

name: string

Der eindeutige Name für das neue Datenschnittformat. Löst eine Ausnahme aus InvalidArgument , wenn der Name bereits verwendet wird.

makeUniqueName: boolean

Optional. Der Standardwert ist false. Bei truefügt bei Bedarf Zahlen an den Namen an, um ihn eindeutig zu machen.

Gibt zurück

ExcelScript.SlicerStyle

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 converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

addTableStyle(name, makeUniqueName)

Erstellt einen leeren TableStyle mit dem angegebenen Namen.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Parameter

name: string

Der eindeutige Name für die neue Tabellenformatvorlage. Löst einen Fehler aus InvalidArgument , wenn der Name bereits verwendet wird.

makeUniqueName: boolean

Optional. Der Standardwert ist false. Bei truefügt bei Bedarf Zahlen an den Namen an, um ihn eindeutig zu machen.

Gibt zurück

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

Erstellt einen leeren TimelineStyle mit dem angegebenen Namen.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Parameter

name: string

Der eindeutige Name für die neue Zeitleiste Formatvorlage. Löst einen Fehler aus InvalidArgument , wenn der Name bereits verwendet wird.

makeUniqueName: boolean

Optional. Der Standardwert ist false. Bei truefügt bei Bedarf Zahlen an den Namen an, um ihn eindeutig zu machen.

Gibt zurück

ExcelScript.TimelineStyle

addWorksheet(name)

Fügt der Arbeitsmappe ein neues Arbeitsblatt hinzu. Das Arbeitsblatt wird automatisch am Ende der vorhandenen Arbeitsblättern hinzugefügt. Wenn Sie das neu hinzugefügte Arbeitsblatt aktivieren möchten, rufen Sie .activate() darauf auf.

addWorksheet(name?: string): Worksheet;

Parameter

name: string

Optional. Der Name des hinzuzufügenden Arbeitsblatts. Falls angegeben, sollte der Name eindeutig sein. Falls nicht angegeben, bestimmt Excel den Namen des neuen Arbeitsblatts.

Gibt zurück

ExcelScript.Worksheet

Beispiele

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

breakAllLinksToLinkedWorkbooks()

Unterbricht alle Links zu den verknüpften Arbeitsmappen. Sobald die Verknüpfungen unterbrochen sind, werden alle Formeln, die auf Arbeitsmappenverknüpfungen verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt.

breakAllLinksToLinkedWorkbooks(): void;

Gibt zurück

void

getActiveCell()

Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab.

getActiveCell(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

getActiveChart()

Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, gibt diese Methode zurück undefined.

getActiveChart(): Chart;

Gibt zurück

ExcelScript.Chart

getActiveSlicer()

Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, gibt diese Methode zurück undefined.

getActiveSlicer(): Slicer;

Gibt zurück

ExcelScript.Slicer

getActiveWorksheet()

Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.

getActiveWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

getApplication()

Stellt die Excel-Anwendung instance dar, die diese Arbeitsmappe enthält.

getApplication(): Application;

Gibt zurück

ExcelScript.Application

getAutoSave()

Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet.

getAutoSave(): boolean;

Gibt zurück

boolean

getBinding(id)

Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getBinding(id: string): Binding | undefined;

Parameter

id: string

ID des abzurufenden Binding-Objekts.

Gibt zurück

ExcelScript.Binding | undefined

getBindings()

Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind.

getBindings(): Binding[];

Gibt zurück

ExcelScript.Binding[]

getCalculationEngineVersion()

Gibt eine Nummer zur Version des Excel-Berechnungsmoduls zurück.

getCalculationEngineVersion(): number;

Gibt zurück

number

getChartDataPointTrack()

True, wenn alle Diagramme in der Arbeitsmappe die tatsächlichen Datenpunkte nachverfolgen, mit denen sie verbunden sind. False, wenn die Diagramme den Index der Datenpunkte nachverfolgen.

getChartDataPointTrack(): boolean;

Gibt zurück

boolean

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

Stellt eine Auflistung von Kommentaren dar, die der Arbeitsmappe zugeordnet sind.

getComments(): Comment[];

Gibt zurück

ExcelScript.Comment[]

getCustomXmlPart(id)

Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. Wenn nicht CustomXmlPart vorhanden ist, gibt diese Methode zurück undefined.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Parameter

id: string

ID des abzurufenden Objekts.

Gibt zurück

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Warnung

Diese API ist nun veraltet.

Use getCustomXmlPartsByNamespace instead.

Ruft eine neue Auflistung von benutzerdefinierten XML-Teilen ab, deren Namespaces mit dem angegebenen Namespace übereinstimmen.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Parameter

namespaceUri: string

Hierbei muss es sich um einen vollqualifizierten Schema-URI handeln. Beispiel: "http://schemas.contoso.com/review/1.0".

Gibt zurück

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

Stellt die Auflistung von benutzerdefinierten XML-Teilen dar, die in dieser Arbeitsmappe enthalten sind.

getCustomXmlParts(): CustomXmlPart[];

Gibt zurück

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

Ruft eine neue Auflistung von benutzerdefinierten XML-Teilen ab, deren Namespaces mit dem angegebenen Namespace übereinstimmen.

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

Parameter

namespaceUri: string

Hierbei muss es sich um einen vollqualifizierten Schema-URI handeln. Beispiel: "http://schemas.contoso.com/review/1.0".

Gibt zurück

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

Ruft die PivotTable-Standardformatvorlage für den Bereich des übergeordneten Objekts ab.

getDefaultPivotTableStyle(): PivotTableStyle;

Gibt zurück

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

Ruft den Standardwert SlicerStyle für den Bereich des übergeordneten Objekts ab.

getDefaultSlicerStyle(): SlicerStyle;

Gibt zurück

ExcelScript.SlicerStyle

getDefaultTableStyle()

Ruft die Standardtabellenformatvorlage für den Bereich des übergeordneten Objekts ab.

getDefaultTableStyle(): TableStyle;

Gibt zurück

ExcelScript.TableStyle

getDefaultTimelineStyle()

Ruft die Standardformatvorlage Zeitleiste für den Bereich des übergeordneten Objekts ab.

getDefaultTimelineStyle(): TimelineStyle;

Gibt zurück

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

Ruft das erste Arbeitsblatt in der Sammlung ab.

getFirstWorksheet(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

getIsDirty()

Gibt an, ob seit dem letzten Speichern der Arbeitsmappe Änderungen vorgenommen wurden. Sie können diese Eigenschaft auf true festlegen, wenn Sie eine geänderte Arbeitsmappe schließen möchten, ohne sie zu speichern oder zum Speichern aufgefordert zu werden.

getIsDirty(): boolean;

Gibt zurück

boolean

getLastWorksheet(visibleOnly)

Ruft das letzte Arbeitsblatt in der Sammlung ab.

getLastWorksheet(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

getLinkedWorkbookByUrl(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Methode zurück undefined.

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Parameter

key: string

Die URL der verknüpften Arbeitsmappe.

Gibt zurück

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch.

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

Gibt zurück

ExcelScript.WorkbookLinksRefreshMode

Beispiele

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }

getLinkedWorkbooks()

Gibt eine Auflistung verknüpfter Arbeitsmappen zurück. In Formeln können die Arbeitsmappenverknüpfungen verwendet werden, um auf Daten (Zellwerte und Namen) außerhalb der aktuellen Arbeitsmappe zu verweisen.

getLinkedWorkbooks(): LinkedWorkbook[];

Gibt zurück

ExcelScript.LinkedWorkbook[]

Beispiele

/**
 * This script removes all links to other workbooks.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get all the linked workbook references.
    const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
    console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);

    // Remove all the links to those workbooks.
    // This changes the value of cells with workbook links to "#CONNECT!".
    externalWorkbooks.forEach((workbookLink) => {
        workbookLink.breakLinks();
    });
}

getName()

Ruft den Namen der Arbeitsmappe ab.

getName(): string;

Gibt zurück

string

Beispiele

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

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

getNames()

Stellt eine Auflistung von benannten Elementen im Arbeitsmappenbereich (benannte Bereiche und Konstanten) dar.

getNames(): NamedItem[];

Gibt zurück

ExcelScript.NamedItem[]

Beispiele

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

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

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften PivotTables dar.

getPivotTables(): PivotTable[];

Gibt zurück

ExcelScript.PivotTable[]

getPivotTableStyle(name)

Ruft einen PivotTableStyle anhand des Namens ab. Wenn nicht PivotTableStyle vorhanden ist, gibt diese Methode zurück undefined.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Parameter

name: string

Name des abzurufenden PivotTable-Stils.

Gibt zurück

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

Stellt eine Sammlung der mit der Arbeitsmappe verknüpften PivotTableStyles dar.

getPivotTableStyles(): PivotTableStyle[];

Gibt zurück

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

Ruft eine Formatvorlage anhand des Namens ab. Wenn das Stilobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

Parameter

name: string

Der Name des abzurufenden Stils.

Gibt zurück

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Formatvorlagen dar.

getPredefinedCellStyles(): PredefinedCellStyle[];

Gibt zurück

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

Gibt an, ob die Arbeitsmappe jemals lokal oder online gespeichert wurde.

getPreviouslySaved(): boolean;

Gibt zurück

boolean

getProperties()

Ruft die Arbeitsmappeneigenschaften ab.

getProperties(): DocumentProperties;

Gibt zurück

ExcelScript.DocumentProperties

getProtection()

Gibt das Schutzobjekt für eine Arbeitsmappe zurück.

getProtection(): WorkbookProtection;

Gibt zurück

ExcelScript.WorkbookProtection

Beispiele

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

getQueries()

Gibt eine Auflistung von Power Query Abfragen zurück, die Teil der Arbeitsmappe sind.

getQueries(): Query[];

Gibt zurück

ExcelScript.Query[]

getQuery(key)

Ruft eine Abfrage aus der Auflistung basierend auf ihrem Namen ab.

getQuery(key: string): Query;

Parameter

key: string

Der Name der Abfrage, bei der die Groß-/Kleinschreibung nicht beachtet wird.

Gibt zurück

ExcelScript.Query

getReadOnly()

Gibt zurück true , wenn die Arbeitsmappe im schreibgeschützten Modus geöffnet ist.

getReadOnly(): boolean;

Gibt zurück

boolean

getSelectedRange()

Ruft den aktuell ausgewählten einzelnen Bereich aus der Arbeitsmappe ab. Wenn mehrere Bereiche ausgewählt sind, löst diese Methode einen Fehler aus.

getSelectedRange(): Range;

Gibt zurück

ExcelScript.Range

getSelectedRanges()

Ruft die aktuell ausgewählten Bereiche (einen oder mehrere) aus der Arbeitsmappe ab. Im Gegensatz zu getSelectedRange()gibt diese Methode ein RangeAreas -Objekt zurück, das alle ausgewählten Bereiche darstellt.

getSelectedRanges(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

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

Stellt eine Auflistung von Slicern dar, die der Arbeitsmappe zugeordnet sind.

getSlicers(): Slicer[];

Gibt zurück

ExcelScript.Slicer[]

getSlicerStyle(name)

Ruft einen SlicerStyle anhand des Namens ab. Wenn der Slicerstil nicht vorhanden ist, gibt diese Methode zurück undefined.

getSlicerStyle(name: string): SlicerStyle | undefined;

Parameter

name: string

Der Name des abzurufenden Slicerformats.

Gibt zurück

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

Stellt eine Sammlung der mit der Arbeitsmappe verknüpften SlicerStyles dar.

getSlicerStyles(): SlicerStyle[];

Gibt zurück

ExcelScript.SlicerStyle[]

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

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar.

getTables(): Table[];

Gibt zurück

ExcelScript.Table[]

getTableStyle(name)

Ruft einen TableStyle anhand des Namens ab. Wenn die Tabellenformatvorlage nicht vorhanden ist, gibt diese Methode zurück undefined.

getTableStyle(name: string): TableStyle | undefined;

Parameter

name: string

Der Name des abzurufenden Tabellenformats.

Gibt zurück

ExcelScript.TableStyle | undefined

getTableStyles()

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TableStyles dar.

getTableStyles(): TableStyle[];

Gibt zurück

ExcelScript.TableStyle[]

getTimelineStyle(name)

Ruft einen TimelineStyle anhand des Namens ab. Wenn die Zeitleiste-Formatvorlage nicht vorhanden ist, gibt diese Methode zurückundefined.

getTimelineStyle(name: string): TimelineStyle | undefined;

Parameter

name: string

Der Name des abzurufenden Zeitleiste Stils.

Gibt zurück

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TimelineStyles dar.

getTimelineStyles(): TimelineStyle[];

Gibt zurück

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

True, wenn die Berechnungen in dieser Arbeitsmappe nur mit der Genauigkeit durchgeführt werden, mit der die Zahlen angezeigt werden. Daten verlieren dauerhaft die Genauigkeit, wenn diese Eigenschaft von zu truewechseltfalse.

getUsePrecisionAsDisplayed(): boolean;

Gibt zurück

boolean

getWorksheet(key)

Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode zurück undefined.

getWorksheet(key: string): Worksheet | undefined;

Parameter

key: string

Der Name oder die ID des Arbeitsblatts.

Gibt zurück

ExcelScript.Worksheet | undefined

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.`);
  }
}

getWorksheets()

Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar.

getWorksheets(): Worksheet[];

Gibt zurück

ExcelScript.Worksheet[]

Beispiele

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

refreshAllDataConnections()

Aktualisiert alle Daten Connections.

refreshAllDataConnections(): void;

Gibt zurück

void

refreshAllLinksToLinkedWorkbooks()

Sendet eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.

refreshAllLinksToLinkedWorkbooks(): void;

Gibt zurück

void

refreshAllPivotTables()

Aktualisiert alle PivotTables in der Sammlung.

refreshAllPivotTables(): void;

Gibt zurück

void

setChartDataPointTrack(chartDataPointTrack)

True, wenn alle Diagramme in der Arbeitsmappe die tatsächlichen Datenpunkte nachverfolgen, mit denen sie verbunden sind. False, wenn die Diagramme den Index der Datenpunkte nachverfolgen.

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Parameter

chartDataPointTrack: boolean

Gibt zurück

void

setDefaultPivotTableStyle(newDefaultStyle)

Legt die Standardmäßige PivotTable-Formatvorlage für die Verwendung im Bereich des übergeordneten Objekts fest.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Parameter

newDefaultStyle: ExcelScript.PivotTableStyle | string

Das PivotTableStyle Objekt oder der Name des PivotTableStyle Objekts, das die neue Standardeinstellung sein sollte.

Gibt zurück

void

setDefaultSlicerStyle(newDefaultStyle)

Legt den Standardschnittstil für die Verwendung im Bereich des übergeordneten Objekts fest.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Parameter

newDefaultStyle: ExcelScript.SlicerStyle | string

Das SlicerStyle Objekt oder der Name des SlicerStyle Objekts, das die neue Standardeinstellung sein sollte.

Gibt zurück

void

setDefaultTableStyle(newDefaultStyle)

Legt die Standardtabellenformatvorlage für die Verwendung im Bereich des übergeordneten Objekts fest.

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Parameter

newDefaultStyle: ExcelScript.TableStyle | string

Das TableStyle Objekt oder der Name des TableStyle Objekts, das die neue Standardeinstellung sein sollte.

Gibt zurück

void

setDefaultTimelineStyle(newDefaultStyle)

Legt die Standardformatvorlage Zeitleiste fest, die im Bereich des übergeordneten Objekts verwendet werden soll.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Parameter

newDefaultStyle: ExcelScript.TimelineStyle | string

Das TimelineStyle Objekt oder der Name des TimelineStyle Objekts, das die neue Standardeinstellung sein sollte.

Gibt zurück

void

setIsDirty(isDirty)

setIsDirty(isDirty: boolean): void;

Parameter

isDirty: boolean

Gibt zurück

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch.

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

Parameter

linkedWorkbookRefreshMode: ExcelScript.WorkbookLinksRefreshMode

Gibt zurück

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Parameter

usePrecisionAsDisplayed: boolean

Gibt zurück

void

Freigeben über

ExcelScript.Workbook interface

Hinweise

Beispiele

Methoden

Details zur Methode

addBinding(range, bindingType, id)

Parameter

Gibt zurück

addBindingFromNamedItem(name, bindingType, id)

Parameter

Gibt zurück

addBindingFromSelection(bindingType, id)

Parameter

Gibt zurück

addComment(cellAddress, content, contentType)

Parameter

Gibt zurück

addCustomXmlPart(xml)

Parameter

Gibt zurück

addNamedItem(name, reference, comment)

Parameter

Gibt zurück

Beispiele

addNamedItemFormulaLocal(name, formula, comment)

Parameter

Gibt zurück

addPivotTable(name, source, destination)

Parameter

Gibt zurück

Beispiele

addPivotTableStyle(name, makeUniqueName)

Parameter

Gibt zurück

addPredefinedCellStyle(name)

Parameter

Gibt zurück

addSlicer(slicerSource, sourceField, slicerDestination)

Parameter

Gibt zurück

Beispiele

addSlicerStyle(name, makeUniqueName)

Parameter

Gibt zurück

addTable(address, hasHeaders)

Parameter

Gibt zurück

Beispiele

addTableStyle(name, makeUniqueName)

Parameter

Gibt zurück

addTimelineStyle(name, makeUniqueName)

Parameter

Gibt zurück

addWorksheet(name)

Parameter

Gibt zurück

Beispiele

breakAllLinksToLinkedWorkbooks()

Gibt zurück

getActiveCell()

Gibt zurück

Beispiele

getActiveChart()

Gibt zurück

getActiveSlicer()

Gibt zurück

getActiveWorksheet()

Gibt zurück

getApplication()

Gibt zurück

getAutoSave()

Gibt zurück

getBinding(id)

Parameter

Gibt zurück

getBindings()

Gibt zurück

getCalculationEngineVersion()