Add-In-Befehle für Outlook

Mit Outlook-Add-In-Befehlen können bestimmte Add-In-Aktionen im Menüband durch Hinzufügen von Schaltflächen oder Dropdownmenüs initiiert werden. Hierdurch können Benutzer auf eine einfache, intuitive und unaufdringliche Weise auf Add-Ins zugreifen. Da sie zusätzliche Funktionalität bieten, können Sie mithilfe von Add-In-Befehlen auf einfache Weise attraktivere Lösungen erstellen.

Hinweis: Add-In-Befehle sind nur in Outlook 2016 und Outlook 2013 für Windows, Outlook 2016 für Mac, Outlook für iPhone, Outlook für Android, Outlook im Web für Exchange 2016 und Outlook im Web für Office 365 und Outlook.com verfügbar. Für die Unterstützung von Add-In-Befehlen in Outlook 2013 müssen drei Updates installiert werden: das Sicherheitsupdate für Outlook vom 8. März 2016, das Sicherheitsupdate für Office vom 8. März 2016 (KB3114816) und das Sicherheitsupdate für Office vom 8. März 2016 (KB3114828). Für die Unterstützung von Add-In-Befehlen in Exchange 2016 muss das Kumulative Update 5 installiert werden:

Add-In-Befehle sind nur für kontextbezogene Add-Ins verfügbar, die nicht die Regeln ItemHasAttachment, ItemHasKnownEntity oder ItemHasRegularExpressionMatch verwenden, um die Typen der Elemente zu beschränken, mit denen sie aktiviert werden. Kontextbezogene Add-Ins können jedoch unterschiedliche Befehle zur Verfügung stellen, je nachdem, ob das aktuell ausgewählte Element eine Nachricht oder ein Termin ist. Außerdem können sie in Szenarien zum Lesen oder zum Verfassen angezeigt werden. Das Verwenden von Add-In-Befehlen, wann immer dies möglich ist, ist eine bewährte Methode.

Erstellen eines Add-In-Befehls

Add-In-Befehle werden im Add-In-Manifest im VersionOverrides-Element deklariert. Dieses Element ist eine Ergänzung zum Manifestschema v1.1, das Abwärtskompatibilität gewährleistet. In einer Umgebung, die keine VersionOverrides unterstützt, werden vorhandene Add-Ins weiterhin funktionieren wie sie auch ohne Add-In-Befehle funktionieren würden.

Die VersionOverrides-Manifesteinträge geben viele Aspekte des Add-In-Befehls an, z. B. den Host, die Typen von Steuerelementen, die dem Menüband hinzugefügt werden sollen, Text, Symbole und alle zugehörigen Funktionen sowie den Ort, an dem der Add-In-Befehl angezeigt wird.

Wenn ein Add-In Fortschrittsaktualisierungen bereitstellen muss, z. B. Fortschrittsanzeigen oder Fehlermeldungen, muss dies über die Benachrichtigungs-APIs. Die Verarbeitung für Benachrichtigungen muss auch in einer separaten HTML-Datei definiert werden, die im FunctionFile-Knoten des Manifests angegeben ist.

Entwickler sollten Symbole für alle erforderlichen Größen definieren, damit die Add-In-Befehle auf dem Menüband problemlos angepasst werden können. Die erforderlichen Symbolgrößen sind 80 x 80 Pixel, 32 x 32 Pixel und 16 x 16 Pixel für Desktop und 48 x 48 Pixel, 32 x 32 Pixel und 25 x 25 Pixel für Mobilgeräte.

Wie werden die Add-In-Befehle angezeigt?

Ein Add-In-Befehl wird als Schaltfläche im Menüband angezeigt. Wenn ein Benutzer ein Add-In installiert, werden seine Befehle auf der Benutzeroberfläche als eine Gruppe von Schaltflächen angezeigt, die mit dem Add-In-Namen gekennzeichnet ist. Dies kann entweder die Standardregisterkarte oder eine benutzerdefinierte Registerkarte im Menüband sein. Für Nachrichten ist die Standardeinstellung entweder die Registerkarte Start oder Nachricht. Für Kalender ist die Standardeinstellung die Registerkarte Besprechung, Besprechungsereignis, Besprechungsreihe oder Termin. Für Modulerweiterungen ist die Standardeinstellung eine benutzerdefinierte Registerkarte. Auf der Standardregisterkarte kann jedes Add-In eine Menübandgruppe mit bis zu sechs Befehlen enthalten. Auf benutzerdefinierten Registerkarten kann das Add-In bis zu zehn Gruppen aufweisen, von denen jede sechs Befehle aufweist. Add-Ins sind auf auf benutzerdefinierte Registerkarte beschränkt.

Wird das Menüband voller, passen sich die Add-In-Befehle an (ausblenden). Die Add-In-Befehle eines Add-Ins werden immer zu einer Gruppe zusammengefasst.

Screenshots, die Add-In-Befehlsschaltflächen in einem normalen und einem reduzierten Status anzeigen

Wenn Sie einen Add-In-Befehl zu einem Add-In hinzufügen, wird der Add-In-Name aus der App-Leiste entfernt. Es wird nur noch die Schaltfläche für den Add-In-Befehl im Menüband angezeigt.

Welche UX-Shapes sind für Add-In-Befehle vorhanden?

Das UX-Shape für ein Add-In-Befehl besteht aus einer Registerkarte des Menübands in der Hostanwendung, die die Schaltflächen enthält, mit denen verschiedene Funktionen ausgeführt werden können. Derzeit werden drei Benutzeroberflächenformen unterstützt:

  • Eine Schaltfläche, mit der eine JavaScript-Funktion ausgeführt wird

  • Eine Schaltfläche, die ein Dropdownmenü mit einer oder mehrerer Schaltflächen der anderen beiden Typen anzeigt

  • Eine Schaltfläche, mit der ein Aufgabenbereich gestartet wird

Ausführen einer JavaScript-Funktion

Verwenden Sie eine Add-In-Befehlsschaltfläche, mit der eine JavaScript-Funktion ausgeführt wird, für Szenarien, in denen Benutzer zur Initiierung keine zusätzliche Auswahl treffen müssen. Dies gilt z. B. für Aktionen wie Nachverfolgen, Erinnern oder Drucken oder wenn der Benutzer ausführliche Aktionen zu einem Dienst möchte.

In Modulerweiterungen kann die Add-In-Befehlsschaltfläche JavaScript-Funktionen ausführen, die mit dem Inhalt in der Hauptbenutzeroberfläche interagieren.

Eine Schaltfläche, die eine Funktion im Outlook-Menüband ausführt

Starten eines Aufgabenbereichs

Verwenden Sie eine Add-In-Befehlsschaltfläche zum Starten eines Aufgabenbereichs für Szenarien, in denen ein Benutzer mit einem Add-In über einen längeren Zeitraum interagieren muss. Beispiel: Für das Add-In sind Änderungen an Einstellungen oder das Ausfüllen vieler Felder erforderlich.

Die Standardbreite des vertikalen Aufgabenbereichs beträgt 300 px. Die Größe des vertikalen Aufgabenbereichs kann im Outlook Explorer und Inspektor geändert werden. Der Bereich kann auf dieselbe Weise die Größe von Aufgabenbereich und Listenansicht ändern.

Eine Schaltfläche, die einen Aufgabenbereich im Outlook-Menüband öffnet

Dieser Screenshot zeigt ein Beispiel eines vertikalen Aufgabenbereichs. Der Bereich wird mit dem Namen des Add-In-Befehls in der Ecke links oben geöffnet. Benutzer können mithilfe der X -Schaltfläche in der oberen rechten Ecke des Bereichs das Add-In schließen, wenn sie es nicht mehr verwenden. Standardmäßig werden Nachrichten in diesem Bereich nicht beibehalten. Add-Ins können das Anheften für den Aufgabenbereich unterstützen und Ereignisse empfangen, wenn eine neue Nachricht ausgewählt wird. Alle Elemente der Benutzeroberfläche, die im Aufgabenbereich gerendert werden, werden, mit Ausnahme des Add-In-Namens und der Schaltfläche zum Schließen, vom Add-In bereitgestellt.

Wenn ein Benutzer einen anderen Add-In-Befehl auswählt, mit dem ein Aufgabenbereich geöffnet wird, wird der Aufgabenbereich durch den Befehl ersetzt, der zuletzt verwendet wurde. Wenn ein Benutzer eine Add-In-Befehlsschaltfläche, mit der eine Funktion ausgeführt wird, oder ein Dropdownmenü wählt, wenn der Aufgabenbereich geöffnet ist, wird die Aktion fertig gestellt und der Aufgabenbereich bleibt geöffnet.

Ein Add-In-Befehl für ein Dropdownmenü definiert eine statische Liste von Schaltflächen. Die Schaltflächen in dem Menü können eine Kombination von Schaltflächen sein, die eine Funktion ausführen, oder Schaltflächen, die einen Aufgabenbereich öffnen. Untermenüs werden nicht unterstützt.

Eine Schaltfläche, die ein Dropdownmenü im Outlook-Menüband ausführt

Wo werden die Add-In-Befehle auf der Benutzeroberfläche angezeigt?

Add-In-Befehle werden für vier Szenarien unterstützt:

Lesen einer Nachricht

Wenn der Benutzer eine Nachricht liest, werden Add-In-Befehle, die zur Standardregisterkarte hinzugefügt werden, auf der Registerkarte Start angezeigt, wenn die Nachricht im Lesebereich angezeigt wird, und auf der Registerkarte Nachricht für ein Popout-Leseformular.

Verfassen einer Nachricht

Wenn der Benutzer eine Nachricht verfasst, werden der Standardregisterkarte hinzugefügte Add-In-Befehle auf der Registerkarte Nachricht angezeigt.

Erstellen oder Anzeigen eines Termins oder einer Besprechung als Organisator

Beim Erstellen oder Anzeigen eines Termins oder einer Besprechung als Organisator, werden der Standardregisterkarte hinzugefügte Add-In-Befehle auf den Registerkarten Besprechung, Besprechungsserienelement, Besprechungsserie oder Termine auf Popoutformularen angezeigt. Wenn der Benutzer jedoch ein Element im Kalender auswählt, das Popout aber nicht öffnet, wird die Menübandgruppe des Add-Ins nicht im Menüband angezeigt.

Anzeigen einer Besprechung als Teilnehmer

Beim Anzeigen einer Besprechung als Teilnehmer werden der Standardregisterkarte hinzugefügte Add-In-Befehle auf den Registerkarten Besprechung, Besprechungsserienelement, Besprechungsserie auf Popoutformularen angezeigt. Wenn der Benutzer jedoch ein Element im Kalender auswählt, das Popout aber nicht öffnet, wird die Menübandgruppe des Add-Ins nicht im Menüband angezeigt.

Verwenden einer Modulerweiterung

Wenn Sie eine Modulerweiterung verwenden, werden Add-In-Befehle in der benutzerdefinierten Registerkarte der Erweiterung angezeigt.

Zusätzliche Ressourcen