Office.Control interface

Remarks

For code samples showing how to use a Control object and its properties, see Change the availability of add-in commands and Create custom contextual tabs.

Requirement set: RibbonAPI 1.1

Examples

// This snippet enables a control (a button) in a custom ribbon tab.
// Note that "MyButton", "OfficeAddinTab1", and "CustomGroup111" are defined in the manifest.
const enableButton = async () => {
    const button: Control = { id: "MyButton", enabled: true };
    const parentGroup: Group = { id: "CustomGroup111", controls: [button] };
    const parentTab: Tab = { id: "OfficeAddinTab1", groups: [parentGroup] };
    const ribbonUpdater: RibbonUpdaterData = { tabs: [parentTab] };
    Office.ribbon.requestUpdate(ribbonUpdater);
}

Properties

enabled

enabled?: boolean;

id

id: string;