Verweisen auf die Office-JavaScript-API-BibliothekReferencing the Office JavaScript API library

Die Office-JavaScript-API- Bibliothek stellt die APIs bereit, die Ihr Add-in für die Interaktion mit dem Office-Host verwenden kann.The Office JavaScript API library provides the APIs that your add-in can use to interact with the Office host. Die einfachste Möglichkeit, auf die Bibliothek zu verweisen, ist die Verwendung des Inhalts Zustellungs Netzwerks (CDN <script> ), indem <head> das folgende Tag innerhalb des Abschnitts der HTML-Seite hinzugefügt wird:The simplest way to reference the library is to use the content delivery network (CDN) by adding the following <script> tag within the <head> section of your HTML page:

<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 das Add-in zum ersten Mal geladen wird, um sicherzustellen, dass es die aktuellste Implementierung von Office. js und die dazugehörigen Dateien für die angegebene Version verwendet.This will download and cache the Office JavaScript API files the first time your add-in loads to make sure that it is using the most up-to-date implementation of Office.js and its associated files for the specified version.

Wichtig

Sie müssen im <head> Abschnitt der Seite auf die Office-JavaScript-API verweisen, um sicherzustellen, dass die API vor allen Body-Elementen vollständig initialisiert ist.You must reference the Office JavaScript API from inside the <head> section of the page to ensure that the API is fully initialized prior to any body elements. Office-Hosts erfordern, dass Add-Ins innerhalb von 5 Sekunden nach Aktivierung initialisiert werden.Office hosts require that add-ins initialize within 5 seconds of activation. Wenn das Add-In nicht innerhalb dieses Schwellenwerts aktiviert wird, wird es als nicht reagierten deklariert, und dem Benutzer wird eine Fehlermeldung angezeigt.If your add-in doesn't activate within this threshold, it will be declared unresponsive and an error message will be displayed to the user.

API-Versionsverwaltung und AbwärtskompatibilitätAPI versioning and backward compatibility

Im vorherigen HTML-Codeausschnitt gibt /1/ die vor office.js in der CDN-URL die neueste inkrementelle Version innerhalb von Version 1 von Office. js an.In the previous HTML snippet, the /1/ in front of office.js in the CDN URL specifies the latest incremental release within version 1 of Office.js. Da die Office-JavaScript-API Abwärtskompatibilität aufrecht erhält, unterstützt die neueste Version weiterhin API-Mitglieder, die zuvor in Version 1 eingeführt wurden.Because the Office JavaScript API maintains backward compatibility, the latest release will continue to support API members that were introduced earlier in version 1. Wenn Sie ein vorhandenes Projekt aktualisieren müssen, lesen Sie Aktualisieren der Version der Office-JavaScript-API-und Manifest-Schemadateien.If you need to upgrade an existing project, see Update the version of your Office JavaScript API and manifest schema files.

Wenn Sie beabsichtigen, Ihr Office-Add-In über AppSource zu veröffentlichen, müssen Sie diesen CDN-Verweis verwenden. Lokale Verweise eignen sich nur für interne Entwicklungs- und Debugging-Szenarien.If you plan to publish your Office Add-in from AppSource, you must use this CDN reference. Local references are only appropriate for internal, development, and debugging scenarios.

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.To use preview APIs, reference the preview version of the Office JavaScript API library on the CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Aktivieren von IntelliSense für ein Manuskript-ProjektEnabling Intellisense for a TypeScript project

Zusätzlich zum Verweisen auf die Office-JavaScript-API, wie zuvor beschrieben, können Sie IntelliSense für das Add-in-Projekt "Script" auch mithilfe der Typdefinitionen von DefinitelyTypedaktivieren.In addition to referencing the Office JavaScript API as described previously, you can also enable Intellisense for TypeScript add-in project by using the type definitions from DefinitelyTyped. Führen Sie dazu den folgenden Befehl in einer Knoten fähigen Systemansage (oder git bash-Fenster) aus dem Stamm Ihres Projektordners aus.To do so, run the following command in a Node-enabled system prompt (or git bash window) from the root of your project folder. Sie müssen Node.js (das npm umfasst) installiert haben.You must have Node.js installed (which includes npm).

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

Hinweis

Verwenden Sie zum Aktivieren von IntelliSense für Vorschau-APIs die Vorschautyp Definitionen aus DefinitelyTyped , indem Sie den folgenden Befehl im Stamm Ihres Projektordners ausführen:To enable Intellisense for preview APIs, use the preview type definitions from DefinitelyTyped by running the following command in the root of your project folder:

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

Weitere ArtikelSee also