Office.EventType enum

Указывает тип вызванного события. Возвращается свойством type*EventArgs объекта.

Надстройки для Project поддерживают Office.EventType.ResourceSelectionChangedтипы , Office.EventType.TaskSelectionChangedи Office.EventType.ViewSelectionChanged события.

Надстройки только области задач для Outlook поддерживают API почтовых ящиков устанавливать типы событий.

Комментарии

Используется

Примеры

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

Поля

ActiveViewChanged

В PowerPoint было поднято Document.ActiveViewChanged событие.

AppointmentTimeChanged

Возникает при изменении любой даты или времени выбранной встречи или ряда в Outlook.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для AppointmentTimeChanged события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.AppointmentTimeChangedEventArgs.

Набор API: Почтовый ящик 1.7

AttachmentsChanged

Возникает при добавлении вложения к элементу или удалении из него.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для AttachmentsChanged события, используйте addHandlerAsync метод Item объекта. Обработчик события получает аргумент типа Office.AttachmentsChangedEventArgs.

Набор API: Почтовый ящик 1.8

BindingDataChanged

Возникает при изменении данных в привязке в Excel или Word.

Чтобы добавить обработчик событий для BindingDataChanged события привязки, используйте addHandlerAsync метод Binding объекта. Обработчик событий получает аргумент типа Office.BindingDataChangedEventArgs.

BindingSelectionChanged

Возникает при изменении выделенного фрагмента в привязке в Excel или Word.

Чтобы добавить обработчик событий для BindingSelectionChanged события привязки, используйте addHandlerAsync метод Binding объекта. Обработчик события получает аргумент типа Office.BindingSelectionChangedEventArgs.

DialogEventReceived

Возникает при закрытии диалогового окна или при сбое навигации по диалоговому окну.

Инструкции по реализации диалогового окна в надстройке см. в статье Использование API диалоговых окон Office в надстройках Office.

DialogMessageReceived

Возникает при отправке сообщения в диалоговом окне с помощью Office.context.ui.messageParent.

Инструкции по реализации диалогового окна в надстройке см. в статье Использование API диалоговых окон Office в надстройках Office.

DialogParentMessageReceived

Возникают, когда ведущая страница отправляет сообщение в дочернее диалоговое окно с Dialog.messageChildпомощью .

Инструкции по реализации диалогового окна в надстройке см. в статье Использование API диалоговых окон Office в надстройках Office.

DocumentSelectionChanged

Возникает при выделении на уровне документа в Excel или Word.

DragAndDropEvent

Возникает в Outlook в Интернете и новом Outlook для Windows, когда сообщения или вложенные файлы из окна клиента Outlook перетаскиваются в область задач надстройки.

Чтобы добавить обработчик события для DragAndDropEvent события, используйте addHandlerAsync метод Mailbox объекта. Обработчик событий получает аргумент типа Office.DragAndDropEventArgs.

Важно! ЭтоDragAndDropEvent событие не поддерживается в Outlook для Windows (классическая версия) и на Mac. Если обработчик выполняется на этих клиентах DragAndDropEvent , возникает ошибка ("Это событие не поддерживается на этой платформе").

Набор API: Почтовый ящик 1.5

EnhancedLocationsChanged

Возникает при изменении места встречи в Outlook.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для EnhancedLocationsChanged события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.EnhancedLocationsChangedEventArgs.

Набор API: Почтовый ящик 1.8

InfobarClicked

Возникает в Outlook при выборе действия в уведомлении с определенным пользовательским действием. В настоящее время Закрыть — единственное поддерживаемое действие, которое запускает это событие.

Чтобы добавить обработчик события для InfobarClicked события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.InfobarClickedEventArgs.

Важно!

  • Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

  • Outlook на Mac хотя поддерживает этот InsightMessage тип уведомлений, в настоящее время он не поддерживает событие InfobarClicked . Чтобы определить, когда в уведомлении выбирается действие "Закрыть ", реализуйте обработчик для OnInfoBarDismissClicked этого события. Дополнительные сведения см. в статье Активация надстроек с помощью событий.

Набор API: почтовый ящик 1.10

InitializationContextChanged

Возникает в Outlook при открытии области задач надстройки из сообщения с действиями, уведомления InsightMessage, диалогового окна интеллектуальных оповещений или встроенного диалогового окна сообщений о нежелательной почте. Это событие препятствует перезапуску надстройки, если ее область задач уже открыта в Outlook.

Важно! СобытиеInitializationContextChanged можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для InitializationContextChanged события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.InitializationContextChangedEventArgs.

Набор API: Почтовый ящик 1.15

ItemChanged

Возникают, когда другой элемент Outlook выбирается для просмотра при закреплении области задач.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для ItemChanged события, используйте addHandlerAsync метод Mailbox объекта.

Набор API: Почтовый ящик 1.5

NodeDeleted

Возникает при удалении customXmlPart узла.

NodeInserted

Возникает при customXmlPart вставке узла.

NodeReplaced

Возникает при замене customXmlPart узла.

OfficeThemeChanged

Возникает при изменении темы OfficeTheme в Outlook.

Чтобы добавить обработчик события для OfficeThemeChanged события, используйте addHandlerAsync метод Mailbox объекта. Обработчик события получает аргумент типа Office.OfficeThemeChangedEventArgs.

Важно!

  • Событие OfficeThemeChanged можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

  • Событие OfficeThemeChanged не поддерживается надстройками, реализующими активацию на основе событий.

Набор API: почтовый ящик 1.14

RecipientsChanged

Возникает при изменении списка получателей выбранного элемента или расположения встречи в Outlook.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для RecipientsChanged события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.RecipientsChangedEventArgs.

Набор API: Почтовый ящик 1.7

RecurrenceChanged

Возникает при изменении шаблона повторения выбранного ряда в Outlook.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для RecurrenceChanged события, используйте addHandlerAsync метод Item объекта. Обработчик события получает аргумент типа Office.RecurrenceChangedEventArgs.

Набор API: Почтовый ящик 1.7

ResourceSelectionChanged

Возникает при выборе ресурса в Project.

SelectedItemsChanged

Возникает в Outlook, когда одно или несколько сообщений выделены или сняты.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для SelectedItemsChanged события, используйте addHandlerAsync метод Mailbox объекта.

Набор API: почтовый ящик 1.13

SensitivityLabelChanged

Возникает в Outlook при изменении метки конфиденциальности сообщения или встречи.

Важно! Это событие можно обработать только в области задач. Команды функций не могут зарегистрировать обработчик для этого события.

Чтобы добавить обработчик события для SensitivityLabelChanged события, используйте addHandlerAsync метод Item объекта. Обработчик событий получает аргумент типа Office.SensitivityLabelChangedEventArgs.

Набор API: почтовый ящик 1.13

SettingsChanged

Событие Settings.settingsChanged было поднято в Excel, PowerPoint или Word.

SpamReporting

Возникает в Outlook, когда сообщается о нежелательном сообщении. Обработчик события получает аргумент типа Office.SpamReportingEventArgs.

Набор API: почтовый ящик 1.14

TaskSelectionChanged

Возникает при выборе задачи в Project.

ViewSelectionChanged

Возникает при выборе представления в Project.