Add-In-Befehle für OutlookAdd-in commands for 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.Outlook Add-in commands provide ways to initiate specific add-in actions from the ribbon by adding buttons or drop-down menus. This lets users access add-ins in a simple, intuitive, and unobtrusive way. Because they offer increased functionality in a seamless manner, you can use add-in commands to create more engaging solutions.

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.Add-in commands are available only in Outlook 2016 and Outlook 2013 for Windows, Outlook 2016 for Mac, Outlook for iPhone, Outlook for Android, Outlook on the web for Exchange 2016, and Outlook on the web for Office 365 and Outlook.com.

Für die Unterstützung von Add-In-Befehlen in Outlook 2013 müssen drei Updates installiert werden:Support for add-in commands in Outlook 2013 requires three updates:

Für die Unterstützung von Add-In-Befehlen in Exchange 2016 muss das Kumulative Update 5 installiert werden:Support for add-in commands in Exchange 2016 requires Cumulative Update 5.

Add-In-Befehle sind nur für 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.Add-in commands are only available for add-ins that do not use ItemHasAttachment, ItemHasKnownEntity, or ItemHasRegularExpressionMatch rules to limit the types of items they activate on. However, contextual add-ins can present different commands depending on whether the currently selected item is a message or appointment, and can choose to appear in read or compose scenarios. Using add-in commands if possible is a best practice.

Erstellen eines Add-In-BefehlsCreating the add-in command

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 VersionOverridesVersionOverrides unterstützt, werden vorhandene Add-Ins weiterhin funktionieren wie sie auch ohne Add-In-Befehle funktionieren würden.Add-in commands are declared in the add-in manifest in the VersionOverrides element. This element is an addition to the manifest schema v1.1 that ensures backward compatibility. In a client that doesn't support VersionOverrides, existing add-ins will continue to function as they did without add-in commands.

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.The VersionOverrides manifest entries specify many things for the add-in, such as the host, types of controls to add to the ribbon, the text, the icons, and any associated functions.

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.When an add-in needs to provide status updates, such as progress indicators or error messages, it must do so through the notification APIs. The processing for the notifications must also be defined in a separate HTML file that is specified in the FunctionFile node of the manifest.

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.Developers should define icons for all required sizes so that the add-in commands will adjust smoothly along with the ribbon. The required icon sizes are 80 x 80 pixels, 32 x 32 pixels, and 16 x 16 pixels for desktop, and 48 x 48 pixels, 32 x 32 pixels, and 25 x 25 pixels for mobile.

Wie werden die Add-In-Befehle angezeigt?How do add-in commands appear?

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.An add-in command appears on the ribbon as a button. When a user installs an add-in, its commands appear in the UI as a group of buttons labeled with the add-in name. This can either be on the ribbon's default tab or on a custom tab. For messages, the default is either the Home or Message tab. For the calendar, the default is the Meeting, Meeting Occurrence, Meeting Series, or Appointment tab. For module extensions, the default is a custom tab. On the default tab, each add-in can have one ribbon group with up to 6 commands. On custom tabs, the add-in can have up to 10 groups, each with 6 commands. Add-ins are limited to only one custom tab.

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.As the ribbon gets more crowded, the add-in commands will adjust (collapse) in an orderly way. In all cases, the add-in commands for an add-in will be grouped together.

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.When an add-in command is added to an add-in, the add-in name is removed from the app bar. Only the add-in command button on the ribbon remains.

Welche UX-Shapes sind für Add-In-Befehle vorhanden?What UX shapes exist for add-in commands?

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:The UX shape for an add-in command consists of a ribbon tab in the host application that contains buttons that can perform various functions. Currently, three UI shapes are supported:

  • Eine Schaltfläche, mit der eine JavaScript-Funktion ausgeführt wirdA button that executes a JavaScript function
  • Eine Schaltfläche, mit der ein Aufgabenbereich gestartet wirdA button that launches a task pane
  • Eine Schaltfläche, die ein Dropdownmenü mit einer oder mehrerer Schaltflächen der anderen beiden Typen anzeigtA button that shows a drop-down menu with one or more buttons of the other two types

Ausführen einer JavaScript-FunktionExecuting a JavaScript function

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.Use an add-in command button that executes a JavaScript function for scenarios where the user doesn't need to make any additional selections to initiate the action. This can be for actions such as track, remind me, or print, or scenarios when the user wants more in-depth information from a service.

In Modulerweiterungen kann die Add-In-Befehlsschaltfläche JavaScript-Funktionen ausführen, die mit dem Inhalt in der Hauptbenutzeroberfläche interagieren.In module extensions, the add-in command button can execute JavaScript functions that interact with the content in the main user interface.

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

Starten eines AufgabenbereichsLaunching a task pane

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.Use an add-in command button to launch a task pane for scenarios where a user needs to interact with an add-in for a longer period of time. For example, the add-in requires changes to settings or the completion of many fields.

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.The default width of the vertical task pane is 300 px. The vertical task pane can be resized in both the Outlook Explorer and inspector. The pane can be resized in the same way the to-do pane and list view resize.

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.This screenshot shows an example of a vertical task pane. The pane opens with the name of the add-in command in the top left corner. Users can use the X button in the upper-right corner of the pane to close the add-in when they are finished using it. By default, this pane will not persist across messages. Add-ins can support pinning for the taskpane and receive events when a new message is selected. All UI elements rendered in the task pane, aside from the add-in name and the close button, are provided by the add-in.

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.If a user chooses another add-in command that opens a task pane, the task pane is replaced with the recently used command. If a user chooses an add-in command button that executes a function, or drop-down menu while the task pane is open, the action will be completed and the task pane will remain open.

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.A drop-down menu add-in command defines a static list of buttons. The buttons within the menu can be any mix of buttons that execute a function or buttons that open a task pane. Submenus are not supported.

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

Wo werden die Add-In-Befehle auf der Benutzeroberfläche angezeigt?Where do add-in commands appear in the UI?

Add-In-Befehle werden für vier Szenarien unterstützt:Add-in commands are supported for four scenarios:

Lesen einer NachrichtReading a message

Wenn der Benutzer eine Nachricht im Lesebereich oder auf der Registerkarte Nachricht für ein Popout-Leseformular liest, werden Add-In-Befehle, die zur Standardregisterkarte hinzugefügt wurden, auf der Registerkarte Start angezeigt.When the user is reading a message in the reading pane or in the Message tab for a pop-out read form, add-in commands added to the default tab appear on the Home tab.

Verfassen einer NachrichtComposing a message

Wenn der Benutzer eine Nachricht verfasst, werden der Standardregisterkarte hinzugefügte Add-In-Befehle auf der Registerkarte Nachricht angezeigt.When the user is composing a message, add-in commands added to the default tab appear on the Message tab.

Erstellen oder Anzeigen eines Termins oder einer Besprechung als OrganisatorCreating or viewing an appointment or meeting as the organizer

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.When creating or viewing an appointment or meeting as the organizer, add-in commands added to the default tab appear on the Meeting, Meeting Occurrence, Meeting Series, or Appointment tabs on pop-out forms. However, if the user selects an item in the calendar but doesn't open the pop-out, the add-in's ribbon group won't be visible in the ribbon.

Anzeigen einer Besprechung als TeilnehmerViewing a meeting as an attendee

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.When viewing a meeting as an attendee, add-in commands added to the default tab appear on the Meeting, Meeting Occurrence, or Meeting Series tabs on pop-out forms. However, if a user selects an item in the calendar but doesn't open the pop-out, the add-in's ribbon group won't be visible in the ribbon

Verwenden einer ModulerweiterungUsing a module extension

Wenn Sie eine Modulerweiterung verwenden, werden Add-In-Befehle in der benutzerdefinierten Registerkarte der Erweiterung angezeigt.When using a module extension, add-in commands appear on the extension's custom tab.

Siehe auchSee also