Entwickeln von Office-Add-Ins

Tipp

Sehen Sie sich den Beitrag Übersicht der Office-Add-Ins-Plattform an, bevor Sie diesen Artikel lesen.

Alle Office-Add-Ins basieren auf der Office-Add-Ins-Plattform. Für jedes Add-In, das Sie erstellen, müssen Sie wichtige Konzepte wie Anwendungs- und Plattformverfügbarkeit, Office JavaScript-API-Programmiermuster, das Festlegen der Einstellungen und Funktionen eines Add-Ins in der Manifestdatei, das Entwerfen der Benutzeroberfläche und der Benutzererfahrung und vieles mehr verstehen. Grundlegende Entwicklungskonzepte wie diese finden Sie im Abschnitt Entwicklungslebenszyklus > Entwickeln der Dokumentation. Lesen Sie die hier bereitgestellten Informationen, bevor Sie die anwendungsspezifische Dokumentation für das von Ihnen erstellte Add-In durchgehen (z. B. Excel).

Erstellen eines Office-Add-Ins

Für die Erstellung von Office-Add-Ins können Sie den Yeoman-Generator für Office-Add-Ins oder Visual Studio verwenden.

Der Yeoman-Generator für Office-Add-Ins

Mit dem Yeoman-Generator für Office-Add-Ins kann ein Node.js-Office-Add-In-Projekt erstellt werden, das mit Visual Studio Code oder einem beliebigen anderen Editor verwaltet werden kann. Der Generator kann Office-Add-Ins für folgende Optionen erstellen:

  • Excel
  • OneNote
  • Outlook
  • PowerPoint
  • Project
  • Word
  • Benutzerdefinierte Excel-Funktionen

Sie können das Projekt mithilfe von HTML, CSS und JavaScript oder unter Verwendung von Angular oder React erstellen. Unabhängig davon, für welches Framework Sie sich entscheiden, können Sie auch zwischen JavaScript und Typescript wählen. Weitere Informationen zum Erstellen von Add-Ins mit dem Yeoman-Generator finden Sie unter Entwickeln von Office-Add-Ins mit Visual Studio Code.

Visual Studio

Visual Studio kann verwendet werden, um Office-Add-Ins für Excel, Outlook, Word und PowerPoint zu erstellen. Ein Office-Add-In-Projekt wird als Teil einer Visual Studio-Lösung erstellt und verwendet HTML, CSS und JavaScript. Weitere Informationen zum Erstellen von Add-Ins mit Visual Studio finden Sie unter Entwickeln von Office-Add-Ins mit Visual Studio.

Hinweis

Obwohl es möglich ist, Office-Add-Ins mithilfe von Visual Studio zu erstellen, bietet der Yeoman-Generator in einigen wichtigen Punkten eine bessere Entwickler-Oberfläche.

  • Der Yeoman-Generator bietet mehr Möglichkeiten für Projekttypen, Frameworks und- Sprachen als Visual Studio für Office-Add-in-Projekte.

  • Projektvorlagen im Yeoman-Generator werden häufiger aktualisiert als Projektvorlagen in Visual Studio.

Grundlegendes zu den beiden Teilen eines Office-Add-Ins

Ein Office-Add-In besteht aus zwei Teilen.

  • Dem Add-In-Manifest (eine XML-Datei), in dem Einstellungen und Funktionen des Add-Ins angegeben sind.

  • Der Webanwendung, in der die Benutzeroberfläche und die Funktionen von Add-In-Komponenten definiert sind wie z. B. Aufgabenbereiche, Inhalts-Add-Ins und Dialogfelder.

Die Webanwendung verwendet die Office JavaScript-API, um mit Inhalten im Office-Dokument zu interagieren, in dem das Add-In ausgeführt wird. Ihr Add-In kann auch andere Aktionen ausführen, die normalerweise von Webanwendungen ausgeführt werden, wie z. B. externe Webdienste aufrufen, die Benutzerauthentifizierung erleichtern und vieles mehr.

Definieren der Funktionen und Einstellungen eines Add-Ins

Im Manifest (eine XML-Datei) eines Office-Add-Ins sind die Einstellungen und Funktionen des Add-Ins angegeben. Im Manifest geben Sie Dinge an wie:

  • Metadaten, die das Add-In beschreiben (z. B. "ID", "Version", "Beschreibung", "Anzeigename", "Standardgebietsschema").
  • Office-Anwendungen, in denen das Add-In ausgeführt wird.
  • Berechtigungen, die das Add-In erfordert.
  • Wie das Add-In in Office integriert ist, einschließlich benutzerdefinierter Benutzeroberflächen (z. B. benutzerdefinierte Registerkarten und Menübandschaltflächen), die das Add-In erstellt.
  • Die Speicherorte der Bilder, die das Add-In für das Branding und Befehlssymbole verwendet.
  • Maße des Add-Ins (z. B. Maße für Inhalts-Add-Ins und erforderliche Höhe für Outlook-Add-Ins).
  • Regeln, die angeben, wann das Add-In im Kontext einer Nachricht oder eines Termins (nur für Outlook-Add-Ins) aktiviert wird.

Ausführliche Informationen zur Manifestdatei finden Sie unter XML-Manifest für Office-Add-Ins.

Interagieren mit Inhalten in einem Office-Dokument

Ein Office-Add-In kann die Office-JavaScript-APIs für die Interaktion mit Inhalten im Office-Dokument verwenden, in dem das Add-In ausgeführt wird.

Zugriff auf die Office JavaScript-API-Bibliothek

Auf die Office JavaScript-API-Bibliothek kann über das Office JS Content Delivery Network (CDN) unter https://appsforoffice.microsoft.com/lib/1/hosted/office.jszugegriffen werden. Wenn Sie Office JavaScript-APIs auf den Webseiten eines Ihrer Add-Ins verwenden möchten, müssen Sie in einem <script>-Tag im <head>-Tag der Seite auf das CDN verweisen.

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

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.

Weitere Informationen zum Zugriff auf die Office JavaScript-API-Bibliothek, einschließlich der Vorgehensweise zum Abrufen von IntelliSense, finden Sie unter Verweisen auf die Bibliothek der Office JavaScript-API über das Content Delivery Network (CDN).

API-Modelle

Die JavaScript-API für Office umfasst zwei unterschiedliche Modelle:

  • Anwendungsspezifische APIs bieten stark typisierte Objekte, die für die Interaktion mit Objekten verwendet werden können, die zu einer bestimmten Office-Anwendung gehören. So können Sie beispielsweise die Excel-JavaScript-APIs für den Zugriff auf Arbeitsblätter, Bereiche, Tabellen, Diagramme und vieles mehr verwenden. Anwendungsspezifische APIs sind derzeit für die folgenden Office-Anwendungen verfügbar:

    Dieses API-Modell verwendet Zusagen und ermöglicht es Ihnen, in jeder Anforderung, die Sie an die Office-Anwendung senden, mehrere Vorgänge anzugeben. Durch solche Batchvorgänge kann die Add-In-Leistung in Office-Anwendungen im Web erheblich verbessert werden. Anwendungsspezifische APIs wurden mit Office 2016 eingeführt und können nicht für Interaktionen mit Office 2013 verwendet werden.

    Hinweis

    Es gibt auch eine anwendungsspezifische API für Visio, aber Sie können diese nur auf SharePoint Online-Seiten verwenden, um mit Visio-Diagrammen zu interagieren, die in die Seite eingebettet wurden. Office-Web-Add-Ins werden in Visio nicht unterstützt.

    Weitere Informationen zu diesem API-Modell finden Sie unter Verwenden des anwendungsspezifischen API-Modells.

  • Allgemeine APIs ermöglichen es Ihnen, auf Features wie z. B. Benutzeroberflächen, Dialogfelder und Clienteinstellungen zuzugreifen, die in mehreren Office-Anwendungen enthalten sind. Dieses API-Modell verwendet Rückrufe, mit denen Sie in jeder an die Office-Anwendung gesendeten Anforderung nur eine Operation angeben können. Allgemeine APIs wurden mit Office 2013 eingeführt und können für Interaktionen mit Office 2013 und höher verwendet werden. Details zum Objektmodell der allgemeinen API, das APIs für die Interaktion mit Outlook, PowerPoint und Project enthält, finden Sie unter Objektmodell der allgemeinen JavaScript API.

Hinweis

Einige benutzerdefinierte Excel-Funktionen werden innerhalb einer einzigartigen Laufzeit ausgeführt, die die Ausführung von Berechnungen priorisiert, und verfügen über keinen Aufgabenbereich. Diese Funktionen verwenden ein etwas anderes Programmiermodell und werden als Funktionen ohne Benutzeroberfläche bezeichnet.

API-Anforderungssätze

Anforderungssätze sind benannte Gruppen von API-Mitgliedern. Anforderungssätze können auf spezifische Office-Anwendungen zugeschnitten sein, wie z. B. der ExcelApi 1.7-Anforderungssatz (eine Gruppe von APIs, die nur in Excel verwendet werden können), oder gemeinsam für mehrere Anwendungen, wie z. B. der DialogApi 1.1-Anforderungssatz (eine Reihe von APIs, die in einer beliebigen Office-Anwendung verwendet werden können, die die Dialog-API unterstützt).

Ihr Office-Add-In kann API-Anforderungssätze verwenden, um festzustellen, ob die Office-Anwendung die API-Elemente unterstützt, die sie verwenden muss. Weitere Informationen hierzu finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen.

Die Unterstützung von Anforderungssätzen variiert je nach Office-Anwendung, Version und Plattform. Ausführliche Informationen zu den Plattformen, Anforderungssätzen und allgemeinen APIs, die von jeder Office-Anwendung unterstützt werden, finden Sie unter Office-Clientanwendung und Plattformverfügbarkeit für Office-Add-Ins.

Erkunden von APIs mithilfe von Script Lab

Script Lab ist ein Add-In, das es Ihnen ermöglicht, die Office JavaScript-API zu erkunden und Codeausschnitte auszuführen, während Sie in einem Office-Programm wie z. B. Excel oder Word arbeiten. Es steht kostenlos unter AppSource- zur Verfügung und ist ein sehr nützliches Tool, das Sie in Ihr Entwickler-Toolkit einschließen sollten, wenn Sie Prototypen erstellen und die Funktionalitäten, die Sie für Ihr Add-In wünschen, überprüfen möchten. Über Script Lab haben Sie Zugriff auf eine Bibliothek mit integrierten Beispielen, die Sie zum schnellen Ausprobieren von APIs oder sogar als Ausgangspunkt für Ihren eigenen Code verwenden können.

In dem nachstehenden einminütigen Video sehen Sie Script Lab in Aktion.

Kurzes Video, das Script Lab zeigt, das in Excel, Word und PowerPoint ausgeführt wird.

Weitere Informationen zu Script Lab finden Sie unter Erkunden von Office JavaScript-APIs mithilfe von Script Lab.

Erweitern der Office-Benutzeroberfläche

Ein Office-Add-In kann die Office-Benutzeroberfläche mithilfe von Add-In-Befehlen und HTML-Containern, z. B. Aufgabenbereichen, Inhalts-Add-Ins oder Dialogfeldern, erweitern.

  • Mit Add-In-Befehlen können benutzerdefinierte Registerkarten, Schaltflächen und Menüs zum standardmäßigen Menüband in Office hinzugefügt werden, Sie können damit aber auch das Standardkontextmenü erweitern, das bei einem Rechtsklick auf Text in einem Office-Dokument oder in einem Objekt in Excel angezeigt wird. Wenn Benutzer einen Add-In-Befehl auswählen, wird die Aufgabe gestartet, die mit dem Add-In-Befehl angegeben wird, z. B. JavaScript-Code ausführen, einen Aufgabenbereich oder ein Dialogfeld öffnen.

  • HTML-Container wie Aufgabenbereiche, Inhalte-Add-Insund Dialogfelder können zum Anzeigen einer benutzerdefinierten Benutzeroberfläche und zur Bereitstellung zusätzlicher Funktionen in einer Office-Anwendung verwendet werden. Die Inhalte und die Funktionalität der einzelnen Aufgabenbereiche, Inhalts-Add-Ins oder Dialogfelder werden von einer von Ihnen festgelegten Webseite abgerufen. Diese Webseiten können die Office JavaScript-API verwenden, um mit Inhalten im Office-Dokument zu interagieren, in dem das Add-In ausgeführt wird, sowie auch andere Aktionen ausführen, die normalerweise von Webseiten ausgeführt werden, wie z. B. externe Webdienste aufrufen, die Benutzerauthentifizierung erleichtern und vieles mehr.

In der folgenden Abbildung sehen Sie einen Add-In-Befehl im Menüband, einen Aufgabenbereich auf der rechten Seite des Dokuments sowie ein Dialogfeld oder ein Inhalts-Add-In über dem Dokument.

Ein Diagramm, das Add-In-Befehlen im Menüband zeigt, einem Aufgabenbereich und einem Dialogfeld / Inhalts-Add-In in einem Office-Dokument.

Weitere Informationen zum Erweitern der Office-Benutzeroberfläche und dem Entwerfen der Benutzererfahrung der Add-Ins finden Sie unter Office-Benutzeroberflächenelemente für Office-Add-Ins.

Nächste Schritte

In diesem Artikel wurden die verschiedenen Möglichkeiten zum Erstellen von Office-Add-Ins umrissen, die Möglichkeiten vorgestellt, wie ein Add-In die Office-Benutzeroberfläche erweitern kann, die API-Sätze beschrieben und Script Lab als wertvolles Tool zum Untersuchen von Office JavaScript-APIs und zum Prototyping der Add-In-Funktionalität vorgestellt. Nachdem Sie sich mit diesen einführenden Informationen vertraut gemacht haben, können Sie Ihr Office-Add-In-Abenteuer über die folgenden Optionen fortsetzen.

Erstellen eines Office-Add-Ins

Sie können schnell ein einfaches Add-In für Excel, OneNote, Outlook, PowerPoint, Project oder Word erstellen, indem Sie einen 5-Minuten-Schnellstartausführen. Wenn Sie bereits einen Schnellstart abgeschlossen haben und ein etwas komplexeres Add-In erstellen möchten, sollten Sie das Lernprogramm ausprobieren.

Weitere Informationen

Weitere Informationen zum Entwickeln, Testen und Veröffentlichen von Office-Add-Ins finden Sie in dieser Dokumentation.

Tipp

Für jedes Add-In, das Sie erstellen, können Sie Informationen im Abschnitt Entwicklungslebenszyklus dieser Dokumentation verwenden sowie Informationen im anwendungsspezifischen Abschnitt, der dem Typ des Add-Ins entspricht, das Sie entwickeln möchten (z. B. Excel).

Siehe auch