Add-In-Befehle für Excel, PowerPoint und Word

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.

Hinweis

Add-In-Befehle werden von SharePoint-Katalogen nicht unterstützt. Sie können Add-In-Befehle über integrierte Apps oder AppSource bereitstellen, oder Sie können das Querladen verwenden, um Ihren Add-In-Befehl zum Testen zu verwenden.

Wichtig

Add-In-Befehle werden auch in Outlook unterstützt. Weitere Informationen finden Sie unter Add-In-Befehle für Outlook.

Abbildung 1: Add-In mit Befehlen, die in der Excel-Desktopanwendung ausgeführt werden

Screenshot mit hervorgehobenen Add-In-Befehlen im Excel-Menüband.

Abbildung 2: Add-In mit Befehlen, die in Excel im Web ausgeführt werden

Screenshot von Add-In-Befehlen in Excel im Web.

Befehlsfunktionen

Die folgenden Befehlsfunktionen werden derzeit unterstützt.

Hinweis

Add-In-Befehle werden derzeit von Inhalts-Add-Ins nicht unterstützt.

Erweiterungspunkte

  • Registerkarte des Menübands - Erstellen Sie integrierte Registerkarten, oder erstellen Sie eine neue benutzerdefinierte Registerkarte.
  • Kontextmenüs - Erweitern Sie ausgewählte Kontextmenüs.

Steuerelementtypen

  • Einfache Schaltflächen - Auslösen von bestimmten Aktionen.
  • Menüs - Einfaches Dropdownmenü mit Schaltflächen, die Aktionen auslösen.

Aktionen

  • ShowTaskpane - Zeigt einen oder mehrere Bereiche an, in denen benutzerdefinierte HTML-Seiten geladen werden.
  • 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.

Status Standard aktiviert oder deaktiviert

Sie können festlegen, ob der Befehl beim Starten des Add-Ins aktiviert oder deaktiviert werden soll, und programmgesteuert die Einstellung zu ändern.

Hinweis

Dieses Feature wird nicht in allen Office-Anwendungen oder -Szenarien unterstützt. Weitere Informationen finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen.

Position im Menüband (Vorschau)

Sie können angeben, wo eine benutzerdefinierte Registerkarte im Menüband der Office-Anwendung angezeigt wird, z. B. "rechts neben der Start-Registerkarte".

Hinweis

Dieses Feature wird nicht in allen Office-Anwendungen oder -Szenarien unterstützt. Weitere Informationen finden Sie unter Positionieren einer benutzerdefinierten Registerkarte im Menüband.

Integration von eingebauten Office-Buttons

Sie können die integrierten Office-Menübandschaltflächen in Ihre benutzerdefinierten Befehlsgruppen und benutzerdefinierten Menüband-Registerkarten einfügen.

Hinweis

Dieses Feature wird nicht in allen Office-Anwendungen oder -Szenarien unterstützt. Weitere Informationen finden Sie unter Einfügen integrierter Office-Schaltflächen in benutzerdefinierte Registerkarten.

Kontextbezogene Registerkarten

Sie können festlegen, dass eine Registerkarte nur in bestimmten Kontexten im Menüband sichtbar ist, z. B. wenn ein Diagramm in Excel ausgewählt ist.

Hinweis

Dieses Feature wird nicht in allen Office-Anwendungen oder -Szenarien unterstützt. Weitere Informationen finden Sie unter Erstellen von benutzerdefinierten kontextbezogenen Registerkarten in Office-Add-Ins.

Unterstützte Plattformen

Add-In-Befehle werden derzeit auf den folgenden Plattformen unterstützt (mit Ausnahme der in den Unterabschnitten von Befehlsfunktionen angegeben Einschränkungen).

  • Outlook unter Windows (ab Build 16.0.6769, in Verbindung mit einem Microsoft 365-Abonnement)
  • Office 2019 oder höher unter Windows
  • Outlook unter Mac (ab Build 15.33, in Verbindung mit einem Microsoft 365-Abonnement)
  • Office 2019 oder höher unter Mac
  • Office im Web

Hinweis

Informationen zur Unterstützung in Outlook finden Sie unter Add-In-Befehle für Outlook.

Debuggen

Zum Debuggen eines Add-In-Befehls müssen Sie ihn in Office im Web ausführen. Weitere Informationen finden Sie unter Debuggen von Add-Ins in Office im Web.

Bewährte Methoden

Wenden Sie beim Entwickeln von Add-In-Befehlen die folgenden bewährten Methoden an.

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

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

  • Für die Platzierung Ihrer Befehle im Office-App-Menüband:

    • 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.
    • 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).
    • Platzieren Sie die Befehle in einer benutzerdefinierten Registerkarte, wenn Sie mehr als sechs Befehle der obersten Ebene haben.
    • 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.
    • Fügen Sie keine überflüssigen Schaltflächen zu Ihrem Add-In hinzu.
    • Positionieren Sie eine benutzerdefinierte Registerkarte nicht links neben der Registerkarte „Start“, und geben Sie Ihr nicht standardmäßig den Fokus beim Öffnen eines Dokuments – es sei denn, Ihr Add-In ist die primäre Art und Weise, wie Benutzer mit dem Dokument interagieren. Wenn Sie Ihrem Add-In übermäßige Bedeutung geben, könnte dies Benutzer und Administratoren stören und verärgern.
    • Wenn Ihr Add-In die primäre Art und Weise ist, wie Benutzer mit dem Dokument interagieren, und Sie über eine benutzerdefinierte Menüband-Registerkarte verfügen, sollten Sie in Erwägung ziehen, die Schaltflächen für die Office-Funktionen, die Benutzer häufig benötigen, in die Registerkarte zu integrieren.
    • Wenn die Funktionen, die mit einer benutzerdefinierten Registerkarte bereitgestellt werden, nur in bestimmten Kontexten verfügbar sein sollen, verwenden Sie benutzerdefinierte kontextbezogene Registerkarten. Wenn Sie benutzerdefinierte kontextbezogene Registerkarten verwenden, stellen Sie sicher, dass Sie eine Fallbackumgebung für den Fall implementieren, dass Ihr Add-In auf Plattformen ausgeführt wird, die keine benutzerdefinierten kontextbezogenen Registerkarten unterstützen.

    Hinweis

    Add-Ins, die zu viel Speicherplatz belegen, bestehen möglicherweise die AppSource-Validierung nicht.

  • Befolgen Sie für alle Symbole die Entwurfsrichtlinien für Symbole.

  • Stellen Sie eine Version Ihres Add-Ins bereit, die auch in Office-Anwendungen funktioniert, die Befehle nicht unterstützen. Ein einzelnes Add-In-Manifest kann sowohl in Anwendungen funktionieren, die Befehle unterstützen, als auch in solchen, die dies nicht tun (mit Aufgabenbereichen).

    Abbildung 3: Aufgabenbereich-Add-In in Office 2013 sowie dasselbe Add-In, das Add-In-Befehle in Office 2016 verwendet

    Screenshot, der ein Aufgabenbereich-Add-In in Office 2013 und dasselbe Add-In vergleicht, das Add-In-Befehle in Office 2016 verwendet. In der Version 2013 muss der Aufgabenbereich alle Befehle enthalten, während sich Befehle in der Version 2016 im Menüband befinden können.

Nächste Schritte

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.

Weitere Informationen zum Angeben von Add-in-Befehlen im Manifest finden Sie unter Erstellen von Add-In-Befehlen im Manifest und im VersionOverrides-Referenzinhalt.