Office.ContextMenu interface

包:
office

提供用于管理 Office 上下文菜单状态的选项。

若要了解详细信息，请参阅更改加载项命令的可用性。

注解

要求集： ContextMenuApi 1.1

方法

requestUpdate(input)

向 Office 发送更新上下文菜单的请求。

方法详细信息

requestUpdate(input)

向 Office 发送更新上下文菜单的请求。

requestUpdate(input: ContextMenuUpdaterData): Promise<void>;

参数

input
Office.ContextMenuUpdaterData

表示要对上下文菜单控件进行的更新。 仅进行参数中 control 指定的更改。 未指定的其他上下文菜单控件在 Office 应用程序中保持不变。

返回

Promise<void>

注解

要求集： ContextMenuApi 1.1

重要提示：此 API 仅用于请求更新。 上下文菜单的实际 UI 更新由 Office 应用程序控制，因此上下文菜单更新 (或刷新) 的确切时间不能由此 API 完成来确定。

示例

// Change the availability of custom buttons on the context menu.
await Office.contextMenu.requestUpdate({
    controls: [
        {
            id: Addin.CtxMenu.Button1,
            enabled: true
        },
        {
            id: Addin.CtxMenu.Button2,
            enabled: false
        },
    ]
});