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. |
| bindings | Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe 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. |
| functions | Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können. |
| 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. |
| properties | Ruft die Arbeitsmappeneigenschaften ab. |
| protection | Gibt das Schutzobjekt für eine Arbeitsmappe zurück. |
| read |
Gibt zurück |
| settings | Stellt eine Auflistung von Einstellungen dar, die der Arbeitsmappe zugeordnet sind. |
| styles | Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Formatvorlagen dar. |
| tables | Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Tabellen dar. |
| worksheets | Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar. |
Methoden
| get |
Ruft die derzeit aktive Zelle aus der Arbeitsmappe ab. |
| 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. |
| 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 " |
| 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 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
bindings
Stellt eine Auflistung aller Bindungen dar, die Teil der Arbeitsmappe sind.
readonly bindings: Excel.BindingCollection;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
functions
Stellt eine Auflistung von Arbeitsblattfunktionen dar, die für berechnungen verwendet werden können.
readonly functions: Excel.Functions;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}`);
});
});
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
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
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
worksheets
Stellt eine Auflistung der mit der Arbeitsmappe verknüpften Arbeitsblätter dar.
readonly worksheets: Excel.WorksheetCollection;Eigenschaftswert
Hinweise
Details zur Methode
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);
});
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);
});
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
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
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