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
        },
    ]
});