Entwickeln von Office-Add-InsDevelop Office Add-ins

Tipp

Sehen Sie sich den Beitrag Übersicht der Office-Add-Ins-Plattform an, bevor Sie diesen Artikel lesen.Please review Office Add-ins platform overview before reading this article.

Alle Office-Add-Ins basieren auf der Office-Add-Ins-Plattform.All Office Add-ins are built upon the Office Add-ins platform. 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.For any add-in you build, you'll need to understand important concepts like application and platform availability, Office JavaScript API programming patterns, how to specify an add-in's settings and capabilities in the manifest file, how to design the UI and user experience, and more. Grundlegende Entwicklungskonzepte wie diese finden Sie im Abschnitt Entwicklungslebenszyklus > Entwickeln der Dokumentation.Core development concepts like these are covered here in the Development lifecycle > Develop section of the documentation. Lesen Sie die hier bereitgestellten Informationen, bevor Sie die anwendungsspezifische Dokumentation für das von Ihnen erstellte Add-In durchgehen (z. B. Excel).Review the information here before exploring the application-specific documentation that corresponds to the add-in you're building (for example, Excel).

Erstellen eines Office-Add-InsCreating an Office Add-in

Für die Erstellung von Office-Add-Ins können Sie den Yeoman-Generator für Office-Add-Ins oder Visual Studio verwenden.You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio.

Der Yeoman-Generator für Office-Add-InsYeoman generator for 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.The Yeoman generator for Office Add-ins can be used to create a Node.js Office Add-in project that can be managed with Visual Studio Code or any other editor. Der Generator kann Office-Add-Ins für folgende Optionen erstellen:The generator can create Office Add-ins for any of the following:

  • ExcelExcel
  • OneNoteOneNote
  • OutlookOutlook
  • PowerPointPowerPoint
  • ProjectProject
  • WordWord
  • Benutzerdefinierte Excel-FunktionenExcel custom functions

Sie können das Projekt mithilfe von HTML, CSS und JavaScript oder unter Verwendung von Angular oder React erstellen.You can choose to create the project using HTML, CSS and JavaScript, or using Angular or React. Unabhängig davon, für welches Framework Sie sich entscheiden, können Sie auch zwischen JavaScript und Typescript wählen.For whichever framework you choose, you can choose between JavaScript and Typescript as well. Weitere Informationen zum Erstellen von Add-Ins mit dem Yeoman-Generator finden Sie unter Entwickeln von Office-Add-Ins mit Visual Studio Code.For more information about creating add-ins with the Yeoman generator, see Develop Office Add-ins with Visual Studio Code.

Visual StudioVisual Studio

Visual Studio kann verwendet werden, um Office-Add-Ins für Excel, Outlook, Word und PowerPoint zu erstellen.Visual Studio can be used to create Office Add-ins for Excel, Outlook, Word, and PowerPoint. Ein Office-Add-In-Projekt wird als Teil einer Visual Studio-Lösung erstellt und verwendet HTML, CSS und JavaScript.An Office Add-in project gets created as part of a Visual Studio solution and uses HTML, CSS, and JavaScript. Weitere Informationen zum Erstellen von Add-Ins mit Visual Studio finden Sie unter Entwickeln von Office-Add-Ins mit Visual Studio.For more information about creating add-ins with Visual Studio, see Develop Office Add-ins with 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.Although it's possible to create Office Add-ins using Visual Studio, using the Yeoman generator provides a better developer experience in some notable ways.

  • Der Yeoman-Generator bietet mehr Möglichkeiten für Projekttypen, Frameworks und- Sprachen als Visual Studio für Office-Add-in-Projekte.The Yeoman generator provides a wider range of options for project types, frameworks, and languages than Visual Studio does for Office Add-in projects.

  • Projektvorlagen im Yeoman-Generator werden häufiger aktualisiert als Projektvorlagen in Visual Studio.Project templates in the Yeoman generator are updated more frequently than project templates in Visual Studio.

Verstehen der beiden Teile eines Office-Add-InsUnderstanding the two parts of an Office add-in

Ein Office-Add-In besteht aus zwei Teilen:An Office Add-in consists of two parts:

  • Dem Add-In-Manifest (eine XML-Datei), in dem Einstellungen und Funktionen des Add-Ins angegeben sind.The add-in manifest (an XML file) that defines the settings and capabilities of the add-in.

  • 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.The web application that defines the UI and functionality of add-in components such as task panes, content add-ins, and dialog boxes.

Die Webanwendung verwendet die Office JavaScript-API für die Interaktion mit Inhalten im Office-Dokument, in dem das Add-In ausgeführt wird.The web application uses the Office JavaScript API to interact with content in the Office document where the add-in is running. Das Add-In kann auch andere Aktionen ausführen, die normalerweise von Webanwendungen vorgenommen werden, z. B. externe Webdienste aufrufen, die Benutzerauthentifizierung erleichtern und vieles mehr.Your add-in can also do other things that web applications typically do, like call external web services, facilitate user authentication, and more.

Festlegen der Funktionen und Einstellungen eines Add-InsDefining an add-in's settings and capabilities

Im Manifest (eine XML-Datei) eines Office-Add-Ins sind die Einstellungen und Funktionen des Add-Ins angegeben.An Office Add-in's manifest (an XML file) defines the settings and capabilities of the add-in. Im Manifest geben Sie Dinge an wie:You'll configure the manifest to specify things such as:

  • Metadaten, die das Add-In beschreiben (z. B. "ID", "Version", "Beschreibung", "Anzeigename", "Standardgebietsschema").Metadata that describes the add-in (for example, ID, version, description, display name, default locale).
  • Office-Anwendungen, in denen das Add-In ausgeführt wird.Office applications where the add-in will run.
  • Berechtigungen, die das Add-In erfordert.Permissions that the add-in requires.
  • 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.How the add-in integrates with Office, including any custom UI that the add-in creates (for example, custom tabs, ribbon buttons).
  • Die Speicherorte der Bilder, die das Add-In für das Branding und Befehlssymbole verwendet.Location of images that the add-in uses for branding and command iconography.
  • Maße des Add-Ins (z. B. Maße für Inhalts-Add-Ins und erforderliche Höhe für Outlook-Add-Ins).Dimensions of the add-in (for example, dimensions for content add-ins, requested height for 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.Rules that specify when the add-in activates in the context of a message or appointment (for Outlook add-ins only).

Ausführliche Informationen zur Manifestdatei finden Sie unter XML-Manifest für Office-Add-Ins.For detailed information about the manifest, see Office Add-ins XML manifest.

Interagieren mit Inhalten in einem Office-DokumentInteracting with content in an Office document

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.An Office Add-in can use the Office JavaScript APIs to interact with content in the Office document where the add-in is running.

Zugriff auf die Office JavaScript-API-BibliothekAccessing the Office JavaScript API library

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.The Office JavaScript API library can be accessed via the Office JS content delivery network (CDN) at: https://appsforoffice.microsoft.com/lib/1/hosted/Office.js. 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.To use Office JavaScript APIs within any of your add-in's web pages, you must reference the CDN in a <script> tag in the <head> tag of the page.

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

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).For more information about accessing the Office JavaScript API library, including how to get IntelliSense, see Referencing the Office JavaScript API library from its content delivery network (CDN).

API-ModelleAPI models

Die JavaScript-API für Office umfasst zwei unterschiedliche Modelle:The Office JavaScript API includes two distinct models:

  • 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.Application-specific APIs provide strongly-typed objects that can be used to interact with objects that are native to a specific Office application. So können Sie beispielsweise die Excel-JavaScript-APIs für den Zugriff auf Arbeitsblätter, Bereiche, Tabellen, Diagramme und vieles mehr verwenden.For example, you can use the Excel JavaScript APIs to access worksheets, ranges, tables, charts, and more. Anwendungsspezifische APIs sind derzeit für die folgenden Office-Anwendungen verfügbar:application-specific APIs are currently available for the following Office applications:

    Dieses API-Modell verwendet Zusagen und ermöglicht es Ihnen, in jeder Anforderung, die Sie an die Office-Anwendung senden, mehrere Vorgänge anzugeben.This API model uses promises and allows you to specify multiple operations in each request you send to the Office application. Durch solche Batchvorgänge kann die Add-In-Leistung in Office-Anwendungen im Web erheblich verbessert werden.Batching operations in this manner can significantly improve add-in performance in Office applications on the web. Anwendungsspezifische APIs wurden mit Office 2016 eingeführt und können nicht für Interaktionen mit Office 2013 verwendet werden.Application-specific APIs were introduced with Office 2016 and cannot be used to interact with Office 2013.

    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.There is also an application-specific API for Visio, but you can use it only in SharePoint Online pages to interact with Visio diagrams that have been embedded in the page. Office-Web-Add-Ins werden in Visio nicht unterstützt.Office web add-ins are not supported in Visio.

    Weitere Informationen zu diesem API-Modell finden Sie unter Verwenden des anwendungsspezifischen API-Modells .See Using the application-specific API model to learn more about this API model .

  • Allgemeine APIs ermöglichen es Ihnen, auf Features wie z. B. Benutzeroberflächen, Dialogfelder und Clienteinstellungen zuzugreifen, die in mehreren Office-Anwendungen enthalten sind.Common APIs can be used to access features such as UI, dialogs, and client settings that are common across multiple types of Office applications. Dieses API-Modell verwendet Rückrufe, mit denen Sie in jeder an die Office-Anwendung gesendeten Anforderung nur eine Operation angeben können.This API model uses callbacks, which allow you to specify only one operation in each request sent to the Office application. Allgemeine APIs wurden mit Office 2013 eingeführt und können für Interaktionen mit Office 2013 und höher verwendet werden.Common APIs were introduced with Office 2013 and can be used to interact with Office 2013 or later. 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.For details about the Common API object model, which includes APIs for interacting with Outlook, PowerPoint, and Project, see Common JavaScript API object model.

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.Some Excel custom functions run within a unique runtime that prioritizes execution of calculations and don't have a task pane. Diese Funktionen verwenden ein etwas anderes Programmiermodell und werden als Funktionen ohne Benutzeroberfläche bezeichnet.These functions use a slightly different programming model and are called UI-less functions.

API-AnforderungssätzeAPI requirement sets

Anforderungssätze sind benannte Gruppen von API-Mitgliedern.Requirement sets are named groups of API members. 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).Requirement sets can be specific to Office applications, such as the ExcelApi 1.7 requirement set (a set of APIs that can only be used in Excel), or common to multiple applications, such as the DialogApi 1.1 requirement set (a set of APIs that can be used in any Office application that supports the Dialog API).

Ihr Office-Add-In kann API-Anforderungssätze verwenden, um festzustellen, ob die Office-Anwendung die API-Elemente unterstützt, die sie verwenden muss.Your add-in can use requirement sets to determine whether the Office application supports the API members that it needs to use. Weitere Informationen hierzu finden Sie unter Angeben von Office-Anwendungen und API-Anforderungen.For more information about this, see Specify Office applications and API requirements.

Die Anforderungssatzunterstützung variiert je nach Office-Anwendung, -Version und -Plattform.Requirement set support varies by Office application, version, and platform. 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.For detailed information about the platforms, requirement sets, and Common APIs that each Office application supports, see Office client application and platform availability for Office Add-ins.

Erkunden von APIs mithilfe von Script LabExploring APIs with 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.Script Lab is an add-in that enables you to explore the Office JavaScript API and run code snippets while you're working in an Office program such as Excel or Word. 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.It's available for free via AppSource and is a useful tool to include in your development toolkit as you prototype and verify the functionality you want in your add-in. Ü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 Script Lab, you can access a library of built-in samples to quickly try out APIs or even use a sample as the starting point for your own code.

In dem nachstehenden einminütigen Video sehen Sie Script Lab in Aktion.The following one-minute video shows Script Lab in action.

Kurzes Video, das Script Lab zeigt, das in Excel, Word und PowerPoint ausgeführt wird.Short video that shows Script Lab running in Excel, Word, and PowerPoint

Weitere Informationen zu Script Lab finden Sie unter Erkunden von Office JavaScript-APIs mithilfe von Script Lab.For more information about Script Lab, see Explore Office JavaScript APIs using Script Lab.

Erweitern der Office-BenutzeroberflächeExtending the Office UI

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.An Office Add-in can extend the Office UI by using add-in commands and HTML containers such as task panes, content add-ins, or dialog boxes.

  • 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.Add-in commands can be used to add custom tabs, buttons, and menus to the default ribbon in Office, or to extend the default context menu that appears when users right-click text in an Office document or an object in Excel. 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.When users select an add-in command, they initiate the task that the add-in command specifies, such as running JavaScript code, opening a task pane, or launching a dialog box.

  • 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.HTML containers like task panes, content add-ins, and dialog boxes can be used to display custom UI and expose additional functionality within an Office application. Die Inhalte und die Funktionalität der einzelnen Aufgabenbereiche, Inhalts-Add-Ins oder Dialogfelder werden von einer von Ihnen festgelegten Webseite abgerufen.The content and functionality of each task pane, content add-in, or dialog box derives from a web page that you specify. 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.Those web pages can use the Office JavaScript API to interact with content in the Office document where the add-in is running, and can also do other things that web pages typically do, like call external web services, facilitate user authentication, and more.

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.The following image shows an add-in command in the ribbon, a task pane to the right of the document, and a dialog box or content add-in over the document.

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.For more information about extending the Office UI and designing the add-in's UX, see Office UI elements for Office Add-ins.

Nächste SchritteNext steps

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.This article has outlined the different ways to create Office Add-ins, introduced the ways that an add-in can extend the Office UI, described the API sets, and introduced Script Lab as a valuable tool for exploring Office JavaScript APIs and prototyping add-in functionality. Nachdem Sie sich mit diesen einführenden Informationen vertraut gemacht haben, können Sie Ihr Office-Add-In-Abenteuer entlang der folgenden Optionen fortsetzen.Now that you've explored this introductory information, consider continuing your Office Add-ins journey along the following paths.

Erstellen eines Office-Add-InsCreate an Office Add-in

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.You can quickly create a basic add-in for Excel, OneNote, Outlook, PowerPoint, Project, or Word by completing a 5-minute quick start. Wenn Sie bereits einen Schnellstart abgeschlossen haben und ein etwas komplexeres Add-In erstellen möchten, sollten Sie das Lernprogramm ausprobieren.If you've previously completed a quick start and want to create a slightly more complex add-in, you should try the tutorial.

Mehr erfahrenLearn more

Weitere Informationen zum Entwickeln, Testen und Veröffentlichen von Office-Add-Ins finden Sie in dieser Dokumentation.Learn more about developing, testing, and publishing Office Add-ins by exploring this documentation.

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).For any add-in that you build, you'll use information in the Development lifecycle section of this documentation, along with information in the application-specific section that corresponds to the type of add-in you're building (for example, Excel).

Weitere InformationenSee also