Excel.Workbook class

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

readonly application: Excel.Application;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet.

readonly autoSave: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

readonly bindings: Excel.BindingCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

readonly calculationEngineVersion: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

context: RequestContext;

Eigenschaftswert

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

readonly customXmlParts: Excel.CustomXmlPartCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.5 ]

Stellt alle Datenverbindungen in der Arbeitsmappe dar.

readonly dataConnections: Excel.DataConnectionCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

readonly functions: Excel.Functions;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.2 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Ruft den Namen der Arbeitsmappe ab.

readonly name: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

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

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

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

readonly previouslySaved: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Ruft die Arbeitsmappeneigenschaften ab.

readonly properties: Excel.DocumentProperties;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

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

readonly protection: Excel.WorkbookProtection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

readonly readOnly: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

readonly settings: Excel.SettingCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.4 ]

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

readonly slicers: Excel.SlicerCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

readonly slicerStyles: Excel.SlicerStyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

readonly styles: Excel.StyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

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

readonly tables: Excel.TableCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

readonly tableStyles: Excel.TableStyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

readonly timelineStyles: Excel.TimelineStyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

readonly worksheets: Excel.WorksheetCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Aktuelle Arbeitsmappe schließen.

close(closeBehavior?: Excel.CloseBehavior): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.close(Excel.CloseBehavior.save);
});

Aktuelle Arbeitsmappe schließen.

close(closeBehaviorString?: "Save" | "SkipSave"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab.

getActiveCell(): Excel.Range;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

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

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Fügt die angegebenen Arbeitsblätter aus einer Quellarbeitsmappe in die aktuelle Arbeitsmappe ein.

Hinweis*: Diese API wird derzeit nur für Office unter Windows, Mac und im Web unterstützt.

insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;

Parameter

Gibt zurück

Ein Array von IDs, die jedem neu eingefügten Arbeitsblatt entsprechen.

Hinweise

[ API-Satz: ExcelApi 1.13 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml

// Retrieve the file and set up an HTML FileReader element. 
const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
    // Remove the metadata before the Base64-encoded string.
    const startIndex = reader.result.toString().indexOf("base64,");
    externalWorkbook = reader.result.toString().substr(startIndex + 7);
};

// Read the file as a data URL so that we can parse the Base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

...

await Excel.run(async (context) => {
    // Retrieve the source workbook.
    const workbook = context.workbook;
    
    // Set up the insert options.
    const options = {
        sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
        positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
        relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
    };
    
    // Insert the new worksheets.
    workbook.insertWorksheetsFromBase64(externalWorkbook, options);
    await context.sync();
});

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Aktuelle Arbeitsmappe speichern.

save(saveBehavior?: Excel.SaveBehavior): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.save(Excel.SaveBehavior.save);
});

Aktuelle Arbeitsmappe speichern.

save(saveBehaviorString?: "Save" | "Prompt"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.11 ]

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

Gibt zurück

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

set(properties: Excel.Workbook): void;

Parameter

Gibt zurück

Ü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

Tritt auf, wenn die Arbeitsmappe aktiviert wird. Hinweis: Dieses Ereignis wird nicht ausgelöst, wenn die Arbeitsmappe geöffnet wird.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.13 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml

async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) {
  await Excel.run(async (context) => {
    // Callback function for when the workbook is activated.
    console.log("The workbook was activated.");
  });
}

...

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

  // Register the workbook activated event handler.
  workbook.onActivated.add(workbookActivated);

  await context.sync();
  console.log("Added event handler for workbook activated.");
});

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Tritt ein, wenn die Auswahl im Dokument geändert wird.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.2 ]