Office.EventType enum

Especifica o tipo de evento que foi gerado. Retornado pela type propriedade de um *EventArgs objeto.

Os suplementos para Project dão suporte aos Office.EventType.ResourceSelectionChangedtipos de evento , Office.EventType.TaskSelectionChangede Office.EventType.ViewSelectionChanged .

Somente os suplementos do painel de tarefas para o Outlook dão suporte a tipos de evento de conjunto de API da Caixa de Correio.

Comentários

Exemplos

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

Um Document.ActiveViewChanged evento foi gerado no PowerPoint.

AppointmentTimeChanged

Ocorre quando qualquer data ou hora do compromisso ou série selecionado é alterado no Outlook. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o AppointmentTimeChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.AppointmentTimeChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.7 ]

AttachmentsChanged

Ocorre quando um anexo é adicionado ou removido de um item. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o AttachmentsChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.AttachmentsChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.8 ]

BindingDataChanged

Ocorre quando os dados dentro da associação são alterados no Excel ou Word.

Para adicionar um manipulador de eventos para o evento BindingDataChanged de uma associação, use o método addHandlerAsync do objeto Binding. O manipulador de eventos recebe um argumento do tipo Office.BindingDataChangedEventArgs.

BindingSelectionChanged

Ocorre quando a seleção é alterada dentro da associação no Excel ou Word.

Para adicionar um manipulador de eventos para o BindingSelectionChanged evento de uma associação, use o addHandlerAsync método do Binding objeto. O manipulador de eventos recebe um argumento do tipo Office.BindingSelectionChangedEventArgs.

DialogEventReceived

Dispara quando a caixa de diálogo tem um evento, como a caixa de diálogo fechada ou a navegação de diálogo falha.

DialogMessageReceived

Dispara quando uma caixa de diálogo envia uma mensagem por meio de messageParent.

DialogParentMessageReceived

Dispara quando uma página de host envia uma mensagem para uma caixa de diálogo filho com messageChild.

DocumentSelectionChanged

Dispara quando uma seleção no nível do documento acontece no Excel ou Word.

EnhancedLocationsChanged

Ocorre quando o local do compromisso é alterado no Outlook. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o EnhancedLocationsChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.EnhancedLocationsChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.8 ]

InfobarClicked

Ocorre no Outlook quando uma ação é selecionada em uma mensagem de notificação com uma ação personalizada definida. Atualmente, "Descartar" é a única ação com suporte que dispara esse evento.

Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o InfobarClicked evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.InfobarClickedEventArgs.

[ Conjunto de API: Caixa de correio 1.10 ]

ItemChanged

Ocorre quando um item diferente do Outlook é selecionado para exibição enquanto o painel de tarefas é fixado. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o ItemChanged evento, use o addHandlerAsync método do Mailbox objeto.

[ Conjunto de API: Caixa de correio 1.5 ]

NodeDeleted

Dispara quando um customXmlPart nó é excluído.

NodeInserted

Dispara quando um customXmlPart nó é inserido.

NodeReplaced

Dispara quando um customXmlPart nó é substituído.

OfficeThemeChanged

Ocorre quando o OfficeTheme é alterado no Outlook. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o OfficeThemeChanged evento, use o addHandlerAsync método do Mailbox objeto. O manipulador de eventos recebe um argumento do tipo Office.OfficeThemeChangedEventArgs.

[ Conjunto de API: visualização da caixa de correio ]

RecipientsChanged

Ocorre quando a lista de destinatários do item selecionado ou o local de compromisso é alterada no Outlook. Importante: disponível somente com a implementação do painel de tarefas.

Para adicionar um manipulador de eventos para o RecipientsChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.RecipientsChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.7 ]

RecurrenceChanged

Ocorre quando o padrão de recorrência da série selecionada é alterado no Outlook. Importante: disponível somente com a implementação do painel de tarefas.

Para adicionar um manipulador de eventos para o RecurrenceChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.RecurrenceChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.7 ]

ResourceSelectionChanged

Dispara quando uma seleção de recursos acontece no Project.

SelectedItemsChanged

Ocorre no Outlook quando uma ou mais mensagens são selecionadas ou desmarcadas. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o SelectedItemsChanged evento, use o addHandlerAsync método do Mailbox objeto.

[ Conjunto de API: Caixa de correio 1.13 ]

SensitivityLabelChanged

Ocorre no Outlook quando o rótulo de confidencialidade de uma mensagem ou compromisso é alterado. Importante: esse evento só pode ser manipulado em um painel de tarefas. Não há suporte para comandos de função.

Para adicionar um manipulador de eventos para o SensitivityLabelChanged evento, use o addHandlerAsync método do Item objeto. O manipulador de eventos recebe um argumento do tipo Office.SensitivityLabelChangedEventArgs.

[ Conjunto de API: Caixa de correio 1.13 ]

SettingsChanged

Um Settings.settingsChanged evento foi gerado no Excel, PowerPoint ou Word.

SpamReporting

Ocorre no Outlook quando uma mensagem não solicitada é relatada. O manipulador de eventos recebe um argumento do tipo Office.SpamReportingEventArgs.

[ Conjunto de API: visualização da caixa de correio ]

TaskSelectionChanged

Dispara quando uma seleção de tarefas acontece no Project.

ViewSelectionChanged

Dispara quando uma seleção de exibição acontece no Project.