Office.Control interface

Paket:
office

Stellt ein einzelnes Steuerelement oder einen Befehl und dessen Status dar.

Hinweise

Codebeispiele, die die Verwendung eines Control Objekts und seiner Eigenschaften zeigen, finden Sie unter Ändern der Verfügbarkeit von Add-In-Befehlen und Erstellen benutzerdefinierter kontextbezogener Registerkarten.

Anforderungssatz: RibbonApi 1.1

Verwendet von

Beispiele

// 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);
}

Eigenschaften

enabled

Gibt an, ob das Steuerelement aktiviert oder deaktiviert werden soll. Der Standardwert ist true.
id

Bezeichner des Steuerelements, wie im Manifest angegeben.
visible

Gibt an, ob das Steuerelement auf einer benutzerdefinierten Registerkarte ein- oder ausgeblendet wird. Der Standardwert ist true.

Details zur Eigenschaft

enabled

Gibt an, ob das Steuerelement aktiviert oder deaktiviert werden soll. Der Standardwert ist true.

enabled?: boolean;

Eigenschaftswert

boolean

id

Bezeichner des Steuerelements, wie im Manifest angegeben.

id: string;

Eigenschaftswert

string

visible

Gibt an, ob das Steuerelement auf einer benutzerdefinierten Registerkarte ein- oder ausgeblendet wird. Der Standardwert ist true.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

Anforderungssatz: RibbonApi 1.3

Wichtig: Die Sichtbarkeit von Schaltflächen und Menüsteuerelementen kann konfiguriert werden, aber die Sichtbarkeit einzelner Elemente innerhalb eines Menüs kann nicht konfiguriert werden.

Beispiele

// Hide the Export Report button from the ribbon.
const button: Office.Control = {
    id: "Contoso.ExportReportButton",
    visible: false
};

// Specify the button's parent group and tab.
const group: Office.Group = {
    id: "Contoso.ReportingGroup",
    controls: [button]
};
const tab: Office.Tab = {
    id: "Contoso.UserToolsTab",
    groups: [group]
};

// Apply the change to the ribbon.
const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [tab] };
await Office.ribbon.requestUpdate(ribbonUpdater);