Implémenter un volet Office épinglable dans Outlook

La forme Expérience utilisateur du volet des tâches pour les commandes de complément ouvre un volet des tâches vertical à droite d’un message ouvert ou d’une demande de réunion. Cela permet à un complément de fournir une interface utilisateur pour des interactions plus détaillées, telles que le remplissage de plusieurs champs de texte. Ce volet Office peut s’afficher dans le volet de lecture lors de l’affichage d’une liste de messages, ce qui permet de traiter rapidement un message.

Toutefois, par défaut, si un volet Office complémentaire est ouvert pour un message dans le volet de lecture, puis sélectionne un nouveau message, le volet Office est automatiquement fermé. Pour un complément très sollicité, l’utilisateur peut préférer conserver ce volet ouvert, supprimant ainsi le besoin de réactiver le complément sur chaque message. Avec les volets Office épinglables, votre complément peut offrir cette option à l’utilisateur.

Modes Outlook pris en charge

Les volets Office épinglables sont pris en charge dans les modes Message Compose et Lecture de message dans Outlook. Toutefois, l’épinglage n’est pas pris en charge dans les différents modes. En effet, un complément peut avoir différentes interfaces utilisateur pour les boutons et les volets Office dans chaque mode. Par exemple, si un utilisateur épingle le volet Office d’un complément lors de la lecture d’un message, puis crée un message, il ne verra pas le volet Office du complément à partir du message qu’il compose. Pour afficher le volet Office, l’utilisateur doit activer le complément à partir du message qu’il rédige. Si l’utilisateur épingle ensuite le volet Office, le volet Office reste épinglé la prochaine fois que l’utilisateur rédige un autre message.

Prise en charge de l’épinglage des volets des tâches

La première étape consiste à ajouter une prise en charge de l’épinglage, ce qui est effectué dans le manifeste du complément. Le balisage varie en fonction du type de manifeste utilisé par votre complément.

"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>

Gestion des mises à jour de l’interface utilisateur en fonction du message actuellement sélectionné

Pour mettre à jour l’interface utilisateur ou les variables internes de votre volet Office en fonction de l’élément actif, vous devez enregistrer un gestionnaire d’événements pour être notifié de la modification.

Mettre en œuvre le gestionnaire d’événements

Le gestionnaire d’événements doit accepter un seul paramètre, qui est un littéral d’objet. La propriété type de cet objet est réglée sur Office.EventType.ItemChanged. Lorsque l’événement est appelé, l’objet Office.context.mailbox.item est déjà mis à jour pour refléter l’élément actuellement sélectionné.

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);
}

Enregistrement du gestionnaire d’événements

Utilisez la méthode Office.context.mailbox.addHandlerAsync pour inscrire votre gestionnaire d’événements pour l’événement Office.EventType.ItemChanged. Cela doit être fait dans la Office.onReady fonction de votre volet Office.

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

Épinglage du volet Office dans la sélection multiple

Lorsque vous sélectionnez plusieurs éléments de courrier et lancez le volet Office du complément à sélection multiple, le comportement d’épinglage du volet Office varie en fonction du client Outlook.

• Mac : le volet Office reste ouvert même lorsqu’un utilisateur passe à un autre élément de courrier. Le volet Office ne peut être fermé qu’en sélectionnant le bouton Fermer dans le volet Office.
• Windows (nouveau et classique) et web : le volet Office ne reste pas ouvert lorsque l’utilisateur passe à un nouvel élément. Pour garder le volet Office ouvert, sélectionnez l’icône d’épingle sur le volet Office.

Déployer vers les utilisateurs

Si vous envisagez de publier votre complément Outlook sur la Place de marché Microsoft et qu’il est configuré avec un volet Office épinglable, le contenu épinglé du complément ne doit pas être statique. Autrement dit, le contenu épinglé doit changer en fonction du message ou du rendez-vous actuellement ouvert ou sélectionné dans la boîte aux lettres. Cela garantit que votre complément passera la validation de la Place de marché Microsoft.

Voir aussi

• Activer votre complément Outlook sur plusieurs messages
• Activez votre complément Outlook sans activer le volet de lecture ou sélectionner un message