Erstellen von Office-Add-In-Projekten mit dem Office Add-Ins Development Kit für Visual Studio Code

Mit dem Office Add-Ins Development Kit können Sie Ihre Umgebung einrichten, Office-Add-Ins erstellen und Ihren Code in einer optimierten Umgebung debuggen.

Wichtig

Die Office Add-Ins Development Kit-Erweiterung unterstützt nur das Erstellen von Add-Ins, die nur das Add-In-Manifest verwenden. Außerdem werden derzeit nur Excel-, PowerPoint- und Word-Add-Ins erstellt. Die Unterstützung für Outlook befindet sich in der Entwicklung, ebenso wie zusätzliche Beispiele und andere Verbesserungen. Wir freuen uns über ihr Feedback zum Tool. Probleme und Featureanforderungen sollten über GitHub Issues im Repository der Erweiterung übermittelt werden.

Voraussetzungen

• Laden Sie Visual Studio Code herunter, und installieren Sie es.
• Node.js (die aktuellsteLTS-Version). Besuchen Sie die Node.js Website , um die richtige Version für Ihr Betriebssystem herunterzuladen und zu installieren. Um zu überprüfen, ob Sie diese Tools bereits installiert haben, führen Sie die Befehle node -v und npm -v in Ihrem Terminal aus.
• Office ist mit einem Microsoft 365-Abonnement verbunden. Möglicherweise qualifizieren Sie sich über das Microsoft 365-Entwicklerprogramm für ein Microsoft 365 E5-Entwicklerabonnement. Weitere Informationen finden Sie unter Häufig gestellte Fragen. Alternativ können Sie sich für eine kostenlose 1-monatige Testversion registrieren oder einen Microsoft 365-Plan erwerben.

Installieren des Development Kits

Sie können das Office Add-Ins Development Kit mithilfe von Erweiterungen in Visual Studio Code oder über den Visual Studio Code Marketplace installieren.

Visual Studio Code

1. Starten Sie Visual Studio Code.
2. Wählen Sie Erweiterungen anzeigen> oder STRG+UMSCHALT+X aus. Sie können Erweiterungen auch öffnen, indem Sie auf der Aktivitätsleiste von Visual Studio Code die Registerkarte Erweiterungen auswählen.
3. Geben Sie Office Add-Ins Development Kit in das Suchfeld ein.
4. Wählen Sie Office Add-Ins Development Kit aus. Wählen Sie auf der Im bereich Standard angezeigten Seite der Office Add-Ins Development Kit-Erweiterung die Option Installieren aus. Nach der erfolgreichen Installation wird das Office Add-Ins Development Kit-Symbol in der Aktivitätsleiste von Visual Studio Code angezeigt.

Marktplatz

1. Öffnen Sie die Seite Office Add-Ins Development Kit im Visual Studio Code Marketplace.
2. Wählen Sie auf der Webseite Installieren aus. Wenn Sie aufgefordert werden, dass die Erweiterung Visual Studio Code erfordert, wählen Sie Weiter aus.
3. Ihr Browser fordert Sie möglicherweise auf, zu überprüfen, ob die Website versucht, Visual Studio Code zu öffnen. Das Öffnen von Visual Studio Code zulassen. Visual Studio Code wird dann geöffnet, und die Infodatei der Office-Add-Ins Development Kit-Erweiterung wird angezeigt.
4. Wählen Sie In Visual Studio Code installieren aus. Nach der erfolgreichen Installation wird das Office Add-Ins Development Kit-Symbol in der Aktivitätsleiste von Visual Studio Code angezeigt.

Erstellen eines Add-In-Projekts

Das Office Add-Ins Development Kit bietet zwei Möglichkeiten, mit einem neuen Projekt zu beginnen: Vorlagen und Beispiele. Mithilfe von Vorlagen können Sie die Office-Anwendung, die Programmiersprache und das Startfeature auswählen. Beispiele sind umfassendere Projekte, die ein realistisches Szenario veranschaulichen.

Erstellen eines Add-Ins aus einer Vorlage

Vorlagen bieten einen einfachen Ausgangspunkt für Ihr Add-In. Sie fügen eine minimale Menge an Funktionalität hinzu, sodass Sie beginnen können, ohne einen Großteil des vorhandenen Codes zu ändern. In den folgenden Anweisungen wird beschrieben, wie Sie mithilfe des Development Kits ein neues Projekt aus einer Vorlage erstellen.

1. Öffnen Sie Visual Studio Code, und wählen Sie auf der Aktivitätsleiste das Symbol Office Add-Ins Development Kit aus.
2. Wählen Sie im Aufgabenbereich der Erweiterung die Option Neues Add-In erstellen aus.
3. Wählen Sie im jetzt aktiven Schnellauswahlmenü die Office-Anwendung für Ihr Add-In aus.
4. Wählen Sie eine Add-In-Vorlage aus der Liste der verfügbaren Vorlagen aus.
5. Wählen Sie "JavaScript" oder "TypeScript" als Programmiersprache aus.
6. Wählen Sie im daraufhin geöffneten Dialogfeld Arbeitsbereichsordner den Ordner aus, in dem Sie das Projekt erstellen möchten.
7. Geben Sie dem Projekt (ohne Leerzeichen) einen Namen, wenn Sie dazu aufgefordert werden. Das Office Add-Ins Development Kit erstellt das Projekt mit Basisdateien und Gerüsten. Anschließend wird das Projekt in einem zweiten Visual Studio Code-Fenster geöffnet. Sie können das ursprüngliche Visual Studio Code-Fenster frei schließen.

Erstellen eines Add-Ins aus einem Beispiel

Beispiele zeigen ein funktionierendes Add-In, das ein End-to-End-Szenario löst. Beispiele sind besonders nützlich als Lerntools, um zu verstehen, wie Features des Office-Add-Ins-Frameworks zusammenarbeiten. Sie können ein Beispiel auch erweitern, um Ihre speziellen Anforderungen zu erfüllen.

1. Öffnen Sie Visual Studio Code, und wählen Sie auf der Aktivitätsleiste das Symbol Office Add-Ins Development Kit aus.
2. Wählen Sie Beispiele anzeigen aus.
3. Wählen Sie das Beispiel aus, das Sie anzeigen möchten.
4. Wählen Sie die Schaltfläche Erstellen über der jetzt geöffneten Beispiel-Infodatei aus.
5. Wählen Sie im daraufhin geöffneten Dialogfeld Arbeitsbereichsordner den Ordner aus, in dem Sie das Projekt erstellen möchten. Die Erweiterung kopiert eine Version des Beispiels in diesen Ordner. Anschließend wird das Projekt in einem zweiten Visual Studio Code-Fenster geöffnet. Sie können das ursprüngliche Visual Studio Code-Fenster frei schließen.

Testen Des Add-Ins

Um zu verstehen, wie das Add-In in einer Office-Anwendung funktioniert, verwenden Sie das Office Add-Ins Development Kit, um Ihr Office-Add-In in Ihrer lokalen Entwicklungsumgebung auszuführen und zu debuggen.

Hinweis

Diese Schritte sind identisch mit den Schritten, die in Visual Studio Code von der Erweiterung beim Erstellen eines neuen Projekts aufgeführt werden.

1. Öffnen Sie die Erweiterung, indem Sie auf der Aktivitätsleiste auf das Symbol Office Add-Ins Development Kit klicken.
2. Wählen Sie Vorschau Ihres Office-Add-Ins (F5) aus.
3. Wählen Sie im Menü Schnellauswahl die Option {Office Application} Desktop (Edge Chromium) aus, wobei "{Office Application}" die entsprechende Anwendung ist, z. B. "Excel" oder "Word". Dadurch wird das Add-In gestartet und der Code gedebuggt.

Das Development Kit überprüft, ob die Voraussetzungen erfüllt sind, bevor das Debuggen gestartet wird. Überprüfen Sie das Terminal, um ausführliche Informationen zu erhalten, wenn Probleme mit Ihrer Umgebung auftreten. Nach diesem Vorgang wird das Add-In von der Office-Desktopanwendung gestartet und quer geladen. Beachten Sie, dass es bei der ersten Ausführung eines Projekts einige Minuten dauern kann, bis die Abhängigkeiten installiert sind. Sie müssen das Zertifikat installieren, wenn Sie dazu aufgefordert werden.

Beenden des Testens Ihres Office-Add-Ins

Sobald Sie das Testen und Debuggen des Add-Ins abgeschlossen haben, schließen Sie das Add-In immer , indem Sie die folgenden Schritte ausführen. (Durch das Schließen des Office-Anwendungs- oder Webserverfensters wird die Registrierung des Add-Ins nicht zuverlässig aufgehoben.)

1. Öffnen Sie die Erweiterung, indem Sie auf der Aktivitätsleiste auf das Symbol Office Add-Ins Development Kit klicken.
2. Wählen Sie Vorschau ihres Office-Add-Ins beenden aus. Dadurch wird der Webserver geschlossen und das Add-In aus der Registrierung und dem Cache entfernt.
3. Schließen Sie das Office-Anwendungsfenster.

Problembehandlung

Wenn Beim Ausführen des Add-Ins Probleme auftreten, führen Sie die folgenden Schritte aus.

• Schließen Sie alle geöffneten Instanzen von Office.
• Schließen Sie den vorherigen Webserver, der für das Add-In gestartet wurde, mit der Option Stop previewing Your Office Add-ins Office Add-ins Development Kit extension option .

Der Artikel Behandeln von Entwicklungsfehlern mit Office-Add-Ins enthält Lösungen für häufige Probleme. Wenn weiterhin Probleme auftreten, erstellen Sie ein GitHub-Problem , und wir helfen Ihnen.

Informationen zum Ausführen des Add-Ins auf Office im Web finden Sie unter Querladen von Office-Add-Ins in Office im Web.

Informationen zum Debuggen in älteren Versionen von Office finden Sie unter Debuggen von Add-Ins mithilfe von Entwicklertools in Vorgängerversion von Microsoft Edge.