Übersicht über Word-Add-Ins

  • Artikel

Möchten Sie eine Lösung erstellen, die die Word-Funktionen erweitert, z. B. eine Lösung zur automatischen Dokumentzusammenstellung oder eine Lösung, die von anderen Datenquellen auf Daten in einem Word-Dokument zugreift und an diese gebunden ist? Sie können die Office-Add-Ins-Plattform verwenden, die die Word JavaScript-API und die Office JavaScript-API umfasst, um Word Clients zu erweitern, die im Web, auf einem Windows-Desktop oder auf einem Mac ausgeführt werden.

Word-Add-Ins sind eine der vielen Optionen, die Ihnen beim Entwickeln in der Office-Add-In-Plattform zur Verfügung stehen. Verwenden Sie Add-In-Befehle zum Erweitern der Word-Benutzeroberfläche und starten Sie Aufgabenbereiche, die JavaScript ausführen und mit dem Inhalt in einem Word-Dokument interagieren. Jeder Code, der in einem Browser ausgeführt werden kann, kann auch in einem Word-Add-In ausgeführt werden. Add-Ins, die mit Inhalten in einem Word-Dokument interagieren, erstellen Anforderungen, die sich auf Word-Objekte auswirken und den Objektzustand synchronisieren.

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).

Die folgende Abbildung zeigt ein Beispiel für ein Word-Add-In, das in einem Aufgabenbereich ausgeführt wird.

In einem Aufgabenbereich in Word ausgeführtes Add-In.

Das Word-Add-In kann folgende Aktionen ausführen:

  1. Senden sie Anforderungen an das Word Dokument.
  2. Verwenden Sie JavaScript, um auf das Absatzobjekt zuzugreifen und den Absatz zu aktualisieren, zu löschen oder zu verschieben.

Der folgende Code zeigt beispielsweise, wie ein neuer Satz an den ersten markierten Absatz angefügt wird.

await Word.run(async (context) => {
  const paragraphs = context.document.getSelection().paragraphs;
  paragraphs.load();
  await context.sync();
  paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                   Word.InsertLocation.end);
  await context.sync();
});

Sie können eine beliebige Webservertechnologie verwenden, um Ihr Word-Add-In zu hosten, z. B. ASP.NET, NodeJS oder Python. Verwenden Sie Ihr bevorzugtes clientseitiges Framework – Ember, Backbone, Angular, React – oder verwenden Sie einfaches JavaScript, um Ihre Lösung zu entwickeln. Sie können auch Dienste wie Azure verwenden, um Ihre Anwendung zu authentifizieren und zu hosten .

Die Word-JavaScript-APIs verleihen Ihrer Anwendung Zugriff auf die Objekte und Metadaten des Word-Dokuments. Sie können diese APIs verwenden, um Add-Ins zu erstellen, die auf die folgenden Clients ausgerichtet sind.

  • Word im Web
  • Word 2016 oder höher unter Windows
  • Word für Mac
  • Word für iPad

Schreiben Sie Ihr Add-In einmal, und es wird in allen unterstützten Versionen von Word auf mehreren Plattformen ausgeführt. Weitere Informationen finden Sie unter Office-Clientanwendung und Plattformverfügbarkeit für Office-Add-Ins.

JavaScript-APIs für Word

Sie können zwei JavaScript-API-Sätze verwenden, um mit den Objekten und Metadaten in einem Word-Dokument zu interagieren. Der erste ist die Allgemeine API, die in Office 2013 eingeführt wurde. Viele der Objekte in der allgemeinen API können in Add-Ins verwendet werden, die von zwei oder mehr Office-Clients gehostet werden. Diese API nutzt Rückrufe in großem Umfang.

Die zweite ist die Word-JavaScript-API. Dies ist ein anwendungsspezifisches API-Modell, das mit Word 2016 eingeführt wurde. Es handelt sich um ein stark typisiertes Objektmodell, mit dem Sie Word Add-Ins erstellen können, die auf Word 2016 und höher unter Windows und auf Mac ausgerichtet sind. Dieses Objektmodell verwendet Zusagen und bietet Zugriff auf Word spezifische Objekte wie Textkörper, Inhaltssteuerelemente, Inlinebilder und Absätze. Die Word-JavaScript-API umfasst TypeScript-Definitionen und vsdoc-Dateien, die Ihnen Codehinweise in Ihre IDE liefern.

Derzeit unterstützen alle Word-Clients die freigegebene Office-JavaScript-API und die meisten Clients unterstützen die Word-JavaScript-API. Ausführliche Informationen zu den unterstützten Clients finden Sie unter Verfügbarkeit von Office-Clientanwendungen und -Plattformen für Office-Add-Ins.

Es wird empfohlen, mit der Word-JavaScript-API zu beginnen, da das Objektmodell einfacher zu verwenden ist. Verwenden Sie die Word JavaScript-API, wenn Sie auf die Objekte in einem Word Dokument zugreifen müssen.

Verwenden Sie die freigegebene Office JavaScript-API, wenn Sie eine der folgenden Aktionen ausführen müssen:

  • Führen Sie Initialisierungsaktionen für die Anwendung aus.
  • Überprüfen des unterstützten Anforderungssatzes
  • Zugriff auf Metadaten, Einstellungen und Umgebungsinformationen für das Dokument
  • Bindung an Abschnitte in einem Dokument und Erfassen von Ereignissen
  • Öffnen von Dialogfeldern

Nächste Schritte

Bereit zum Erstellen Ihres ersten Word-Add-Ins? Siehe Erstellen Ihres ersten Word-Add-Ins. Verwenden Sie das Add-In-Manifest , um zu beschreiben, wo Ihr Add-In gehostet wird, wie es angezeigt wird, und definieren Sie Berechtigungen und andere Informationen.

Weitere Informationen zum Entwerfen eines erstklassigen Word-Add-Ins, das eine überzeugende Benutzererfahrung für Ihre Benutzer schafft, finden Sie unter Entwurfsrichtlinien und Bewährte Methoden.

Nach dem Entwickeln können Sie das Add-In in einer Netzwerkfreigabe, einem App-Katalog oder in AppSource veröffentlichen.

Siehe auch