Excel.Workbook class
Arbeitsmappe ist das Objekt der obersten Ebene, das verwandte Arbeitsmappenobjekte wie Arbeitsblätter, Tabellen und Bereiche enthält. Weitere Informationen zum Arbeitsmappenobjektmodell finden Sie unter Arbeiten mit Arbeitsmappen mithilfe der Excel-JavaScript-API.
- Extends
Hinweise
Eigenschaften
| application | Stellt die Excel-Anwendung instance dar, die diese Arbeitsmappe enthält. |
| auto |
Gibt an, ob sich die Arbeitsmappe im AutoSpeichermodus befindet. |
| bindings | Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind. |
| calculation |
Gibt eine Nummer zur Version des Excel-Berechnungsmoduls zurück. |
| chart |
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. |
| custom |
Stellt die Auflistung von benutzerdefinierten XML-Teilen dar, die in dieser Arbeitsmappe enthalten sind. |
| data |
Stellt alle Datenverbindungen in der Arbeitsmappe dar. |
| external |
Gibt die maximale Zeitdauer in Sekunden an, die einer Formel zugewiesen wird, die von einem externen Codedienst abhängig ist. Der gültige Bereich ist 1 bis einschließlich 86400. |
| functions | Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können. |
| is |
Gibt an, ob seit dem letzten Speichern der Arbeitsmappe Änderungen vorgenommen wurden. Sie können diese Eigenschaft auf |
| linked |
Gibt eine Auflistung verknüpfter Datentypen zurück, die Teil der Arbeitsmappe sind. |
| linked |
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. |
| name | Ruft den Namen der Arbeitsmappe ab. |
| names | Stellt eine Auflistung von benannten Elementen im Arbeitsmappenbereich (benannte Bereiche und Konstanten) dar. |
| pivot |
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften PivotTables dar. |
| pivot |
Stellt eine Sammlung der mit der Arbeitsmappe verknüpften PivotTableStyles dar. |
| previously |
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. |
| queries | Gibt eine Auflistung von Power Query Abfragen zurück, die Teil der Arbeitsmappe sind. |
| read |
Gibt zurück |
| settings | Stellt eine Auflistung von Einstellungen dar, die der Arbeitsmappe zugeordnet sind. |
| show |
Gibt an, ob der Feldlistenbereich der PivotTable auf Arbeitsmappenebene angezeigt wird. |
| slicers | Stellt eine Auflistung von Slicern dar, die der Arbeitsmappe zugeordnet sind. |
| slicer |
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. |
| table |
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TableStyles dar. |
| tasks | Gibt eine Auflistung von Aufgaben zurück, die in der Arbeitsmappe vorhanden sind. |
| timeline |
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TimelineStyles dar. |
| use1904Date |
True, falls die Arbeitsmappe das 1904-Datumssystem verwendet. |
| use |
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 |
| worksheets | Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar. |
Methoden
| close(close |
Aktuelle Arbeitsmappe schließen. |
| close(close |
Aktuelle Arbeitsmappe schließen. |
| get |
Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab. |
| get |
Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, wird eine |
| get |
Ruft das derzeit aktive Diagramm in der Arbeitsmappe ab. Wenn kein aktives Diagramm vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen |
| get |
Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, wird eine |
| get |
Ruft den derzeit aktiven Datenschnitt in der Arbeitsmappe ab. Wenn kein aktiver Slicer vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen |
| get |
Gibt zurück |
| get |
Gibt basierend auf dem bereitgestellten |
| get |
Ruft den aktuell ausgewählten einzelnen Bereich aus der Arbeitsmappe ab. Wenn mehrere Bereiche ausgewählt sind, löst diese Methode einen Fehler aus. |
| get |
Ruft die aktuell ausgewählten Bereiche (einen oder mehrere) aus der Arbeitsmappe ab. Im Gegensatz zu |
| insert |
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. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| save(save |
Aktuelle Arbeitsmappe speichern. |
| save(save |
Aktuelle Arbeitsmappe speichern. |
| 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 |
Ereignisse
| on |
Tritt auf, wenn die Arbeitsmappe aktiviert wird. Hinweis: Dieses Ereignis wird nicht ausgelöst, wenn die Arbeitsmappe geöffnet wird. |
| on |
Tritt auf, wenn die Einstellung AutoSpeichern für die Arbeitsmappe geändert wird. |
| on |
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
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
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
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
customXmlParts
Stellt die Auflistung von benutzerdefinierten XML-Teilen dar, die in dieser Arbeitsmappe enthalten sind.
readonly customXmlParts: Excel.CustomXmlPartCollection;Eigenschaftswert
Hinweise
dataConnections
Stellt alle Datenverbindungen in der Arbeitsmappe dar.
readonly dataConnections: Excel.DataConnectionCollection;Eigenschaftswert
Hinweise
externalCodeServiceTimeout
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt die maximale Zeitdauer in Sekunden an, die einer Formel zugewiesen wird, die von einem externen Codedienst abhängig ist. Der gültige Bereich ist 1 bis einschließlich 86400.
externalCodeServiceTimeout: number;Eigenschaftswert
number
Hinweise
functions
Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können.
readonly functions: Excel.Functions;Eigenschaftswert
Hinweise
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
linkedDataTypes
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt eine Auflistung verknüpfter Datentypen zurück, die Teil der Arbeitsmappe sind.
readonly linkedDataTypes: Excel.LinkedDataTypeCollection;Eigenschaftswert
Hinweise
linkedWorkbooks
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.
readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;Eigenschaftswert
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
Hinweise
pivotTables
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften PivotTables dar.
readonly pivotTables: Excel.PivotTableCollection;Eigenschaftswert
Hinweise
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
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
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
Hinweise
queries
Gibt eine Auflistung von Power Query Abfragen zurück, die Teil der Arbeitsmappe sind.
readonly queries: Excel.QueryCollection;Eigenschaftswert
Hinweise
readOnly
Gibt zurück true , wenn die Arbeitsmappe im schreibgeschützten Modus geöffnet ist.
readonly readOnly: boolean;Eigenschaftswert
boolean
Hinweise
settings
Stellt eine Auflistung von Einstellungen dar, die der Arbeitsmappe zugeordnet sind.
readonly settings: Excel.SettingCollection;Eigenschaftswert
Hinweise
showPivotFieldList
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt an, ob der Feldlistenbereich der PivotTable auf Arbeitsmappenebene angezeigt wird.
showPivotFieldList: boolean;Eigenschaftswert
boolean
Hinweise
slicers
Stellt eine Auflistung von Slicern dar, die der Arbeitsmappe zugeordnet sind.
readonly slicers: Excel.SlicerCollection;Eigenschaftswert
Hinweise
slicerStyles
Stellt eine Sammlung der mit der Arbeitsmappe verknüpften SlicerStyles dar.
readonly slicerStyles: Excel.SlicerStyleCollection;Eigenschaftswert
Hinweise
styles
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Formatvorlagen dar.
readonly styles: Excel.StyleCollection;Eigenschaftswert
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
Hinweise
tableStyles
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TableStyles dar.
readonly tableStyles: Excel.TableStyleCollection;Eigenschaftswert
Hinweise
tasks
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt eine Auflistung von Aufgaben zurück, die in der Arbeitsmappe vorhanden sind.
readonly tasks: Excel.DocumentTaskCollection;Eigenschaftswert
Hinweise
timelineStyles
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften TimelineStyles dar.
readonly timelineStyles: Excel.TimelineStyleCollection;Eigenschaftswert
Hinweise
use1904DateSystem
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
True, falls die Arbeitsmappe das 1904-Datumssystem verwendet.
use1904DateSystem: boolean;Eigenschaftswert
boolean
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
Hinweise
Details zur Methode
close(closeBehavior)
Aktuelle Arbeitsmappe schließen.
close(closeBehavior?: Excel.CloseBehavior): void;Parameter
- closeBehavior
- Excel.CloseBehavior
Verhalten zum Schließen von Arbeitsmappen.
Gibt zurück
void
Hinweise
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);
});
close(closeBehaviorString)
Aktuelle Arbeitsmappe schließen.
close(closeBehaviorString?: "Save" | "SkipSave"): void;Parameter
- closeBehaviorString
-
"Save" | "SkipSave"
Verhalten zum Schließen von Arbeitsmappen.
Gibt zurück
void
Hinweise
getActiveCell()
Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab.
getActiveCell(): Excel.Range;Gibt zurück
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
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
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
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
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
getLinkedEntityCellValue(linkedEntityCellValueId)
Gibt basierend auf dem bereitgestellten LinkedEntityIdzurückLinkedEntityCellValue.
getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;Parameter
- linkedEntityCellValueId
- Excel.LinkedEntityId
Ein Bezeichner, der eine einzelne LinkedEntityCellValueangibt.
Gibt zurück
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
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
Hinweise
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();
})
insertWorksheetsFromBase64(base64File, options)
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
- base64File
-
string
Erforderlich. Die base64-codierte Zeichenfolge, die die Quellarbeitsmappendatei darstellt.
- options
- Excel.InsertWorksheetOptions
Optional. Die Optionen, die definieren, welche Arbeitsblätter eingefügt werden sollen und wo die neuen Arbeitsblätter in die Arbeitsmappe eingefügt werden. Standardmäßig werden alle Arbeitsblätter aus der Quellarbeitsmappe am Ende der aktuellen Arbeitsmappe eingefügt.
Gibt zurück
OfficeExtension.ClientResult<string[]>
Ein Array von IDs, die jedem neu eingefügten Arbeitsblatt entsprechen.
Hinweise
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();
});
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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
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
save(saveBehavior)
Aktuelle Arbeitsmappe speichern.
save(saveBehavior?: Excel.SaveBehavior): void;Parameter
- saveBehavior
- Excel.SaveBehavior
Das Speicherverhalten muss "Speichern" oder "Eingabeaufforderung" sein. Der Standardwert ist "Speichern".
Gibt zurück
void
Hinweise
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);
});
save(saveBehaviorString)
Aktuelle Arbeitsmappe speichern.
save(saveBehaviorString?: "Save" | "Prompt"): void;Parameter
- saveBehaviorString
-
"Save" | "Prompt"
Das Speicherverhalten muss "Speichern" oder "Eingabeaufforderung" sein. Der Standardwert ist "Speichern".
Gibt zurück
void
Hinweise
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
Details zum Ereignis
onActivated
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
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.");
});
onAutoSaveSettingChanged
Tritt auf, wenn die Einstellung AutoSpeichern für die Arbeitsmappe geändert wird.
readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;Ereignistyp
Hinweise
onSelectionChanged
Tritt ein, wenn die Auswahl im Dokument geändert wird.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;Ereignistyp
Hinweise
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für