Office JavaScript-API-ObjektmodellOffice JavaScript API object model

Das Office JavaScript-API-Objektmodell bietet Zugriff auf die zugrunde liegende Funktionalität des Hosts.Office JavaScript add-ins give access to the host’s underlying functionality. Der Großteil des Zugriffs erfolgt über ein paar wichtige Objekte.Most of this access goes through a few important objects. Das Context-Objekt bietet Zugriff auf die Laufzeitumgebung nach der Initialisierung.The Context object gives access to the runtime environment after initialization. Das Document-Objekt bietet dem Benutzer die Kontrolle über ein Excel-, PowerPoint- oder Word-Dokument.The Document object gives the user control over an Excel, PowerPoint, or Word document. Das Mailbox-Objekt bietet einem Outlook-Add-In Zugriff auf Nachrichten und Benutzerprofile.The Mailbox object gives an Outlook add-in access to messages and user profiles. Die Beziehungen zwischen diesen allgemeinen Objekten zu verstehen, bildet die Grundlage eines JavaScript-Add-Ins.Understanding the relationships between these high-level objects is the foundation of a JavaScript add-in.

Context-ObjektContext object

Betrifft: Alle Add-In-TypenApplies to: All add-in types

Wenn ein Add-In initialisiert wird, weist es viele unterschiedliche Objekte auf, mit denen es in der Laufzeitumgebung interagieren kann.When an add-in is initialized, it has many different objects that it can interact with in the runtime environment. Der Laufzeitkontext des Add-Ins wird in der API durch das Context-Objekt widergespiegelt.The add-in's runtime context is reflected in the API by the Context object. Das Context-Objekt ist das Hauptobjekt, das Zugriff auf die wichtigsten Objekte der API bietet, z. B. das Document- und das Mailbox-Objekt, die wiederum Zugriff auf Dokument- und Postfachinhalte bieten.The Context is the main object that provides access to the most important objects of the API, such as the Document and Mailbox objects, which in turn provide access to document and mailbox content.

In Aufgabenbereichs- oder Inhalts-Add-ins können Sie über die document-Eigenschaft des Context-Objekts auf die Eigenschaften und Methoden des Document-Objekts zugreifen, um mit dem Inhalt von Word-Dokumenten, Excel-Arbeitsblättern oder Project-Zeitplänen zu interagieren. Gleichsam können Sie in Outlook-Add-ins über die mailbox-Eigenschaft des Context-Objekts auf die Eigenschaften und Methoden des Mailbox-Objekts zugreifen, um mit dem Nachrichten-, Besprechungsanfragen- oder Termininhalt zu interagieren.For example, in task pane or content add-ins, you can use the document property of the Context object to access the properties and methods of the Document object to interact with the content of Word documents, Excel worksheets, or Project schedules. Similarly, in Outlook add-ins, you can use the mailbox property of the Context object to access the properties and methods of the Mailbox object to interact with the message, meeting request, or appointment content.

Das Context-Objekt bietet auch Zugriff auf die Eigenschaften contentLanguage und displayLanguage, mit denen Sie das Gebietsschema (die Sprache) des Dokuments oder Elements bzw. der Hostanwendung bestimmen können.The Context object also provides access to the contentLanguage and displayLanguage properties that let you determine the locale (language) used in the document or item, or by the host application. Über die roamingSettings-Eigenschaften können Sie auf die Mitglieder des RoamingSettings-Objekts zugreifen, das Einstellungen speichert, die spezifisch für Ihr Add-In für die Postfächer von einzelnen Benutzer sind.The roamingSettings property lets you access the members of the RoamingSettings object, which stores settings specific to your add-in for individual users' mailboxes. Das Context-Objekt bietet eine ui-Eigenschaft, über die das Add-In Popup-Dialogfelder starten kann.Finally, the Context object provides a ui property that enables your add-in to launch pop-up dialogs.

Document-ObjektDocument object

Betrifft: Add-ins vom Typ „Inhalt" und „Aufgabenbereich"Applies to: Content and task pane add-in types

Zum Interagieren mit Dokumentdaten in Excel, PowerPoint und Word bietet die API das Document-Objekt. Über die Elemente des Document-Objekts können Sie auf folgende Weisen auf Daten zugreifen:To interact with document data in Excel, PowerPoint, and Word, the API provides the Document object. You can use Document object members to access data from the following ways:

  • Lesen und Schreiben in aktive Auswahlen in Form von Text, zusammenhängenden Zellen (Matrizen) oder Tabellen.Read and write to active selections in the form of text, contiguous cells (matrices), or tables.

  • Tabellendaten (Matrizen oder Tabellen).Tabular data (matrices or tables).

  • Bindungen (werden mit den "add"-Methoden des Bindings-Objekts erstellt).Bindings (created with the "add" methods of the Bindings object).

  • Benutzerdefinierte XML-Komponenten (nur bei Word).Custom XML parts (only for Word).

  • Einstellungen oder Add-in-Status (pro Add-in im Dokument dauerhaft gespeichert).Settings or add-in state persisted per add-in on the document.

Mithilfe des Document-Objekts können Sie mit Daten in Project-Dokumenten interagieren. Die Project-spezifische Funktionalität der API ist in den Elementen der abstrakten Klasse ProjectDocument dokumentiert. Weitere Informationen zum Erstellen von Aufgabenbereichs-Add-ins für Project finden Sie unter Aufgabenbereich-Add-ins für Project.You can also use the Document object to interact with data in Project documents. The Project-specific functionality of the API is documented in the members ProjectDocument abstract class. For more information about creating task pane add-ins for Project, see Task pane add-ins for Project.

Alle diese Formen des Datenzugriffs beginnen mit einer Instanz des abstrakten Objekts Document.All these forms of data access start from an instance of the abstract Document object.

Sie können auf eine Instanz des Document-Objekts zugreifen, wenn das Aufgabenbereichs- oder Inhalts-Add-in initialisiert wird, indem Sie die document-Eigenschaft des Context-Objekts verwenden. Das Document-Objekt definiert allgemeine Datenzugriffsfunktionen, die von Word- und Excel-Dokumenten gemeinsam genutzt werden. Es bietet auch Zugriff auf das CustomXmlParts-Objekt für Word-Dokumente.You can access an instance of the Document object when the task pane or content add-in is initialized by using the document property of the Context object. The Document object defines common data access functions shared across Word and Excel documents, and also provides access to the CustomXmlParts object for Word documents.

Das Document-Objekt bietet Entwicklern vier Möglichkeiten für den Zugriff auf Dokumentinhalte:The Document object supports four ways for developers to access document contents:

  • Auswahlbasierten ZugriffSelection-based access

  • Bindungsbasierten ZugriffBinding-based access

  • Benutzerdefinierten Zugriff auf Basis von XML-Elementen (nur Word)Custom XML part-based access (Word only)

  • Zugriff auf Basis des gesamten Dokuments (nur PowerPoint und Word)Entire document-based access (PowerPoint and Word only)

Um Ihnen zu verdeutlichen, wie die Methoden zum auswahl- und bindungsbasierten Zugriff funktionieren, möchten wir zunächst erklären, wie die Datenzugriffs-APIs bei den verschiedenen Office-Anwendungen einen einheitlichen Datenzugriff ermöglichen.To help you understand how selection- and binding-based data access methods work, we will first explain how the data-access APIs provide consistent data access across different Office applications.

Einheitlicher Datenzugriff in allen Office-AnwendungenConsistent data access across Office applications

Betrifft: Add-ins vom Typ „Inhalt" und „Aufgabenbereich"Applies to: Content and task pane add-in types

Zum Erstellen von Erweiterungen, die in den verschiedenen Office-Dokumenten einheitlich funktionieren, abstrahiert die JavaScript-API für Office die Besonderheiten der einzelnen Office-Anwendungen mithilfe allgemeiner Datentypen und der Fähigkeit, für unterschiedliche Dokumentinhalte drei allgemeine Datentypen zu erzwingen.To create extensions that seamlessly work across different Office documents, the JavaScript API for Office abstracts away the particularities of each Office application through common data types and the ability to coerce different document contents into three common data types.

Allgemeine DatentypenCommon data types

Sowohl beim auswahl- als auch beim bindungsbasierten Datenzugriff werden Dokumentinhalte über Datentypen zur Verfügung gestellt, die alle unterstützten Office-Anwendungen gemeinsam haben. Von Office 2013 werden drei Hauptdatentypen unterstützt:In both selection-based and binding-based data access, document contents are exposed through data types that are common across all the supported Office applications. In Office 2013, three main data types are supported:

DatentypData type BeschreibungDescription Unterstützung von HostanwendungenHost application support
TextText Stellt eine Zeichenfolgendarstellung der Daten in der Auswahl bereit.Provides a string representation of the data in the selection or binding. In Excel 2013, Project 2013 und PowerPoint 2013 wird nur unformatierter Text unterstützt. In Word 2013 werden drei Formate unterstützt: Nur-Text, HTML und Office Open XML (OOXML). Wenn Text in einer Zelle in Excel ausgewählt wird, lesen und schreiben auswahlbasierte Methoden den gesamten Inhalt der Zelle, auch wenn nur ein Teil des Texts in der Zelle ausgewählt ist. Wenn Text in Word ausgewählt ist, lesen und schreiben auswahlbasierte Methoden nur die Zeichenfolge, die ausgewählt ist. Project 2013 und PowerPoint 2013 unterstützen nur auswahlbasierten Datenzugriff.In Excel 2013, Project 2013, and PowerPoint 2013, only plain text is supported. In Word 2013, three text formats are supported: plain text, HTML, and Office Open XML (OOXML). When text is selected in a cell in Excel, selection-based methods read and write to the entire contents of the cell, even if only a portion of the text is selected in the cell. When text is selected in Word and PowerPoint, selection-based methods read and write only to the run of characters that are selected. Project 2013 and PowerPoint 2013 support only selection-based data access.
MatrixMatrix Stellt die Daten in der Auswahl oder Bindung als zweidimensionales Array-Objekt bereit, das in JavaScript als ein Array von Arrays implementiert wird. Zwei Zeilen mit string-Werten in zwei Spalten sind beispielsweise [['a', 'b'], ['c', 'd']], und eine einzelne Spalte mit drei Zeilen ist beispielsweise [['a'], ['b'], ['c']].Provides the data in the selection or binding as a two dimensional Array, which in JavaScript is implemented as an array of arrays. For example, two rows of string values in two columns would be [['a', 'b'], ['c', 'd']], and a single column of three rows would be [['a'], ['b'], ['c']]. Matrix-Datenzugriff wird nur in Excel 2013 und Word 2013 unterstützt.Matrix data access is supported only in Excel 2013 and Word 2013.
TabelleTable Stellt die Daten in der Auswahl oder Bindung als TableData-Objekt bereit. Das TableData-Objekt stellt die Daten über die Eigenschaften headers und rows zur Verfügung.Provides the data in the selection or binding as a TableData object. The TableData object exposes the data through the headers and rows properties. Tabellendatenzugriff wird nur in Excel 2013 und Word 2013 unterstützt.Table data access is supported only in Excel 2013 and Word 2013.

DatentyperzwingungData type coercion

Die Datenzugriffsmethoden für die Objekte Document und Binding unterstützen die Angabe des gewünschten Datentyps mithilfe des coercionType-Parameters dieser Methoden und den dazugehörigen CoercionType-Enumerationswerten. Unabhängig von der tatsächlichen Form der Bindung unterstützen die verschiedenen Office-Anwendungen die allgemeinen Datentypen, indem die Umwandlung der Daten in den angeforderten Datentyp erzwungen wird. Wenn beispielsweise in Word eine Tabelle oder ein Absatz ausgewählt wird, kann der Entwickler angeben, dass diese/r als Nur-Text, HTML, Office Open XML oder Tabelle gelesen werden soll. Dabei übernimmt die API-Implementierung die erforderlichen Transformationen und Datenkonvertierungen.The data access methods on the Document and Binding objects support specifying the desired data type using the coercionType parameter of these methods, and corresponding CoercionType enumeration values. Regardless of the actual shape of the binding, the different Office applications support the common data types by trying to coerce the data into the requested data type. For example, if a Word table or paragraph is selected, the developer can specify to read it as plain text, HTML, Office Open XML, or a table, and the API implementation handles the necessary transformations and data conversions.

Tipp

Wann sollten Sie die Matrix-Koersion der Tabellenkoersion für den Datenzugriff vorziehen? Sofern Ihre tabulierten Daten beim Hinzufügen von Zeilen und Spalten dynamisch wachsen und Sie mit Tabellenüberschriften arbeiten müssen, sollten Sie den Tabellendatentyp (durch das Angeben des coercionType Parameters eines Document oder Binding-Objektdatenzugriffsmethode als "table" oder Office.CoercionType.Table). Das Hinzufügen von Zeilen und Spalten innerhalb der Datenstruktur wird sowohl für Tabellen- als auch Matrixdaten unterstützt, das Anfügen von Zeilen und Spalten wird jedoch nur für Tabellendaten unterstützt. Falls Sie nicht planen, Zeilen oder Spalten hinzuzufügen und für Ihre Daten keine Kopfzeilenfunktion erforderlich ist, sollten Sie den Matrix-Datentyp verwenden (durch das Angeben des coercionType-Parameters der Datenzugriffsmethode als "matrix" oder Office.CoercionType.Matrix), das ein einfacheres Modell der Interaktion mit den Daten bereitstellt.When should you use the matrix versus table coercionType for data access? If you need your tabular data to grow dynamically when rows and columns are added, and you must work with table headers, you should use the table data type (by specifying the coercionType parameter of a Document or Binding object data access method as "table" or Office.CoercionType.Table). Adding rows and columns within the data structure is supported in both table and matrix data, but appending rows and columns is supported only for table data. If you aren't planning on adding rows and columns, and your data doesn't require header functionality, then you should use the matrix data type (by specifying the coercionType parameter of the data access method as "matrix" or Office.CoercionType.Matrix), which provides a simpler model of interacting with the data.

Wenn die Daten nicht in den angegebenen Typ umgewandelt werden können, gibt die AsyncResult.status-Eigenschaft im Rückruf "failed" zurück. Sie können dann über die AsyncResult.error-Eigenschaft auf ein Error-Objekt mit Informationen zu den Gründen des Misserfolgs des Methodenaufrufs zugreifen.If the data can't be coerced to the specified type, the AsyncResult.status property in the callback returns "failed", and you can use the AsyncResult.error property to access an Error object with information about why the method call failed.

Arbeiten mit Auswahlen beim Document-ObjektWorking with selections using the Document object

Das Document-Objekt macht Methoden verfügbar, mit denen Sie Lese- und Schreibzugriff auf die aktuelle Auswahl des Benutzer erhalten, um Aufgaben wie „Abrufen und Festlegen“ auszuführen. Hierzu macht das Document-Objekt die Methoden getSelectedDataAsync und setSelectedDataAsync verfügbar.The Document object exposes methods that let you to read and write to the user's current selection in a "get and set" fashion. To do that, the Document object provides the getSelectedDataAsync and setSelectedDataAsync methods.

Codebeispiele, die das Anwenden von Aufgaben auf Auswahlen veranschaulichen, finden Sie unter Lesen und Schreiben von Daten in der aktiven Auswahl in einem Dokument oder Arbeitsblatt.For code examples that demonstrate how to perform tasks with selections, see Read and write data to the active selection in a document or spreadsheet.

Arbeiten mit Bindungen mithilfe der Objekte "Bindings" und "Binding"Working with bindings using the Bindings and Binding objects

Der bindungsbasierte Datenzugriff ermöglicht Inhalts- und Aufgabenbereichs-Add-ins einen einheitlichen Zugriff auf einen bestimmten Bereich eines Dokuments oder Arbeitsblatts über eine einer Bindung zugeordnete ID. Das Add-in muss zunächst die Bindung herstellen, indem eine der Methoden aufgerufen wird, über die ein Teil des Dokuments einer eindeutigen ID zugeordnet wird: addFromPromptAsync, addFromSelectionAsync oder addFromNamedItemAsync. Nachdem die Bindung eingerichtet wurde, kann das Add-in über die bereitgestellte ID auf die Daten im zugeordneten Bereich des Dokuments oder Arbeitsblatts zugreifen. Das Erstellen von Bindungen bietet für Ihr Add-in folgenden Nutzen:Binding-based data access enables content and task pane add-ins to consistently access a particular region of a document or spreadsheet through an identifier associated with a binding. The add-in first needs to establish the binding by calling one of the methods that associates a portion of the document with a unique identifier: addFromPromptAsync, addFromSelectionAsync, or addFromNamedItemAsync. After the binding is established, the add-in can use the provided identifier to access the data contained in the associated region of the document or spreadsheet. Creating bindings provides the following value to your add-in:

  • Zugriff auf allgemeine Datenstrukturen in allen unterstützten Office-Anwendungen, z. B. Tabellen, Bereiche oder Text (eine fortlaufende Folge von Zeichen).Permits access to common data structures across supported Office applications, such as: tables, ranges, or text (a contiguous run of characters).

  • Lese-/Schreibzugriffvorgänge, ohne dass der Benutzer eine Auswahl vornehmen mussEnables read/write operations without requiring the user to make a selection.

  • Herstellung einer Beziehung zwischen dem Add-In und den Daten im Dokument. Bindungen bleiben im Dokument erhalten, und es kann zu einem späteren Zeitpunkt auf diese zugegriffen werden.Establishes a relationship between the add-in and the data in the document. Bindings are persisted in the document, and can be accessed at a later time.

Die Herstellung einer Bindung ermöglicht auch das Abonnieren von Daten- und Auswahländerungsereignissen in diesem bestimmten Bereich des Dokuments oder der Tabelle. Dies bedeutet, dass das Add-in nur von Änderungen benachrichtigt wird, die in dem gebundenen Bereich stattfinden und nicht von solchen, innerhalb des gesamten Dokuments oder der gesamten Tabelle.Establishing a binding also allows you to subscribe to data and selection change events that are scoped to that particular region of the document or spreadsheet. This means that the add-in is only notified of changes that happen within the bound region as opposed to general changes across the whole document or spreadsheet.

Das Bindings-Objekt macht eine getAllAsync-Methode verfügbar, die den Zugriff auf alle in dem Dokument oder in der Tabelle hergestellten Bindungen ermöglicht. Auf die einzelnen Bindungen kann über ihre ID unter Verwendung der Bindings.getBindingByIdAsync- oder der Office.select-Methode zugegriffen werden. Mithilfe einer der folgenden Methoden des Bindings-Objekts können neue Bindungen hergestellt und vorhandene entfernt werden: addFromSelectionAsync, addFromPromptAsync, addFromNamedItemAsync oder releaseByIdAsync.The Bindings object exposes a getAllAsync method that gives access to the set of all bindings established on the document or spreadsheet. An individual binding can be accessed by its ID using either the Bindings.getBindingByIdAsync or Office.select methods. You can establish new bindings as well as remove existing ones by using one of the following methods of the Bindings object: addFromSelectionAsync, addFromPromptAsync, addFromNamedItemAsync, or releaseByIdAsync.

Es gibt drei unterschiedliche Arten von Bindungen, die Sie mit dem bindingType-Parameter angeben, wenn Sie eine Bindung mithilfe der Methode addFromSelectionAsync, addFromPromptAsync oder addFromNamedItemAsync erstellen:There are three different types of bindings that you specify with the bindingType parameter when you create a binding with the addFromSelectionAsync, addFromPromptAsync or addFromNamedItemAsync methods:

BindungstypBinding type BeschreibungDescription Unterstützung von HostanwendungenHost application support
TextbindungText binding Bindet einen Bereich des Dokuments, der als Text dargestellt werden kann.Binds to a region of the document that can be represented as text. In Word sind die meisten zusammenhängenden Auswahlen gültig, während in Excel nur Auswahlen mit einer Zelle das Ziel einer Textbindung sein können. In Excel wird nur unformatierter Text unterstützt. Word unterstützt drei Formate: Nur-Text, HTML und Open XML für Office.In Word, most contiguous selections are valid, while in Excel only single cell selections can be the target of a text binding. In Excel, only plain text is supported. In Word, three formats are supported: plain text, HTML, and Open XML for Office.
MatrixbindungMatrix binding Bindet einen festen Bereich eines Dokuments, der tabulierte Daten ohne Kopfzeilen enthält. Daten in einer Matrixbindung werden als zweidimensionales Array-Objekt geschrieben bzw. gelesen, das in JavaScript als ein Array von Arrays implementiert wird. Beispielsweise können zwei Zeilen mit string-Werten in zwei Spalten als [['a', 'b'], ['c', 'd']] gelesen oder geschrieben werden, und eine einzelne Spalte mit drei Zeilen kann als [['a'], ['b'], ['c']] gelesen oder geschrieben werden.Binds to a fixed region of a document that contains tabular data without headers. Data in a matrix binding is written or read as a two dimensional Array, which in JavaScript is implemented as an array of arrays. For example, two rows of string values in two columns can be written or read as [['a', 'b'], ['c', 'd']], and a single column of three rows can be written or read as [['a'], ['b'], ['c']]. In Excel kann eine beliebige Auswahl benachbarter Zellen für die Herstellung einer Matrixbindung verwendet werden. In Word wird die Matrixbindung nur für Tabellen unterstützt.In Excel, any contiguous selection of cells can be used to establish a matrix binding. In Word, only tables support matrix binding.
TabellenbindungTable binding Bindet einen Bereich eines Dokuments, der eine Tabelle mit Kopfzeilen enthält. Daten in einer Tabellenbindung werden als TableData-Objekt geschrieben oder gelesen. Das TableData-Objekt stellt die Daten über die Eigenschaften headers und rows zur Verfügung.Binds to a region of a document that contains a table with headers. Data in a table binding is written or read as a TableData object. The TableData object exposes the data through the headers and rows properties. Jede Excel- oder Word-Tabelle kann die Basis einer Tabellenbindung sein. Nach Herstellen einer Tabellenbindung wird jede neue Zeile oder Spalte, die Benutzer der Tabelle hinzugefügt haben, automatisch in die Bindung einbezogen.Any Excel or Word table can be the basis for a table binding. After you establish a table binding, each new row or column a user adds to the table is automatically included in the binding.

Nachdem eine Bindung mithilfe einer der drei "add"-Methoden des Bindings -Objekts erstellt wurde, können Sie mit den Daten und Eigenschaften der Bindung mithilfe der Methoden des entsprechenden Objekts arbeiten: MatrixBinding, TableBinding oder TextBinding. Diese drei Objekte erben die Methoden getDataAsync und setDataAsync des Binding-Objekts, die Ihnen die Interaktion mit gebundenen Daten ermöglichen.After a binding is created by using one of the three "add" methods of the Bindings object, you can work with the binding's data and properties by using the methods of the corresponding object: MatrixBinding, TableBinding, or TextBinding. All three of these objects inherit the getDataAsync and setDataAsync methods of the Binding object that enable to you interact with the bound data.

Codebeispiele, die veranschaulichen, wie Aufgaben mit Bindungen ausgeführt werden, finden Sie unter Einrichten einer Bindung an Regionen in einem Dokument oder Arbeitsblatt.For code examples that demonstrate how to perform tasks with bindings, see Bind to regions in a document or spreadsheet.

Arbeiten mit benutzerdefinierten XML-Komponenten mithilfe der Objekte "CustomXmlParts" und "CustomXmlPart"Working with custom XML parts using the CustomXmlParts and CustomXmlPart objects

Betrifft: Add-ins für den AufgabenbereichApplies to: Task pane add-ins for Word

Die Objekte CustomXmlParts und CustomXmlPart der API bieten Zugriff auf benutzerdefinierte XML-Komponenten in Word, die die XML-gesteuerte Bearbeitung des Dokumentinhalts ermöglichen. The CustomXmlParts and CustomXmlPart objects of the API provide access to custom XML parts in Word documents, which enable XML-driven manipulation of the contents of the document. Vorgehensweisen für das Arbeiten mit CustomXmlParts and CustomXmlPart -Objekten finden Sie im Codebeispiel Arbeiten mit benutzerdefinierten XML-Komponenten.For demonstrations of working with the CustomXmlParts and CustomXmlPart objects, see the Word-add-in-Work-with-custom-XML-parts code sample.

Arbeiten mit dem gesamten Dokument mithilfe der getFileAsync-MethodeWorking with the entire document using the getFileAsync method

Betrifft: Add-Ins für den Aufgabenbereich für Word und PowerPointApplies to: Task pane add-ins for Word and PowerPoint

Die Document.getFileAsync-Methode und Elemente der Objekte File und Slice sollen Funktionalität zum Aufteilen ganzer Word- und PowerPoint-Dokumentdateien in Segmente (Blöcke) von jeweils bis zu 4 MB bereitstellen. Weitere Informationen finden Sie unter Abrufen des gesamten Dokuments aus einem Add-In für PowerPoint oder Word.The Document.getFileAsync method and members of the File and Slice objects to provide functionality for getting entire Word and PowerPoint document files in slices (chunks) of up to 4 MB at a time. For more information, see Get the whole document from an add-in for PowerPoint or Word.

Objekt „Postfach“Mailbox object

Betrifft: Outlook-Add-insApplies to: Outlook add-ins

Outlook-Add-Ins verwenden hauptsächlich eine Untergruppe der API, die über das Mailbox-Objekt zur Verfügung gestellt wird. Für den Zugriff auf die Objekte und Elemente, die insbesondere in Outlook-Add-Ins verwendet werden, z. B. das Item-Objekt, greifen Sie mithilfe der mailbox-Eigenschaft des Context-Objekts auf das Mailbox-Objekt zu (siehe die folgende Codezeile).Outlook add-ins primarily use a subset of the API exposed through the Mailbox object. To access the objects and members specifically for use in Outlook add-ins, such as the Item object, you use the mailbox property of the Context object to access the Mailbox object, as shown in the following line of code.

// Access the Item object.
var item = Office.context.mailbox.item;

Darüber hinaus können Outlook-Add-ins die folgenden Objekte verwenden:Additionally, Outlook add-ins can use the following objects:

  • Office-Objekt: zur Initialisierung.Office object: for initialization.

  • Context-Objekt: für Zugriff auf die Inhalts- und Anzeigespracheneigenschaften.Context object: for access to content and display language properties.

  • RoamingSettings-Objekt: zum Speichern von Outlook-Add-In-spezifischen benutzerdefinierten Einstellungen für das Postfach des Benutzers, in dem das Add-In installiert ist.RoamingSettings object: for saving Outlook add-in-specific custom settings to the user's mailbox where the add-in is installed.

Informationen zum Verwenden von JavaScript in Mail-Apps für Outlook finden Sie unter Outlook-Add-Ins.For information about using JavaScript in Outlook add-ins, see Outlook add-ins.