Office.Group interface

Paket:
office

Stellt eine Gruppe von Steuerelementen auf einer Registerkarte des Menübands dar.

Anforderungssatz: RibbonApi 1.1

Hinweise

Verwendet von

Beispiele

/**
 * Shows or hides a contextual tab.
 */
async function setContextualTabVisibility(visible: boolean) {
    // Define a tab group of controls.
    const group: Office.Group = {
        id: "TableToolsGroup",
        controls: [
            // The controls of the group...
        ],
    };
    
    // Update the ribbon to show or hide a tab with the specified group of controls.
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "contextTab1",
                visible: visible,
                groups: [group],
            },
        ],
    });
}

Eigenschaften

controls

Gibt mindestens eines der Steuerelemente in der Gruppe an, z. B. Menüelemente, Schaltflächen usw.
id

Bezeichner der Gruppe, wie im Manifest angegeben.
visible

Gibt an, ob die Gruppe von Steuerelementen auf einer benutzerdefinierten Registerkarte ein- oder ausgeblendet wird.

Details zur Eigenschaft

controls

Gibt mindestens eines der Steuerelemente in der Gruppe an, z. B. Menüelemente, Schaltflächen usw.

controls?: Control[];

Eigenschaftswert

Office.Control[]

Hinweise

Wenn das Group Objekt Teil eines Office.RibbonUpdaterData-Objekts ist, das an die requestUpdateOffice.Ribbon-Methode übergeben wird, geben die controls Eigenschaften der verschiedenen Office.Group-Objekte an, bei welchen Steuerelementen ihr aktivierter Status geändert wird; die controls Eigenschaft des Group übergeordneten Tab Objekts des Objekts wird ignoriert.

id

Bezeichner der Gruppe, wie im Manifest angegeben.

id: string;

Eigenschaftswert

string

visible

Gibt an, ob die Gruppe von Steuerelementen auf einer benutzerdefinierten Registerkarte ein- oder ausgeblendet wird.

visible?: boolean;

Eigenschaftswert

boolean

Hinweise

Anforderungssatz: RibbonApi 1.3

Beispiele

// Hide the Reporting Group from the User Tools tab on the ribbon.
const group: Office.Group = {
    id: "Contoso.ReportingGroup",
    visible: false
};
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);