Compartir a través de


Office.EventType enum

Especifica el tipo de evento que se ha generado. Devuelto por la type propiedad de un *EventArgs objeto .

Los complementos de Project admiten los Office.EventType.ResourceSelectionChangedtipos de eventos , Office.EventType.TaskSelectionChangedy Office.EventType.ViewSelectionChanged .

Solo los complementos de panel de tareas para Outlook admiten tipos de eventos de conjuntos de API de buzón.

Comentarios

Ejemplos

// This sample shows how to register an event handler in Outlook.
Office.onReady(() => {
    // Registers an event handler to identify when messages are selected.
    Office.context.mailbox.addHandlerAsync(Office.EventType.SelectedItemsChanged, getMessageProperties, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        console.log("Event handler added for the SelectedItemsChanged event.");
    });
});

function getMessageProperties() {
    // Retrieves the selected messages' properties and logs them to the console.
    Office.context.mailbox.getSelectedItemsAsync((asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        asyncResult.value.forEach((message) => {
            console.log(`Item ID: ${message.itemId}`);
            console.log(`Subject: ${message.subject}`);
            console.log(`Item type: ${message.itemType}`);
            console.log(`Item mode: ${message.itemMode}`);
        });
    });
}

Campos

ActiveViewChanged

Se generó un Document.ActiveViewChanged evento en PowerPoint.

AppointmentTimeChanged

Se produce cuando se cambia cualquier fecha o hora de la cita o serie seleccionada en Outlook.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el AppointmentTimeChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.AppointmentTimeChangedEventArgs.

[ Conjunto de API: Buzón 1.7 ]

AttachmentsChanged

Se produce cuando se agrega o quita un dato adjunto de un elemento.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el AttachmentsChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.AttachmentsChangedEventArgs.

[ Conjunto de API: Buzón 1.8 ]

BindingDataChanged

Se produce cuando los datos del enlace se cambian en Excel o Word.

Para agregar un controlador de eventos para el evento BindingDataChanged de un enlace, use el método addHandlerAsync del objeto Binding. El controlador de eventos recibe un argumento de tipo Office.BindingDataChangedEventArgs.

BindingSelectionChanged

Se produce cuando se cambia la selección dentro del enlace en Excel o Word.

Para agregar un controlador de eventos para el BindingSelectionChanged evento de un enlace, use el addHandlerAsync método del Binding objeto . El controlador de eventos recibe un argumento de tipo Office.BindingSelectionChangedEventArgs.

DialogEventReceived

Se desencadena cuando Dialog tiene un evento, como el diálogo cerrado o se produjo un error en la navegación del cuadro de diálogo.

DialogMessageReceived

Se desencadena cuando un cuadro de diálogo envía un mensaje a través de messageParent.

DialogParentMessageReceived

Se desencadena cuando una página host envía un mensaje a un cuadro de diálogo secundario con messageChild.

DocumentSelectionChanged

Se desencadena cuando se produce una selección de nivel de documento en Excel o Word.

EnhancedLocationsChanged

Se produce cuando se cambia la ubicación de la cita en Outlook.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el EnhancedLocationsChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.EnhancedLocationsChangedEventArgs.

[ Conjunto de API: Buzón 1.8 ]

InfobarClicked

Se produce en Outlook cuando se selecciona una acción en un mensaje de notificación con una acción personalizada definida. Actualmente, "Descartar" es la única acción admitida que desencadena este evento.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el InfobarClicked evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.InfobarClickedEventArgs.

[ Conjunto de API: Buzón 1.10 ]

ItemChanged

Se produce cuando se selecciona un elemento de Outlook diferente para su visualización mientras el panel de tareas está anclado.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el ItemChanged evento, use el addHandlerAsync método del Mailbox objeto .

[ Conjunto de API: Buzón 1.5 ]

NodeDeleted

Se desencadena cuando se elimina un customXmlPart nodo.

NodeInserted

Se desencadena cuando se inserta un customXmlPart nodo.

NodeReplaced

Se desencadena cuando se reemplaza un customXmlPart nodo.

OfficeThemeChanged

Se produce cuando se cambia OfficeTheme en Outlook.

Para agregar un controlador de eventos para el OfficeThemeChanged evento, use el addHandlerAsync método del Mailbox objeto . El controlador de eventos recibe un argumento de tipo Office.OfficeThemeChangedEventArgs.

Importante:

  • El OfficeThemeChanged evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

  • El OfficeThemeChanged evento no se admite en complementos que implementan la activación basada en eventos.

[ Conjunto de API: Buzón 1.14 ]

RecipientsChanged

Se produce cuando se cambia la lista de destinatarios del elemento seleccionado o la ubicación de la cita en Outlook.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el RecipientsChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.RecipientsChangedEventArgs.

[ Conjunto de API: Buzón 1.7 ]

RecurrenceChanged

Se produce cuando se cambia el patrón de periodicidad de la serie seleccionada en Outlook.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el RecurrenceChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.RecurrenceChangedEventArgs.

[ Conjunto de API: Buzón 1.7 ]

ResourceSelectionChanged

Se desencadena cuando se produce una selección de recursos en Project.

SelectedItemsChanged

Se produce en Outlook cuando se seleccionan o anulan la selección de uno o varios mensajes.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el SelectedItemsChanged evento, use el addHandlerAsync método del Mailbox objeto .

[ Conjunto de API: Buzón 1.13 ]

SensitivityLabelChanged

Se produce en Outlook cuando cambia la etiqueta de confidencialidad de un mensaje o cita.

Importante: Este evento solo se puede controlar en un panel de tareas. Los comandos de función no pueden registrar un controlador para este evento.

Para agregar un controlador de eventos para el SensitivityLabelChanged evento, use el addHandlerAsync método del Item objeto . El controlador de eventos recibe un argumento de tipo Office.SensitivityLabelChangedEventArgs.

[ Conjunto de API: Buzón 1.13 ]

SettingsChanged

Se generó un Settings.settingsChanged evento en Excel, PowerPoint o Word.

SpamReporting

Se produce en Outlook cuando se notifica un mensaje no solicitado. El controlador de eventos recibe un argumento de tipo Office.SpamReportingEventArgs.

[ Conjunto de API: Buzón 1.14 ]

TaskSelectionChanged

Se desencadena cuando se produce una selección de tarea en Project.

ViewSelectionChanged

Se desencadena cuando se produce una selección de vista en Project.