Excel. Workbook class

Eigenschaften

application	Stellt die Excel-Anwendung instance dar, die diese Arbeitsmappe enthält.
autoSave	Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet.
bindings	Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind.
calculationEngineVersion	Gibt eine Nummer zur Version des Excel-Berechnungsmoduls zurück.
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.
comments	Stellt eine Auflistung von Kommentaren dar, die der Arbeitsmappe zugeordnet sind.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
customXmlParts	Stellt die Auflistung von benutzerdefinierten XML-Teilen dar, die in dieser Arbeitsmappe enthalten sind.
dataConnections	Stellt alle Datenverbindungen in der Arbeitsmappe dar.
functions	Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können.
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.
name	Ruft den Namen der Arbeitsmappe ab.
names	Stellt eine Auflistung von benannten Elementen im Arbeitsmappenbereich (benannte Bereiche und Konstanten) dar.
pivotTables	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften PivotTables dar.
pivotTableStyles	Stellt eine Sammlung der mit der Arbeitsmappe verknüpften PivotTableStyles dar.
previouslySaved	Gibt an, ob die Arbeitsmappe jemals lokal oder online gespeichert wurde.
properties	Ruft die Arbeitsmappeneigenschaften ab.
protection	Gibt das Schutzobjekt für eine Arbeitsmappe zurück.
readOnly	Gibt zurück `true` , wenn die Arbeitsmappe im schreibgeschützten Modus geöffnet ist.
settings	Stellt eine Auflistung von Einstellungen dar, die der Arbeitsmappe zugeordnet sind.
slicers	Stellt eine Auflistung von Slicern dar, die der Arbeitsmappe zugeordnet sind.
slicerStyles	Stellt eine Sammlung der mit der Arbeitsmappe verknüpften SlicerStyles dar.
styles	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Formatvorlagen dar.
tables	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar.
tableStyles	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TableStyles dar.
timelineStyles	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TimelineStyles dar.
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`.
worksheets	Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar.

Methoden

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, wird eine `ItemNotFound` Ausnahme ausgelöst.
getActiveChartOrNullObject()	Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getActiveSlicer()	Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, wird eine `ItemNotFound` Ausnahme ausgelöst.
getActiveSlicerOrNullObject()	Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getIsActiveCollabSession()	Gibt zurück `true` , wenn die Arbeitsmappe von mehreren Benutzern (durch gemeinsame Dokumenterstellung) bearbeitet wird. Beachten Sie, dass es zwischen änderungen an der Arbeitsmappe status und dem Ergebnis der Methode zu einer gewissen Verzögerung kommen kann.
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.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche `Excel.Workbook` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.WorkbookData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Ereignisse

onAutoSaveSettingChanged	Tritt auf, wenn die Einstellung AutoSpeichern für die Arbeitsmappe geändert wird.
onSelectionChanged	Tritt ein, wenn die Auswahl im Dokument geändert wird.

Details zur Eigenschaft

application

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

readonly application: Excel.Application;

Eigenschaftswert

Excel.Application

Hinweise

autoSave

Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet.

readonly autoSave: boolean;

Eigenschaftswert

boolean

Hinweise

bindings

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

readonly bindings: Excel.BindingCollection;

Eigenschaftswert

Excel.BindingCollection

Hinweise

calculationEngineVersion

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

readonly calculationEngineVersion: number;

Eigenschaftswert

number

Hinweise

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.

chartDataPointTrack: boolean;

Eigenschaftswert

boolean

Hinweise

comments

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

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Excel.CommentCollection

Hinweise

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

customXmlParts

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

readonly customXmlParts: Excel.CustomXmlPartCollection;

Eigenschaftswert

Excel.CustomXmlPartCollection

Hinweise

[ API-Satz: ExcelApi 1.5 ]

dataConnections

Stellt alle Datenverbindungen in der Arbeitsmappe dar.

readonly dataConnections: Excel.DataConnectionCollection;

Eigenschaftswert

Excel.DataConnectionCollection

Hinweise

functions

Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können.

readonly functions: Excel.Functions;

Eigenschaftswert

Excel.Functions

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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.

isDirty: boolean;

Eigenschaftswert

boolean

Hinweise

name

Ruft den Namen der Arbeitsmappe ab.

readonly name: string;

Eigenschaftswert

string

Hinweise

names

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

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Excel.NamedItemCollection

Hinweise

pivotTables

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

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

Excel.PivotTableCollection

Hinweise

[ API-Satz: ExcelApi 1.3 ]

Beispiele

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

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the workbook.
  const pivotTables = context.workbook.pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the workbook:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

pivotTableStyles

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

Eigenschaftswert

Excel.PivotTableStyleCollection

Hinweise

previouslySaved

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

readonly previouslySaved: boolean;

Eigenschaftswert

boolean

Hinweise

properties

Ruft die Arbeitsmappeneigenschaften ab.

readonly properties: Excel.DocumentProperties;

Eigenschaftswert

Excel.DocumentProperties

Hinweise

Beispiele

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

await Excel.run(async (context) => {
    let titleValue = "Excel document properties API";
    let subjectValue = "Set and get document properties";
    let keywordsValue = "Set and get operations";
    let commentsValue = "This is an Excel document properties API code sample";
    let categoryValue = "Office Add-ins";
    let managerValue = "John";
    let companyValue = "Microsoft";

    let docProperties = context.workbook.properties;

    // Set the writeable document properties.
    docProperties.title = titleValue;
    docProperties.subject = subjectValue;
    docProperties.keywords = keywordsValue;
    docProperties.comments = commentsValue;
    docProperties.category = categoryValue;
    docProperties.manager = managerValue;
    docProperties.company = companyValue;

    await context.sync();

    console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});

protection

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

readonly protection: Excel.WorkbookProtection;

Eigenschaftswert

Excel.WorkbookProtection

Hinweise

readOnly

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

readonly readOnly: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

settings

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

readonly settings: Excel.SettingCollection;

Eigenschaftswert

Excel.SettingCollection

Hinweise

[ API-Satz: ExcelApi 1.4 ]

slicers

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

readonly slicers: Excel.SlicerCollection;

Eigenschaftswert

Excel.SlicerCollection

Hinweise

slicerStyles

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

readonly slicerStyles: Excel.SlicerStyleCollection;

Eigenschaftswert

Excel.SlicerStyleCollection

Hinweise

styles

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

readonly styles: Excel.StyleCollection;

Eigenschaftswert

Excel.StyleCollection

Hinweise

Beispiele

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

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

tables

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

readonly tables: Excel.TableCollection;

Eigenschaftswert

Excel.TableCollection

Hinweise

tableStyles

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

readonly tableStyles: Excel.TableStyleCollection;

Eigenschaftswert

Excel.TableStyleCollection

Hinweise

timelineStyles

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

readonly timelineStyles: Excel.TimelineStyleCollection;

Eigenschaftswert

Excel.TimelineStyleCollection

Hinweise

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

usePrecisionAsDisplayed: boolean;

Eigenschaftswert

boolean

Hinweise

worksheets

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

readonly worksheets: Excel.WorksheetCollection;

Eigenschaftswert

Excel.WorksheetCollection

Hinweise

Details zur Methode

getActiveCell()

Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab.

getActiveCell(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml

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

    let myWorkbook = context.workbook;
    let activeCell = myWorkbook.getActiveCell();
    activeCell.load("address");

    await context.sync();
    
    console.log("The active cell is " + activeCell.address);
});

getActiveChart()

Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, wird eine ItemNotFound Ausnahme ausgelöst.

getActiveChart(): Excel.Chart;

Gibt zurück

Excel.Chart

Hinweise

getActiveChartOrNullObject()

Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getActiveChartOrNullObject(): Excel.Chart;

Gibt zurück

Excel.Chart

Hinweise

getActiveSlicer()

Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, wird eine ItemNotFound Ausnahme ausgelöst.

getActiveSlicer(): Excel.Slicer;

Gibt zurück

Excel.Slicer

Hinweise

getActiveSlicerOrNullObject()

Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getActiveSlicerOrNullObject(): Excel.Slicer;

Gibt zurück

Excel.Slicer

Hinweise

getIsActiveCollabSession()

Gibt zurück true , wenn die Arbeitsmappe von mehreren Benutzern (durch gemeinsame Dokumenterstellung) bearbeitet wird. Beachten Sie, dass es zwischen änderungen an der Arbeitsmappe status und dem Ergebnis der Methode zu einer gewissen Verzögerung kommen kann.

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

OfficeExtension.ClientResult<boolean>

Hinweise

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

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

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(): Excel.RangeAreas;

Gibt zurück

Excel.RangeAreas

Hinweise

OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>

Beispiele

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

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

    const selectedRanges = context.workbook.getSelectedRanges();
    selectedRanges.format.fill.color = "lightblue";

    await context.sync();
})

load(options)

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

load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;

Parameter

options: Excel.Interfaces.WorkbookLoadOptions

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

Gibt zurück

Excel.Workbook

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.Workbook;

Parameter

propertyNames: string | string[]

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

Gibt zurück

Excel.Workbook

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Workbook;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.Workbook

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.WorkbookUpdateData

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

options: OfficeExtension.UpdateOptions

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

Gibt zurück

void

set(properties)

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

set(properties: Excel.Workbook): void;

Parameter

properties: Excel.Workbook

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Workbook Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorkbookData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.WorkbookData;

Gibt zurück

Excel.Interfaces.WorkbookData

Details zum Ereignis

onAutoSaveSettingChanged

Tritt auf, wenn die Einstellung AutoSpeichern für die Arbeitsmappe geändert wird.

readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;

Ereignistyp

Hinweise