Add-In-Befehle für Excel, Word und PowerPointAdd-in commands for Excel, Word, and PowerPoint

Add-In-Befehle sind Elemente der Benutzeroberfläche, die die Office-Benutzeroberfläche erweitern und Aktionen in Ihrem Add-In starten. Sie können Add-In-Befehle verwenden, um eine Schaltfläche zum Menüband oder ein Element zu einem Kontextmenü hinzuzufügen. Wenn Benutzer einen Add-In-Befehl auswählen, starten sie Aktionen wie z. B. die Ausführung von JavaScript-Code oder die Anzeige einer Seite des Add-Ins in einem Aufgabenbereich. Add-In-Befehle helfen Benutzer dabei, Ihr Add-In zu finden und zu verwenden; dies kann die Annahme und Wiederverwendung Ihres Add-Ins verbessern und die Kundenbindung stärken.Add-in commands are UI elements that extend the Office UI and start actions in your add-in. You can use add-in commands to add a button on the ribbon or an item to a context menu. When users select an add-in command, they initiate actions such as running JavaScript code, or showing a page of the add-in in a task pane. Add-in commands help users find and use your add-in, which can help increase your add-in's adoption and reuse, and improve customer retention.

Eine Übersicht über das Feature finden Sie im Video Add-In-Befehle im Office-Menüband.For an overview of the feature, see the video Add-in Commands in the Office Ribbon.

Hinweis

Add-In-Befehle werden von SharePoint-Katalogen nicht unterstützt. Sie können Add-In-Befehle über eine zentralisierte Bereitstellung oder AppSource bereitstellen, oder Sie können das Querladen verwenden, um Ihren Add-In-Befehl zum Testen zu verwenden.SharePoint catalogs do not support add-in commands. You can deploy add-in commands via Centralized Deployment or AppSource, or use sideloading to deploy your add-in command for testing.

Abbildung 1: Add-In mit Befehlen, die in der Excel-Desktopanwendung ausgeführt werdenFigure 1. Add-in with commands running in Excel Desktop

Screenshot eines Add-In-Befehls in Excel

Abbildung 2: Add-In mit Befehlen, die in Excel im Web ausgeführt werdenFigure 2. Add-in with commands running in Excel Online

Screenshot eines Add-In-Befehls in Excel im Web

BefehlsfunktionenCommand capabilities

Die folgenden Befehlsfunktionen werden derzeit unterstützt.The following command capabilities are currently supported.

Hinweis

Add-In-Befehle werden derzeit von Inhalts-Add-Ins nicht unterstützt.Content add-ins do not currently support add-in commands.

ErweiterungspunkteExtension points

  • Registerkarte des Menübands - Erstellen Sie integrierte Registerkarten, oder erstellen Sie eine neue benutzerdefinierte Registerkarte.Ribbon tabs - Extend built-in tabs or create a new custom tab.
  • Kontextmenüs - Erweitern Sie ausgewählte Kontextmenüs.Context menus - Extend selected context menus.

SteuerelementtypenControl types

  • Einfache Schaltflächen - Auslösen von bestimmten Aktionen.Simple buttons - trigger specific actions.
  • Menüs - Einfaches Dropdownmenü mit Schaltflächen, die Aktionen auslösen.Menus - simple menu dropdown with buttons that trigger actions.

AktionenActions

  • ShowTaskpane - Zeigt einen oder mehrere Bereiche an, in denen benutzerdefinierte HTML-Seiten geladen werden.ShowTaskpane - Displays one or multiple panes that load custom HTML pages inside them.
  • ExecuteFunction – Lädt eine nicht sichtbare HTML-Seite und führt dann eine JavaScript-Funktion darin aus. Sie können die displayDialog-API verwenden, um innerhalb Ihrer Funktion eine Benutzeroberfläche (z. B. Fehler, den Fortschritt, zusätzliche Eingaben) anzuzeigen.ExecuteFunction - Loads an invisible HTML page and then execute a JavaScript function within it. To show UI within your function (such as errors, progress, or additional input) you can use the displayDialog API.

Unterstützte PlattformenSupported platforms

Add-In-Befehle werden derzeit auf den folgenden Plattformen unterstützt:Add-in commands are currently supported on the following platforms:

  • Outlook 2016 unter Windows (Ab Build 16.0.4678.1000)Outlook 2016 on Windows (build 16.0.4678.1000+)
  • Outlook unter Windows (ab Build 16.0.6769, in Verbindung mit einem Office 365-Abonnement)Office on Windows (build 16.0.6769+, connected to Office 365 subscription)
  • Office 2019 unter WindowsOffice 2019 on Windows
  • Office auf einem Mac (ab Build 15.33, in Verbindung mit einem Office 365-Abonnement)Office on Mac (build 15.33+, connected to Office 365 subscription)
  • Office 2019 auf dem MacOffice 2019 for Mac
  • Office im WebOffice on the web

Unterstützung für weitere Plattformen wird in Kürze implementiert.More platforms are coming soon.

DebuggenDebugging

Zum Debuggen eines Add-In-Befehls müssen Sie ihn in Office im Web ausführen.To debug an Add-in Command, you must run it in Office Online. Weitere Informationen finden Sie unter Debuggen von Add-Ins in Office im Web.For details, see Debug add-ins in Office on the web.

Bewährte MethodenBest practices

Wenden Sie beim Entwickeln von Add-In-Befehlen die folgenden bewährten Methoden an:Apply the following best practices when you develop add-in commands:

  • Verwenden Sie Befehle, die eine bestimmte Aktion mit einem klaren Ergebnis für den Benutzer darstellen. Mehrere Aktionen in einer einzelnen Schaltfläche sollten nicht kombiniert werden.Use commands to represent a specific action with a clear and specific outcome for users. Do not combine multiple actions in a single button.

  • Stellen Sie präzise Aktionen bereit, mit denen allgemeine Aufgaben im Add-In effizienter durchzuführen sind. Minimieren Sie die Anzahl der Schritte, die notwendig sind, um eine Aktion auszuführen.Provide granular actions that make common tasks within your add-in more efficient to perform. Minimize the number of steps an action takes to complete.

  • Für die Platzierung Ihrer Befehle im Office-Menüband:For the placement of your commands in the Office ribbon:

    • Platzieren Sie Befehle in bestehende Registerkarten (Einfügen, Überprüfung usw.), wenn die angebotene Funktion dazu passt. Wenn das Add-In Benutzern bspw. das Einfügen von Medien ermöglicht, fügen Sie eine Gruppe zur Registerkarte „Einfügen“ hinzu. Beachten Sie, dass nicht alle Registerkarten in allen Office-Versionen zur Verfügung stehen. Weitere Informationen finden Sie unter XML-Manifest für Office-Add-Ins.Place commands on an existing tab (Insert, Review, and so on) if the functionality provided fits there. For example, if your add-in enables users to insert media, add a group to the Insert tab. Note that not all tabs are available across all Office versions. For more information, see Office Add-ins XML manifest.
    • Platzieren Sie Befehle in die Registerkarte „Start“, wenn die Funktion nicht zu einer anderen Registerkarte passt und Sie weniger als sechs Befehle der obersten Ebene haben. Sie können Befehle auch zur Registerkarte „Start“ hinzufügen, wenn Ihr Add-In in verschiedenen Office-Versionen (z. B. Office im Web oder für Desktop) funktionieren muss und eine bestimmte Registerkarte nicht in allen Versionen zur Verfügung steht (z. B. ist die Registerkarte „Entwurf“ nicht in Office im Web vorhanden).Place commands on the Home tab if the functionality doesn't fit on another tab, and you have fewer than six top-level commands. You can also add commands to the Home tab if your add-in needs to work across Office versions (such as Office Desktop and Office Online) and a tab is not available in all versions (for example, the Design tab doesn't exist in Office Online).
    • Platzieren Sie die Befehle in einer benutzerdefinierten Registerkarte, wenn Sie mehr als sechs Befehle der obersten Ebene haben.Place commands on a custom tab if you have more than six top-level commands.
    • Benennen Sie Ihre Gruppe so, dass sie dem Namen Ihres Add-Ins entspricht. Wenn Sie über mehrere Gruppen verfügen, benennen Sie jede Gruppe basierend auf der Funktion, die die Befehle in dieser Gruppe bieten.Name your group to match the name of your add-in. If you have multiple groups, name each group based on the functionality that the commands in that group provide.
    • Fügen Sie keine überflüssigen Schaltflächen zu Ihrem Add-In hinzu.Do not add superfluous buttons to increase the real estate of your add-in.

    Hinweis

    Add-Ins, die zu viel Speicherplatz belegen, bestehen möglicherweise die AppSource-Validierung nicht.Add-ins that take up too much space might not pass AppSource validation.

  • Befolgen Sie für alle Symbole die Entwurfsrichtlinien für Symbole.For all icons, follow the icon design guidelines.

  • Bieten Sie auch eine Version Ihres Add-Ins an, die auch auf Hosts funktioniert, die Befehle nicht unterstützen.Provide a version of your add-in that also works on hosts that do not support commands. Ein einzelnes Add-In-Manifest kann sowohl in Hosts funktionieren, die Befehle unterstützen, als auch in solchen, die dies nicht tun (mit Aufgabenbereichen).A single add-in manifest can work in both command-aware (with commands) and non-command-aware (as a task pane) hosts.

    Abbildung 3: Aufgabenbereich-Add-In in Office 2013 sowie dasselbe Add-In, das Add-In-Befehle in Office 2016 verwendetFigure 3. Task pane add-in in Office 2013 and the same add-in using add-in commands in Office 2016

    Ein Screenshot, der ein Aufgabenbereich-Add-In in Office 2013 sowie dasselbe Add-In zeigt, das Add-In-Befehle in Office 2016 verwendet

Nächste SchritteNext steps

Die beste Möglichkeit für den Einstieg in die Verwendung von Add-In-Befehlen ist die Erkundung der Office-Add-In-Befehle auf GitHub.The best way to get started using add-in commands is to take a look at the Office Add-in commands samples on GitHub.

Weitere Informationen zum Angeben von Add-in-Befehlen im Manifest finden Sie unter Erstellen von Add-In-Befehlen im Manifest und im VersionOverrides-Referenzinhalt.For more information about specifying add-in commands in your manifest, see Create add-in commands in your manifest and the VersionOverrides reference content.