Verweisen auf die Office-JavaScript-API-Bibliothek

  • Artikel

Die Office JavaScript-API-Bibliothek stellt die APIs bereit, die Ihr Add-In für die Interaktion mit der Office-Anwendung verwenden kann. Die einfachste Möglichkeit, auf die Bibliothek zu verweisen, besteht darin, das Content Delivery Network (CDN) zu verwenden, indem Sie im Abschnitt Ihrer HTML-Seite das <head> folgende <script> Tag hinzufügen.

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

Dadurch werden die Office JavaScript-API-Dateien heruntergeladen und zwischengespeichert, wenn Ihr Add-In zum ersten Mal geladen wird, um sicherzustellen, dass es die aktuellste Implementierung von Office.js und den zugehörigen Dateien für die angegebene Version verwendet.

Wichtig

Sie müssen innerhalb des Abschnitts der Seite auf die <head> Office JavaScript-API verweisen, um sicherzustellen, dass die API vor allen Textelementen vollständig initialisiert ist.

API-Versionsverwaltung und Abwärtskompatibilität

Im vorherigen HTML-Codeausschnitt gibt vor /1/ in office.js der CDN-URL das neueste inkrementelle Release in Version 1 von Office.js an. Da die Office JavaScript-API Abwärtskompatibilität aufrechterhält, unterstützt das neueste Release weiterhin API-Member, die zuvor in Version 1 eingeführt wurden. Wenn Sie ein Upgrade für ein vorhandenes Projekt durchführen müssen, lesen Sie Aktualisieren der Version Ihrer Office JavaScript-API und der Manifestschemadateien.

Wenn Sie planen, Ihr Office-Add-In aus AppSource zu veröffentlichen, müssen Sie diesen CDN-Verweis verwenden. Lokale Verweise eignen sich nur für interne Entwicklungs- und Debugging-Szenarien.

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.

Aktivieren von IntelliSense für ein TypeScript-Projekt

Sie können nicht nur wie zuvor beschrieben auf die Office JavaScript-API verweisen, sie können auch IntelliSense für das TypeScript-Add-In-Projekt aktivieren, indem Sie die Typdefinitionen von DefinitelyTyped verwenden. Führen Sie hierzu den folgenden Befehl in einer Node-fähigen Systemeingabeaufforderung (oder einem Git Bash-Fenster) im Stammverzeichnis Ihres Projektordners aus. Sie müssen Node.js (das npm umfasst) installiert haben.

npm install --save-dev @types/office-js

Vorschau-APIs

Neue JavaScript-APIs werden zuerst in der "Vorschau" eingeführt und später Teil eines bestimmten nummerierten Anforderungssatzes, nachdem genügend Tests durchgeführt und Benutzerfeedback eingeholt wurde.

Hinweis

Vorschau-APIs unterliegen Änderungen und können nicht für den Einsatz in Produktionsumgebungen vorgesehen werden. Wir empfehlen, sie nur in Test- und Entwicklungsumgebungen auszuprobieren. Verwenden Sie Vorschau-APIs nicht in einer Produktionsumgebung oder in unternehmenswichtigen Dokumenten.

So verwenden Sie Vorschau-APIs:

CDN-Verweise für andere Microsoft 365-Umgebungen

21Vianet betreibt und verwaltet einen Office 365-Dienst, der auf lizenzierten Microsoft-Technologien basiert, um Office 365 Dienste für China bereitzustellen, die den lokalen Gesetzen und Vorschriften entsprechen. Add-Ins, die für die Verwendung in dieser Cloudumgebung entwickelt wurden, sollten das entsprechende CDN verwenden. Verwenden Sie https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js anstelle des Standard-CDN-Verweises. Dies stellt die kontinuierliche Compliance sicher und bietet eine bessere Add-In-Leistung.

Siehe auch