Edit

Share via

Office.ContextMenu interface

  • Reference
Package:
office

Provides options to manage the state of the Office context menu.

To learn more, see Change the availability of add-in commands.

Remarks

Requirement set: ContextMenuAPI 1.1

Methods

requestUpdate(input)

Sends a request to Office to update the context menu.

Method Details

requestUpdate(input)

Sends a request to Office to update the context menu.

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

Parameters

input
Office.ContextMenuUpdaterData

Represents the updates to be made to the context menu controls. Only the changes specified in the control parameter are made. Other context menu controls that aren't specified remain as is in the Office application.

Returns

Promise<void>

Remarks

Requirement set: ContextMenuAPI 1.1

Important: This API is only used to request an update. The actual UI update to the context menu is controlled by the Office application, so the exact timing of the context menu update (or refresh) can't be determined by the completion of this API.