Implementieren eines anheftbaren Aufgabenbereichs in Outlook

Die UX-Form für Add-In-Befehle im Aufgabenbereich öffnet einen vertikalen Aufgabenbereich rechts neben einer geöffneten Nachricht oder Besprechungsanfrage. Dadurch kann ein Add-In die Benutzeroberfläche für detailliertere Interaktionen bereitstellen, z. B. das Ausfüllen mehrerer Textfelder. Dieser Aufgabenbereich kann beim Anzeigen einer Nachrichtenliste im Lesebereich angezeigt werden, um eine schnelle Verarbeitung einer Nachricht zu ermöglichen.

Wenn ein Benutzer jedoch standardmäßig einen Add-In-Aufgabenbereich für eine Nachricht im Lesebereich geöffnet hat und dann eine neue Nachricht auswählt, wird der Aufgabenbereich automatisch geschlossen. Bei einem häufig verwendeten Add-In möchte der Benutzer diesen Bereich möglicherweise geöffnet lassen, sodass das Add-In nicht bei jeder Nachricht erneut aktiviert werden muss. Mit angeheftbaren Aufgabenbereichen kann Ihr Add-In dem Benutzer diese Option bieten.

Unterstützte Outlook-Modi

Heftbare Aufgabenbereiche werden in Outlook sowohl im Nachrichten Compose als auch im Nachrichtenlesemodus unterstützt. Das Anheften wird jedoch in den verschiedenen Modi nicht unterstützt. Dies liegt daran, dass ein Add-In in jedem Modus unterschiedliche Benutzeroberflächen für Schaltflächen und Aufgabenbereiche aufweisen kann. Wenn ein Benutzer beispielsweise beim Lesen einer Nachricht den Aufgabenbereich eines Add-Ins anheftet und dann eine neue Nachricht erstellt, wird der Aufgabenbereich des Add-Ins aus der von ihm verfassten Nachricht nicht angezeigt. Um den Aufgabenbereich anzuzeigen, muss der Benutzer das Add-In über die Nachricht aktivieren, die er gerade verfasst. Wenn der Benutzer dann den Aufgabenbereich anheftet, bleibt der Aufgabenbereich angeheftet, wenn der Benutzer das nächste Mal eine weitere Nachricht verfasst.

Unterstützen des Anheftens des Aufgabenbereichs

Der erste Schritt besteht darin, die Unterstützung zum Anheften hinzuzufügen, was über das Add-In-Manifest erfolgt. Das Markup variiert je nach Typ des Manifests, das Ihr Add-In verwendet.

"actions": [
    {
        "id": "OpenTaskPane",
        "type": "openPage",
        "view": "TaskPaneView",
        "pinnable": true
    }
]

<!-- Task pane button. -->
<Control xsi:type="Button" id="msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
    <SupportsPinning>true</SupportsPinning>
  </Action>
</Control>

Umgang mit Updates der Benutzeroberfläche basierend auf der aktuell ausgewählten Nachricht

Um die Benutzeroberfläche Ihres Aufgabenbereichs oder interne Variablen basierend auf dem aktuellen Element zu aktualisieren, müssen Sie einen Ereignishandler registrieren, um bezüglich der Änderung benachrichtigt zu werden.

Implementieren des Ereignishandlers

Der Ereignishandler sollte einen einzelnen Parameter akzeptieren, der ein Objektliteral ist. Die type-Eigenschaft dieses Objekts wird durch Office.EventType.ItemChanged festgelegt. Wenn das Ereignis aufgerufen wird, ist das Office.context.mailbox.item-Objekt bereits so aktualisiert, dass das derzeit ausgewählte Element widergespiegelt wird.

function itemChanged(eventArgs) {
  // Update UI based on the new current item.
  updateTaskPaneUI(Office.context.mailbox.item);
}

// Example implementation.
function updateTaskPaneUI(item) {
  // Assuming that item is always a read item (instead of a compose item).
  if (item != null) console.log(item.subject);
}

Registrieren des Ereignishandlers

Verwenden Sie die Office.context.mailbox.addHandlerAsync-Methode, um Ihren Ereignishandler für das Office.EventType.ItemChanged-Ereignis zu registrieren. Dies sollte in der Office.onReady Funktion Ihres Aufgabenbereichs erfolgen.

Office.onReady(() => {
  $(document).ready(() => {
    // Set up the ItemChanged event.
    Office.context.mailbox.addHandlerAsync(Office.EventType.ItemChanged, itemChanged);
    updateTaskPaneUI(Office.context.mailbox.item);
  });
});

Anheften im Aufgabenbereich in Mehrfachauswahl

Wenn Sie mehrere E-Mail-Elemente auswählen und den Aufgabenbereich des Mehrfachauswahl-Add-Ins starten, variiert das Anheftverhalten des Aufgabenbereichs je nach Outlook-Client.

• Mac: Der Aufgabenbereich bleibt auch dann geöffnet, wenn ein Benutzer zu einem anderen E-Mail-Element wechselt. Der Aufgabenbereich kann nur geschlossen werden, indem Sie im Aufgabenbereich die Schaltfläche Schließen auswählen.
• Windows (neu und klassisch) und Web: Der Aufgabenbereich bleibt nicht geöffnet, wenn der Benutzer zu einem neuen Element wechselt. Um den Aufgabenbereich geöffnet zu lassen, wählen Sie das Stecknadelsymbol im Aufgabenbereich aus.

Für Benutzer bereitstellen

Wenn Sie beabsichtigen, Ihr Outlook-Add-In im Microsoft Marketplace zu veröffentlichen, und es mit einem anheftbaren Aufgabenbereich konfiguriert ist, darf der angeheftete Inhalt des Add-Ins nicht statisch sein. Das heißt, der angeheftete Inhalt muss sich je nach der aktuell geöffneten oder im Postfach ausgewählten Nachricht oder dem Termin ändern. Dadurch wird sichergestellt, dass Ihr Add-In die Microsoft Marketplace-Überprüfung besteht.

Siehe auch

• Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten
• Aktivieren Ihres Outlook-Add-Ins, ohne dass der Lesebereich aktiviert oder eine Nachricht ausgewählt ist