Office.EventType enum

指定引发的事件的类型。 由 type 对象的 属性 *EventArgs 返回。

Project 的加载项支持 Office.EventType.ResourceSelectionChangedOffice.EventType.TaskSelectionChangedOffice.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

Document.ActiveViewChanged在 PowerPoint 中引发了事件。

AppointmentTimeChanged

在 Outlook 中更改所选约会或系列的任何日期或时间时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 AppointmentTimeChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.AppointmentTimeChangedEventArgs 的参数。

[ API set: Mailbox 1.7 ]

AttachmentsChanged

在向项目添加或删除附件时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 AttachmentsChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.AttachmentsChangedEventArgs 的参数。

[ API set: Mailbox 1.8 ]

BindingDataChanged

在 Excel 或 Word 中更改绑定中的数据时发生。

若要为绑定的 BindingDataChanged 事件添加事件处理程序,请使用 Binding 对象的 addHandlerAsync 方法。 事件处理程序接收 类型为 Office.BindingDataChangedEventArgs 的参数。

BindingSelectionChanged

在 Excel 或 Word 的绑定中更改所选内容时发生。

若要为 BindingSelectionChanged 绑定的 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Binding 。 事件处理程序接收 类型为 Office.BindingSelectionChangedEventArgs 的参数。

DialogEventReceived

当 Dialog 具有事件(例如对话框关闭或对话导航失败)时触发。

DialogMessageReceived

当对话框通过 messageParent发送消息时触发。

DialogParentMessageReceived

当主机页使用 messageChild向子对话框发送消息时触发。

DocumentSelectionChanged

在 Excel 或 Word 中发生文档级选择时触发。

EnhancedLocationsChanged

在 Outlook 中更改约会位置时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 EnhancedLocationsChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.EnhancedLocationsChangedEventArgs 的参数。

[ API set: Mailbox 1.8 ]

InfobarClicked

在 Outlook 中使用定义的自定义操作在通知邮件上选择 操作时发生。 目前,“消除”是唯一受支持的触发此事件的操作。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 InfobarClicked 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.InfobarClickedEventArgs 的参数。

[ API set: Mailbox 1.10 ]

ItemChanged

在固定任务窗格时选择其他 Outlook 项目进行查看时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 ItemChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Mailbox

[ API 集:邮箱 1.5 ]

NodeDeleted

删除节点时 customXmlPart 触发。

NodeInserted

插入节点时 customXmlPart 触发。

NodeReplaced

替换节点时 customXmlPart 触发。

OfficeThemeChanged

在 Outlook 中更改 OfficeTheme 时发生。

若要为 OfficeThemeChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Mailbox 。 事件处理程序接收 类型为 Office.OfficeThemeChangedEventArgs 的参数。

重要说明

  • 只能在 OfficeThemeChanged 任务窗格中处理该事件。 函数命令无法为此事件注册处理程序。

  • 实现OfficeThemeChanged基于事件的激活的加载项不支持该事件

[ API set: Mailbox 1.14 ]

RecipientsChanged

在 Outlook 中更改所选项目的收件人列表或约会位置时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 RecipientsChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.RecipientsChangedEventArgs 的参数。

[ API set: Mailbox 1.7 ]

RecurrenceChanged

在 Outlook 中更改所选系列的重复模式时发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 RecurrenceChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.RecurrenceChangedEventArgs 的参数。

[ API set: Mailbox 1.7 ]

ResourceSelectionChanged

在 Project 中发生资源选择时触发。

SelectedItemsChanged

选择或取消选择一个或多个邮件时,在 Outlook 中发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 SelectedItemsChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Mailbox

[ API set: Mailbox 1.13 ]

SensitivityLabelChanged

当邮件或约会的敏感度标签发生更改时,在 Outlook 中发生。

重要提示:只能在任务窗格中处理此事件。 函数命令无法为此事件注册处理程序。

若要为 SensitivityLabelChanged 事件添加事件处理程序,请使用 addHandlerAsync 对象的 方法 Item 。 事件处理程序接收 类型为 Office.SensitivityLabelChangedEventArgs 的参数。

[ API set: Mailbox 1.13 ]

SettingsChanged

Settings.settingsChanged Excel、PowerPoint 或 Word 中引发了事件。

SpamReporting

在 Outlook 中报告未经请求的邮件时发生。 事件处理程序接收 类型为 Office.SpamReportingEventArgs 的参数。

[ API set: Mailbox 1.14 ]

TaskSelectionChanged

在 Project 中发生“任务”选择时触发。

ViewSelectionChanged

在 Project 中发生视图选择时触发。