Поделиться через


Office.EventType enum

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

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

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

Комментарии

Примеры

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

Событие Document.ActiveViewChanged было создано в PowerPoint.

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.