Office.EventType enum

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

Os suplementos para o Project suportam os Office.EventType.ResourceSelectionChangedtipos de eventos , Office.EventType.TaskSelectionChangede Office.EventType.ViewSelectionChanged .

Apenas os suplementos do painel de tarefas do Outlook suportam tipos de eventos de conjuntos 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

Foi Document.ActiveViewChanged gerado um evento no PowerPoint.

AppointmentTimeChanged

Ocorre quando qualquer data ou hora do compromisso ou série selecionado é alterado no Outlook.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

Para adicionar um processador de eventos para o AppointmentTimeChanged evento, utilize o addHandlerAsync método do Item objeto. O processador 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: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.8 ]

BindingDataChanged

Ocorre quando os dados no enlace são alterados no Excel ou word.

Para adicionar um processador de eventos para o evento BindingDataChanged de um enlace, utilize o método addHandlerAsync do objeto Binding. O processador de eventos recebe um argumento do tipo Office.BindingDataChangedEventArgs.

BindingSelectionChanged

Ocorre quando a seleção é alterada no enlace no Excel ou Word.

Para adicionar um processador de eventos para o BindingSelectionChanged evento de um enlace, utilize o addHandlerAsync método do Binding objeto. O processador de eventos recebe um argumento do tipo Office.BindingSelectionChangedEventArgs.

DialogEventReceived

Aciona quando a Caixa de Diálogo tem um evento, como a caixa de diálogo fechada ou a navegação na caixa de diálogo falhou.

DialogMessageReceived

Aciona quando uma caixa de diálogo envia uma mensagem através de messageParent.

DialogParentMessageReceived

Aciona quando uma página de anfitrião envia uma mensagem para uma caixa de diálogo subordinada com messageChild.

DocumentSelectionChanged

Aciona quando ocorre uma seleção ao nível do documento no Excel ou no Word.

EnhancedLocationsChanged

Ocorre quando a localização do compromisso é alterada no Outlook.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

Para adicionar um processador de eventos para o EnhancedLocationsChanged evento, utilize o addHandlerAsync método do Item objeto. O processador 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 numa mensagem de notificação com uma ação personalizada definida. Atualmente, "Dispensar" é a única ação suportada que aciona este evento.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

Para adicionar um processador de eventos para o InfobarClicked evento, utilize o addHandlerAsync método do Item objeto. O processador 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 visualização enquanto o painel de tarefas está afixado.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.5 ]

NodeDeleted

Aciona quando um customXmlPart nó é eliminado.

NodeInserted

Aciona quando um customXmlPart nó é inserido.

NodeReplaced

Aciona quando um customXmlPart nó é substituído.

OfficeThemeChanged

Ocorre quando o OfficeTheme é alterado no Outlook.

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

Importante:

  • O OfficeThemeChanged evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

  • O OfficeThemeChanged evento não é suportado em suplementos que implementam a ativação baseada em eventos.

[ Conjunto de API: Caixa de Correio 1.14 ]

RecipientsChanged

Ocorre quando a lista de destinatários do item selecionado ou a localização do compromisso é alterada no Outlook.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.7 ]

RecurrenceChanged

Ocorre quando o padrão de periodicidade da série selecionada é alterado no Outlook.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.7 ]

ResourceSelectionChanged

Aciona quando ocorre uma seleção de Recursos no Project.

SelectedItemsChanged

Ocorre no Outlook quando uma ou mais mensagens são selecionadas ou desselecionadas.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.13 ]

SensitivityLabelChanged

Ocorre no Outlook quando a etiqueta de confidencialidade de uma mensagem ou compromisso é alterada.

Importante: este evento só pode ser processado num painel de tarefas. Os comandos de função não podem registar um processador para este evento.

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

[ Conjunto de API: Caixa de Correio 1.13 ]

SettingsChanged

Foi Settings.settingsChanged gerado um evento no Excel, PowerPoint ou Word.

SpamReporting

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

[ Conjunto de API: Caixa de Correio 1.14 ]

TaskSelectionChanged

Aciona quando uma seleção de Tarefas ocorre no Project.

ViewSelectionChanged

Aciona quando ocorre uma seleção de Vista no Project.