Office.Group interface

Paquet:
office

Représente un groupe de contrôles sur un onglet de ruban.

Ensemble de conditions requises : RibbonApi 1.1

Remarques

Utilisateur

Exemples

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

Propriétés

controls

Spécifie un ou plusieurs des contrôles du groupe, tels que les éléments de menu, les boutons, etc.
id

Identifiant du groupe comme spécifié dans le manifeste.
visible

Indique si le groupe de contrôles est affiché ou masqué dans un onglet personnalisé.

Détails de la propriété

controls

Spécifie un ou plusieurs des contrôles du groupe, tels que les éléments de menu, les boutons, etc.

controls?: Control[];

Valeur de propriété

Office.Control[]

Remarques

Lorsque l’objet Group fait partie d’un objet Office.RibbonUpdaterData transmis à la requestUpdate méthode Office.Ribbon, les controls propriétés des différents objets Office.Group spécifient les contrôles dont le status activé est modifié ; la controls propriété de l’objet parent Tab de l’objet Group est ignorée.

id

Identifiant du groupe comme spécifié dans le manifeste.

id: string;

Valeur de propriété

string

visible

Indique si le groupe de contrôles est affiché ou masqué dans un onglet personnalisé.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu de conditions requises : RibbonApi 1.3

Exemples

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