Übersicht über Word-Add-Ins

Möchten Sie eine Lösung erstellen, die die Word-Funktionen erweitert? Zum Beispiel 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? Verwenden Sie dazu die Office-Add-Ins-Plattform, die die Word-JavaScript-API und die Office-JavaScript-API enthält, und erweitern Sie Word-Clients, die auf einem Windows-Desktop, Mac oder in der Cloud 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 Ihr Add-In in AppSource veröffentlichen und innerhalb der Office-Benutzererfahrung verfügbar machen möchten, vergewissern Sie sich beim Erstellen des Add-Ins, dass es den Zertifizierungsrichtlinien für kommerzielle Marketplace-Websites entspricht. 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 Anwendungs- und Verfügbarkeitsseite von Office-Add-Ins).

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

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

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

Das Word-Add-In kann (1) Anforderungen an das Word-Dokument senden und (2) JavaScript verwenden, um auf das Absatzobjekt zuzugreifen und den Absatz zu aktualisieren, zu löschen oder zu verschieben. Mit dem folgenden Code wird z. B. gezeigt, wie Sie einen neuen Satz an diesen Absatz anfügen können.

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();
});

Zum Hosten des Word-Add-Ins können Sie alle Webserver-Technologien, z. B. ASP.NET, NodeJS oder Python, verwenden. Verwenden Sie Ihr bevorzugtes clientseitiges Framework – Ember, Backbone, Angular, React – oder bleiben Sie bei VanillaJS, um Ihre Lösung zu entwickeln. Zum Authentifizieren und Hosten Ihrer Anwendung können Sie Dienste wie Azure verwenden.

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 für folgende Ziele zu erstellen:

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

Nachdem Sie das Add-In geschrieben haben, wird es in allen Versionen von Word in verschiedenen 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 Sätze von JavaScript-APIs verwenden, um mit den Objekten und Metadaten in einem Word-Dokument zu interagieren. Die erste ist die Common 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 verwendet häufig Rückrufe.

Die zweite ist die Word-JavaScript-API. Hierbei handelt es sich um ein anwendungsspezifisches API-Modell, das mit Word 2016 eingeführt wurde. Es ist ein stark typisiertes Objektmodell, das Sie zum Erstellen von Word-Add-Ins für Word 2016 für Mac und Windows verwenden können. Dieses Objektmodell verwendet Zusagen und ermöglicht den Zugriff auf Word-spezifische Objekte wie Text, Inhaltssteuerelemente, Inline-Bilder 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. Weitere Informationen zu unterstützten Clients finden Sie unter Office-Clientanwendung und Plattformverfügbarkeit 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 für folgende Zwecke:

  • Zugriff auf die Objekte in einem Word-Dokument

Verwenden Sie die freigegebene Office-JavaScript-API für folgende Zwecke:

  • Word 2013
  • Ausführen erster Aktionen für die Anwendung
  • Ü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
  • Verwenden benutzerdefinierter XML-Abschnitte
  • Ö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 und wie es angezeigt wird, und um Berechtigungen und andere Informationen zu definieren.

Weitere Informationen zum Erstellen erstklassiger Word-Add-Ins mit hoher Benutzerfreundlichkeit finden Sie in unseren Entwurfsrichtlinien und Bewährten Methoden.

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

Siehe auch