Allgemeine Office-API-Anforderungssätze
Anforderungssätze sind benannte Gruppen von API-Mitgliedern. Office-Add-Ins verwenden im Manifest angegebene Anforderungssätze oder ermitteln mithilfe einer Laufzeitüberprüfung, ob eine Office-Anwendung APIs unterstützt, die von einem Add-In benötigt werden. Weitere Informationen finden Sie unter Office-Versionen und Anforderungssätze.
Tipp
Suchen Sie nach den anwendungsspezifischen API-Anforderungssätzen ? Weitere Informationen finden Sie in den folgenden API-Anforderungssätzen.
- JavaScript-API-Anforderungssätze für Excel (ExcelApi)
- JavaScript-API-Anforderungssätze für Word (WordApi)
- JavaScript-API-Anforderungssätze für OneNote (OneNoteApi)
- JavaScript-API-Anforderungssätze für PowerPoint (PowerPointApi)
- Grundlegendes zu Outlook-API-Anforderungssätzen (MailBox)
Allgemeine API-Anforderungssätze
In den folgenden Abschnitten sind die allgemeinen API-Anforderungssätze, die Methoden in jedem Satz und die Office-Clientanwendungen aufgeführt, die diesen Anforderungssatz unterstützen. Alle diese API-Anforderungssätze haben Version 1.1, sofern nichts anderes angegeben ist.
Tipp
Benötigen Sie Informationen dazu, wo Add-Ins und Anforderungssätze von der Office-Anwendung und -Version unterstützt werden? Weitere Informationen finden Sie unter Office-Clientanwendung und Plattformverfügbarkeit für Office-Add-Ins.
ActiveView
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac |
– Document.getActiveViewAsync |
AddInCommands
Weitere Informationen finden Sie unter Add-In-Befehlsanforderungssätze.
BindingEvents
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
– Binding.addHandlerAsync – Binding.removeHandlerAsync |
CompressedFile
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement – Unbefristetes Office 2016 – Excel im Web – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Ausgabe in das Format Office Open XML (OOXML) als Byte-Array (Office.FileType.Compressed), wenn die Methode Document.getFileAsync verwendet wird. |
CustomXmlParts
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
– CustomXmlNode.getNodesAsync – CustomXmlNode.getNodeValueAsync – CustomXmlNode.getTextAsync – CustomXmlNode.getXmlAsync – CustomXmlNode.setNodeValueAsync – CustomXmlNode.setTextAsync – CustomXmlNode.setXmlAsync – CustomXmlPart.addHandlerAsync – CustomXmlPart.deleteAsync – CustomXmlPart.getNodesAsync – CustomXmlPart.getXmlAsync – CustomXmlPart.removeHandlerAsync – CustomXmlParts.addAsync – CustomXmlParts.getByIdAsync – CustomXmlParts.getByNamespaceAsync – CustomXmlPrefixMappings.addNamespaceAsync – CustomXmlPrefixMappings.getNamespaceAsync – CustomXmlPrefixMappings.getPrefixAsync |
DialogApi
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Dialog-API-Anforderungssätze. | - UI.messageParent – UI.displayDialogAsync - UI.closeContainer -BENUTZEROBERFLÄCHE. Dialog |
DialogOrigin
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Dialog Origin-Anforderungssätze. | Domänenübergreifende Unterstützung für: - UI.messageParent -BENUTZEROBERFLÄCHE. Dialog.messageChild |
DocumentEvents
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac - OneNote im Web – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
– Document.addHandlerAsync – Document.removeHandlerAsync |
File
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
– Document.getFileAsync - File.closeAsync - File.getSliceAsync |
HtmlCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| - OneNote im Web – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Koersion in HTML (Office.CoercionType.Html) bei Lesen und Schreiben von Daten mit der Methode "Document.getSelectedDataAsync", "Document.setSelectedDataAsync", "Binding.getDataAsync" oder "Binding.setDataAsync". |
IdentityAPI
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Identitäts-API-Anforderungssätze. | – Auth.getAccessToken |
ImageCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Siehe Anforderungsgruppen für die Bildkoersion. | - Document.setSelectedDataAsync |
KeyboardShortcuts
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Anforderungssätze für Tastenkombinationen. | – Office.actions.areShortcutsInUse – Office.actions.getShortcuts – Office.actions.replaceShortcuts |
Postfach
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Outlook unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - neues Outlook unter Windows (Vorschau) – Outlook im Web – Outlook unter Android – Outlook für Mac – Outlook unter iOS |
Siehe Grundlegendes zu Outlook-API-Anforderungssätzen. |
MatrixBindings
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word im Web - Word auf dem iPad – Word unter Mac |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync – Binding.getDataAsync - Binding.setDataAsync |
MatrixCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Koersion in eine "Matrix"- (Array von Arrays-)Datenstruktur (Office.CoercionType.Matrix) beim Lesen und Schreiben von Daten mit der Methode "Document.getSelectedDataAsync", "Document.setSelectedDataAsync", "Binding.getDataAsync" oder "Binding.setDataAsync". |
OoxmlCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Koersion in das Open Office XML-Format (Office.CoercionType.Ooxml) beim Lesen und Schreiben von Daten mit der Methode "Document.getSelectedDataAsync", "Document.setSelectedDataAsync", "Binding.getDataAsync" oder "Binding.setDataAsync". |
OpenBrowserWindowApi
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Api-Anforderungssätze zum Öffnen von Browserfenstern. | – Office.context.ui.openBrowserWindow |
PartialTableBindings
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Keine. |
PdfFile
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Ausgabe im PDF-Format (Office.FileType.Pdf) bei Verwendung der Document.getFileAsync-Methode |
RibbonApi
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Menüband-API-Anforderungssätze. | – Office.ribbon.requestUpdate |
Selection
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Projekt unter Windows – Volumenlizenz für unbefristete Office 2013 – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
– Document.getSelectedDataAsync - Document.setSelectedDataAsync |
Einstellungen
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac - OneNote im Web – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
- Settings.get - Settings.remove - Settings.saveAsync - Settings.set |
SharedRuntime
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| Weitere Informationen finden Sie unter Gemeinsame Laufzeitanforderungssätze. | – Office.addin.getStartupBehavior – Office.addin.hide – Office.addin.onVisibilityModeChanged – Office.addin.setStartupBehavior – Office.addin.showAsTaskpane - Office.BeforeDocumentCloseNotification.disable - Office.BeforeDocumentCloseNotification.enable - Office.BeforeDocumentCloseNotification.onCloseActionCancelled |
TableBindings
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.addColumnsAsync – Binding.addRowsAsync - Binding.deleteAllDataValuesAsync – Binding.getDataAsync - Binding.setDataAsync |
TableCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Koersion in eine Tabellendatenstruktur (Office.CoercionType.Table) beim Lesen und Schreiben von Daten mit der Methode "Document.getSelectedDataAsync", "Document.setSelectedDataAsync", "Binding.getDataAsync" oder "Binding.setDataAsync". |
TextBindings
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync – Binding.getDataAsync - Binding.setDataAsync |
TextCoercion
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad - OneNote im Web – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Projekt unter Windows – Volumenlizenz für unbefristete Office 2013 – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Koersion in das Textformat (Office.CoercionType.Text) beim Lesen und Schreiben von Daten mit der Methode "Document.getSelectedDataAsync", "Document.setSelectedDataAsync", "Binding.getDataAsync" oder "Binding.setDataAsync". |
TextFile
| Mindestunterstützung für Office-Anwendungen | Methoden im Satz |
|---|---|
| – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word unter Mac – Word im Web - Word auf dem iPad |
Unterstützt die Ausgabe in das Textformat (Office.FileType.Text), wenn Sie die Document.getFileAsync-Methode verwenden. |
Methode, die nicht Teil eines Anforderungssatzes sind
Die folgenden Methoden in der Office JavaScript-API sind nicht Teil eines Anforderungssatzes. Wenn Ihr Add-In eine dieser Methoden erfordert, verwenden Sie die <Methods> - und <Method-Elemente> im Manifest des Add-Ins, um zu deklarieren, dass sie erforderlich sind, oder führen Sie die Laufzeitüberprüfung mithilfe einer -Anweisung aus if . Weitere Informationen finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen.
| Methodenname | Mindestunterstützung für Office-Anwendungen |
|---|---|
| Bindings.addFromPromptAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac |
| Document.getFilePropertiesAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word im Web - Word auf dem iPad – Word unter Mac |
| Document.getProjectFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getResourceFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedResourceAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedViewAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.goToByIdAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – PowerPoint auf dem iPad – PowerPoint für Mac – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word im Web - Word auf dem iPad – Word unter Mac |
| Settings.addHandlerAsync | – Excel im Web |
| Settings.refreshAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – PowerPoint unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 - PowerPoint im Web – Word unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Word im Web |
| Settings.removeHandlerAsync | – Excel im Web |
| TableBinding.clearFormatsAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac |
| TableBinding.setFormatsAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac |
| TableBinding.setTableOptionsAsync | – Excel unter Windows –- Microsoft 365-Abonnement –- unbefristetes Office 2013 – Excel im Web – Excel auf dem iPad – Excel für Mac |
Siehe auch
Zusammenarbeit auf GitHub
Die Quelle für diesen Inhalt finden Sie auf GitHub, wo Sie auch Issues und Pull Requests erstellen und überprüfen können. Weitere Informationen finden Sie in unserem Leitfaden für Mitwirkende.
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