Excel.Workbook class

Stellt die Excel-Anwendungs-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 AutoSpeichern-Modus 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 in den Diagrammen der Index der Datenpunkte nachverfolgt wird.

chartDataPointTrack: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

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

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.10]

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

context: RequestContext;

Eigenschaftswert

Stellt die Sammlung 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 festlegen, wenn Sie eine geänderte Arbeitsmappe schließen möchten, true ohne sie zu speichern oder zum Speichern aufgefordert zu werden.

isDirty: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Gibt eine Auflistung verknüpfter Entitätsdatendomänen zurück, die in der Arbeitsmappe verfügbar sind.

readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.19]

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]

Gibt eine Auflistung aller Notizenobjekte in der Arbeitsmappe zurück.

readonly notes: Excel.NoteCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.18]

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

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.3]

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]

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

readonly protection: Excel.WorkbookProtection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

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

readonly queries: Excel.QueryCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.14]

Gibt zurück true , ob 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 Datenschnitten 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]

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 an Genauigkeit, wenn diese Eigenschaft von false zu truegeändert wird.

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]

Aktuelle Arbeitsmappe schließen.

close(closeBehavior?: "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]

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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getActiveChartOrNullObject(): Excel.Chart;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9]

Ruft das aktive Shape in der Arbeitsmappe ab. Gibt einen ItemNotFound Fehler aus, wenn keine aktive Form vorhanden ist.

getActiveShape(): Excel.Shape;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.19]

Ruft das aktive Shape in der Arbeitsmappe ab. Wenn keine aktive Form vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getActiveShapeOrNullObject(): Excel.Shape;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.19]

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 festgelegt ist true. 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 , ob die Arbeitsmappe von mehreren Benutzern (durch gemeinsame Dokumenterstellung) bearbeitet wird. Beachten Sie, dass es zwischen der Änderung des Status der Arbeitsmappe und der Berücksichtigung der Änderungen im Ergebnis der Methode zu einer gewissen Verzögerung kommen kann.

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9]

Gibt ein Ergebnis LinkedEntityCellValue basierend auf dem angegebenen LinkedEntityIdzurück.

getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.16]

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

getSelectedRange(): Excel.Range;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Ruft die aktuell ausgewählten Bereiche (einen oder mehrere) aus der Arbeitsmappe ab. Im Gegensatz getSelectedRange()zu 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]

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

Der extensionHardening Windows-Registrierungsschlüssel wirkt sich auf diese API aus. Die durch den base64File Parameter definierte Dateierweiterung muss mit dem realen Dateityp der eingefügten Datei übereinstimmen. Wenn extensionHardening die Einstellung auf "Konflikte ablehnen" festgelegt ist und die Dateierweiterung nicht mit dem tatsächlichen Dateityp übereinstimmt, gibt diese API den folgenden Fehler aus: "Dieser Vorgang ist aufgrund der Richtlinie zur Erweiterung zur Härtung der Erweiterung nicht zulässig."

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

Parameter

Gibt zurück

Ein Array von IDs, das jedem neu eingefügten Arbeitsblatt entspricht.

Hinweise

[API-Satz: ExcelApi 1.13]

Diese API wird derzeit nur für Office unter Windows, Mac und im Web unterstützt. In Excel im Web unterstützt diese API nicht das Einfügen von Diagrammen, Kommentaren, PivotTables oder Datenschnitten.

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]

Aktuelle Arbeitsmappe speichern.

save(saveBehavior?: "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 sie übergeben wird.) Während das ursprüngliche Excel.Workbook Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.WorkbookData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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]

Tritt auf, wenn die AutoSpeichern-Einstellung in der 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]