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

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

DialogMessageReceived

Активируется, когда диалоговое окно отправляет сообщение через messageParent.

DialogParentMessageReceived

Активирует, когда ведущая страница отправляет сообщение в дочернее диалоговое окно с messageChild.

DocumentSelectionChanged

Активируется при выборе на уровне документа в Excel или Word.

EnhancedLocationsChanged

Происходит при изменении расположения встречи в Outlook.

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

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

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

InfobarClicked

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

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

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

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

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.