Grundlegendes zur Office-JavaScript-API

  • Artikel

Ein Office-Add-In kann die Office-JavaScript-APIs für die Interaktion mit Inhalten im Office-Dokument verwenden, in dem das Add-In ausgeführt wird.

Zugriff auf die Office JavaScript-API-Bibliothek

Auf die Office JavaScript-API-Bibliothek kann über das Office JS Content Delivery Network (CDN) unter https://appsforoffice.microsoft.com/lib/1/hosted/office.jszugegriffen werden. Wenn Sie Office JavaScript-APIs auf den Webseiten eines Ihrer Add-Ins verwenden möchten, müssen Sie in einem <script>-Tag im <head>-Tag der Seite auf das CDN verweisen.

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js" type="text/javascript"></script>
</head>

Hinweis

Wenn Sie Preview-APIs verwenden möchten, verweisen Sie auf die Preview-Version der Office JavaScript-API-Bibliothek im CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Weitere Informationen zum Zugriff auf die Office JavaScript-API-Bibliothek, einschließlich der Vorgehensweise zum Abrufen von IntelliSense, finden Sie unter Verweisen auf die Bibliothek der Office JavaScript-API über das Content Delivery Network (CDN).

API-Modelle

Die JavaScript-API für Office umfasst zwei unterschiedliche Modelle:

  • Anwendungsspezifische APIs bieten stark typisierte Objekte, die für die Interaktion mit Objekten verwendet werden können, die zu einer bestimmten Office-Anwendung gehören. So können Sie beispielsweise die Excel-JavaScript-APIs für den Zugriff auf Arbeitsblätter, Bereiche, Tabellen, Diagramme und vieles mehr verwenden. Anwendungsspezifische APIs sind derzeit für die folgenden Office-Anwendungen verfügbar.

    Dieses API-Modell verwendet Zusagen und ermöglicht es Ihnen, in jeder Anforderung, die Sie an die Office-Anwendung senden, mehrere Vorgänge anzugeben. Durch solche Batchvorgänge kann die Add-In-Leistung in Office-Anwendungen im Web erheblich verbessert werden. Anwendungsspezifische APIs wurden mit Office 2016 eingeführt.

    Hinweis

    Es gibt auch eine anwendungsspezifische API für Visio, aber Sie können sie nur auf SharePoint Online-Seiten verwenden, um mit Visio-Diagrammen zu interagieren, die in die Seite eingebettet wurden. Office Web-Add-Ins werden in Visio nicht unterstützt.

    Weitere Informationen zu diesem API-Modell finden Sie unter Verwenden des anwendungsspezifischen API-Modells.

  • Allgemeine APIs ermöglichen es Ihnen, auf Features wie z. B. Benutzeroberflächen, Dialogfelder und Clienteinstellungen zuzugreifen, die in mehreren Office-Anwendungen enthalten sind. Dieses API-Modell verwendet Rückrufe, mit denen Sie in jeder an die Office-Anwendung gesendeten Anforderung nur eine Operation angeben können. Allgemeine APIs wurden mit Office 2013 eingeführt und können für die Interaktion mit allen unterstützten Office-Anwendungen verwendet werden. Details zum Objektmodell der allgemeinen API, das APIs für die Interaktion mit Outlook, PowerPoint und Project enthält, finden Sie unter Objektmodell der allgemeinen JavaScript API.

Hinweis

Benutzerdefinierte Funktionen ohne freigegebene Runtime werden in einer reinen JavaScript-Runtime ausgeführt, die die Ausführung von Berechnungen priorisiert. Diese Funktionen verwenden ein etwas anderes Programmiermodell.

API-Anforderungssätze

Anforderungssätze sind benannte Gruppen von API-Mitgliedern. Anforderungssätze können auf spezifische Office-Anwendungen zugeschnitten sein, wie z. B. der ExcelApi 1.7-Anforderungssatz (eine Gruppe von APIs, die nur in Excel verwendet werden können), oder gemeinsam für mehrere Anwendungen, wie z. B. der DialogApi 1.1-Anforderungssatz (eine Reihe von APIs, die in einer beliebigen Office-Anwendung verwendet werden können, die die Dialog-API unterstützt).

Ihr Office-Add-In kann API-Anforderungssätze verwenden, um festzustellen, ob die Office-Anwendung die API-Elemente unterstützt, die sie verwenden muss. Weitere Informationen hierzu finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen.

Die Anforderungssatzunterstützung variiert je nach Office-Anwendung, -Version und -Plattform. Ausführliche Informationen zu den Plattformen, Anforderungssätzen und allgemeinen APIs, die von jeder Office-Anwendung unterstützt werden, finden Sie unter Office-Clientanwendung und Plattformverfügbarkeit für Office-Add-Ins.

Hinweis

Wenn Sie beabsichtigen, das Add-In in AppSource zu veröffentlichen und in der Office-Benutzeroberfläche zur Verfügung zu stellen, stellen Sie sicher, dass die Zertifizierungsrichtlinien für den kommerziellen Marketplace erfüllt sind. Damit das Add-In die Validierung besteht, muss es beispielsweise auf allen Plattformen funktionieren, die die Methoden unterstützen, die Sie definieren (weitere Informationen finden Sie im Abschnitt 1120.3 und auf der Seite zur Verfügbarkeit von Office-Add-Ins auf Anwendungen und Plattformen).

Siehe auch