Implementar un panel de tareas anclable en Outlook

La forma UX del panel de tareas para comandos de complemento abre un panel de tareas vertical a la derecha de un mensaje abierto o de una convocatoria de reunión. Esto permite que un complemento proporcione interfaz de usuario para interacciones más detalladas, como rellenar varios campos de texto. Este panel de tareas se puede mostrar en el Panel de lectura al ver una lista de mensajes, lo que permite un procesamiento rápido de un mensaje.

Sin embargo, de forma predeterminada, si un usuario tiene abierto un panel de tareas de complemento para un mensaje en el panel de lectura y, a continuación, selecciona un mensaje nuevo, el panel de tareas se cierra automáticamente. Es posible que, en el caso de un complemento que se use mucho, el usuario prefiera mantener el panel abierto para eliminar la necesidad de volver a activar el complemento en cada mensaje. Con los paneles de tareas anclables, el complemento puede ofrecer al usuario esa opción.

Modos de Outlook admitidos

Los paneles de tareas anclables son compatibles tanto en el modo de Compose de mensajes como en el de Lectura de mensajes en Outlook. Sin embargo, el anclaje no se admite en distintos modos. Esto se debe a que un complemento podría tener diferentes interfaces de usuario para los botones y los paneles de tareas en cada modo. Por ejemplo, si un usuario ancla el panel de tareas de un complemento mientras lee un mensaje y luego crea un mensaje nuevo, no verá el panel de tareas del complemento desde el mensaje que está redactando. Para ver el panel de tareas, el usuario debe activar el complemento desde el mensaje que está redactando. Si el usuario ancla el panel de tareas, este permanecerá anclado la próxima vez que el usuario redacte otro mensaje.

Admitir el anclado de paneles de tareas

El primer paso es agregar la compatibilidad con el anclado (debe realizarse en el manifiesto del complemento). El marcado varía en función del tipo de manifiesto que use el complemento.

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

Control de las actualizaciones de la interfaz de usuario en función del mensaje seleccionado en ese momento

Para actualizar la interfaz de usuario o las variables internas de su panel de tareas en función del elemento actual, deberá registrar un controlador de eventos para que se le notifique el cambio.

Implementar el controlador de eventos

El controlador de eventos debe aceptar un único parámetro, que es un literal de objeto. La propiedad type de este objeto se establecerá en Office.EventType.ItemChanged. Cuando se llama al evento, el objeto Office.context.mailbox.item ya se ha actualizado para reflejar el elemento que hay seleccionado actualmente.

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

Registrar el controlador de eventos

Use el método Office.context.mailbox.addHandlerAsync para registrar el controlador de eventos del evento Office.EventType.ItemChanged. Esto debe hacerse en la función de su Office.onReady panel de tareas.

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

Anclaje del panel de tareas en selección múltiple

Al seleccionar varios elementos de correo e iniciar el panel de tareas del complemento de selección múltiple, el comportamiento de anclaje del panel de tareas varía en función del cliente de Outlook.

• Mac: el panel de tareas permanece abierto incluso cuando un usuario cambia a un elemento de correo diferente. Solo se puede cerrar el panel de tareas seleccionando el botón Cerrar en el panel de tareas.
• Windows (nuevo y clásico) y web: el panel de tareas no permanece abierto cuando el usuario cambia a un nuevo elemento. Para mantener abierto el panel de tareas, seleccione el icono de chincheta en el panel de tareas.

Implementar en usuarios

Si tiene previsto publicar el complemento de Outlook en Microsoft Marketplace y este está configurado con un panel de tareas anclable, el contenido anclado del complemento no debe ser estático. Es decir, el contenido anclado debe cambiar en función del mensaje o la cita que esté abierta o seleccionada en el buzón. Esto garantiza que el complemento pasará la validación de Microsoft Marketplace.

Vea también

• Activar el complemento de Outlook en varios mensajes
• Active el complemento de Outlook sin el panel de lectura habilitado o sin seleccionar un mensaje