Verweisen auf die Office-JavaScript-API-Bibliothek

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, ist die Verwendung des Content Delivery Network (CDN), indem Sie das folgende <script> Tag in dem <head> Abschnitt Ihrer HTML-Seite hinzufügen.

<head>
    ...
    <script src="https://officeapis.public.onecdn.static.microsoft/1/office.js" type="text/javascript"></script>
</head>

Bei diesem Ansatz werden die Office JavaScript-API-Dateien beim ersten Laden des Add-Ins heruntergeladen und zwischengespeichert. Dadurch wird sichergestellt, dass Ihr Add-In die aktuellste Implementierung von Office.js und den zugehörigen Dateien für die angegebene Version verwendet.

Das CDN verwendet die officeapis.public.onecdn.static.microsoft Domäne als Teil der einheitlichen Domäne für Microsoft 365-Apps und -Dienste.

Office.js-spezifisches Web-API-Verhalten

Office.js ersetzt die standardmäßigen Window.history-Methoden von replaceState und pushState durch null. Wenn Ihr Add-In auf diesen Methoden basiert, ersetzen Sie den Office.js Bibliotheksverweis durch die folgende Problemumgehung.

<script type="text/javascript">
    // Cache the history method values.
    window._historyCache = {
        replaceState: window.history.replaceState,
        pushState: window.history.pushState
    };
</script>

<script type="text/javascript" src="https://officeapis.public.onecdn.static.microsoft/1/office.js"></script>

<script type="text/javascript">
    // Restore the history method values after loading Office.js
    window.history.replaceState = window._historyCache.replaceState;
    window.history.pushState = window._historyCache.pushState;
</script>

Vielen Dank an @stepper und die Stack Overflow-Community , die diese Problemumgehung vorgeschlagen und überprüft haben.

API-Versionsverwaltung und Abwärtskompatibilität

Im vorherigen HTML-Codeausschnitt gibt der vorangehende /1/office.js CDN-URL das neueste inkrementelle Release in Version 1 von Office.js an. Da die Office JavaScript-API die Abwärtskompatibilität aufrechterhält, unterstützt die neueste Version weiterhin API-Mitglieder, die zuvor in Version 1 eingeführt wurden.

Wenn Sie beabsichtigen, Ihr Office-Add-In im Microsoft Marketplace zu veröffentlichen, müssen Sie diesen CDN-Verweis verwenden. Verwenden Sie lokale Referenzen nur für interne, Entwicklungs- und Debugging-Szenarien.

Aktivieren von IntelliSense für ein TypeScript-Projekt

Zusätzlich zum Verweisen auf die Office JavaScript-API, wie zuvor beschrieben, können Sie IntelliSense auch für ein TypeScript-Add-In-Projekt aktivieren, indem Sie die Typdefinitionen von DefinitelyTyped verwenden. Führen Sie dazu den folgenden Befehl an einer Node-fähigen Eingabeaufforderung (oder einem Git-Bash-Fenster) aus dem Stammverzeichnis Ihres Projektordners aus. Sie müssen Node.js (das npm umfasst) installiert haben.

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

Vorschau von APIs

Microsoft führt zuerst neue JavaScript-APIs in der "Vorschau" ein. Nach ausreichenden Tests und Benutzerfeedback werden die APIs Teil eines bestimmten nummerierten Anforderungssatzes.

CDN-Referenzen 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 in Übereinstimmung mit den lokalen Gesetzen und Vorschriften bereitzustellen. Add-Ins, die für die Verwendung in dieser Cloudumgebung entwickelt wurden, sollten ein entsprechendes CDN verwenden. Verwenden Sie https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js anstelle der Standard-CDN-Referenz. Dadurch wird die kontinuierliche Konformität gewährleistet und die Leistung der Add-Ins verbessert.

Aktualisieren von Legacy-CDN-Endpunkten

Zuvor wurde die Office.js-Bibliothek vom Endpunkt aus https://appsforoffice.microsoft.com/lib/1/hosted/office.js bereitgestellt. Um zum neuen Office.js CDN-Endpunkt zu wechseln, aktualisieren Sie den Office.js-Skriptverweis auf jeder Add-In-Seite von https://appsforoffice.microsoft.com/lib/1/hosted/office.js ".https://officeapis.public.onecdn.static.microsoft/1/office.js Der neue Endpunkt dient der gleichen aktuellen Office.js Version, ermöglicht jedoch zusätzliche sichere Standardeinstellungen. Vor dem Wechsel:

• Wenn Ihr Add-In auf globalen Microsoft Ajax-Systemen basiert, die zuvor automatisch geladen Office.js, ersetzen Sie diese Abhängigkeit durch eine unterstützte Alternative, oder laden und verwalten Sie die erforderliche Bibliothek direkt.
• Wenn Ihr Add-In Befehle verwendet ExecuteFunction , registrieren Sie jeden Befehlshandler mit Office.actions.associate(...).
• Wenn Ihr Add-In oder organization eine restriktive Inhaltssicherheitsrichtlinie oder Einstellungen für vertrauenswürdige Typen verwendet, stellen Sie sicher, dass der neue Endpunkt und Office.js Richtlinie für vertrauenswürdige Typen zulässig sind.
• Stellen Sie sicher, dass alle *.static.microsoft anwendbaren Netzwerkzulassungslisten dies zulassen.
• Testen Sie das Add-In in den unterstützten Office-Anwendungen und -Umgebungen, einschließlich Aktivierung, Befehlen und Dialogfeldern.

Siehe auch

• Grundlegendes zur JavaScript-API für Office
• JavaScript-API für Office
• Anleitung zum Bereitstellen von Office-Add-Ins in Government-Clouds
• Microsoft-Software-Lizenzbedingungen für die Microsoft Office JavaScript (Office.js)-API-Bibliothek