Implémenter un volet Office épinglable dans Outlook

La forme d’expérience utilisateur du volet Office pour les commandes de complément ouvre un volet office 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 être affiché dans le volet de lecture lors de l’affichage d’une liste de messages, ce qui permet un traitement rapide d’un message.

Toutefois, par défaut, si un utilisateur dispose d’un volet Office de complément 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 épinglés, votre complément peut donner cette option à l’utilisateur.

Modes Outlook pris en charge

Les volets Office épinglés 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 différents modes. Cela est dû au fait qu’un complément peut avoir des interfaces utilisateur différentes 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 nouveau message, il ne voit 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 compose. Si l’utilisateur épingle ensuite le volet Office, celui-ci reste épinglé la prochaine fois que l’utilisateur compose 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",
        "displayName": "OpenTaskPane",
        "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>

Pour obtenir un exemple complet, consultez le contrôle msgReadOpenPaneButton dans l’exemple de manifeste command-demo.

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. Cette opération doit être effectuée 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 en sélection multiple

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, lorsque le volet Office d’un complément qui implémente la fonctionnalité de sélection multiple d’élément est ouvert, il est automatiquement épinglé au client Outlook. Il reste épinglé même lorsqu’un utilisateur bascule vers un autre élément de courrier ou sélectionne l’icône d’épingle dans le volet Office. Le volet Office ne peut être fermé qu’en sélectionnant le bouton Fermer dans le volet Office.

À l’inverse, dans outlook classique sur Windows et Outlook sur Mac, le volet Office d’un complément à sélection multiple n’est pas automatiquement épinglé et se ferme lorsqu’un utilisateur bascule vers un autre élément de courrier.

Déployer sur les utilisateurs

Si vous envisagez de publier votre complément Outlook sur AppSource et qu’il est configuré avec un volet Office épinglé, 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 réussira la validation AppSource.

Voir aussi

Pour un exemple de complément qui implémente un volet Office épinglables, consultez command-demo sur GitHub.