Office.Tab interface

Paquet:
office

Représente un onglet individuel et l’état qu’il devrait avoir. Pour obtenir des exemples de code, consultez les rubriques Modifier la disponibilité des commandes de complément et Créer des onglets contextuels personnalisés.

Remarques

Ensemble de conditions requises : RibbonApi 1.1

Utilisateur

Exemples

// Create an Office.Tab object (a contextual tab), set its visibility
// and add it to the ribbon.
async function showDataTab() {
    // Create the Office.Tab object.
    const myContextualTab = { id: "CtxTab1", visible: true };
    const ribbonUpdater = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}

Propriétés

controls

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

Spécifie un ou plusieurs des groupes de contrôle de l’onglet.
id

Identifiant de l’onglet comme spécifié dans le manifeste.
visible

Indique si l’onglet est visible sur le ruban. Utilisé uniquement avec les onglets contextuels.

Détails de la propriété

controls

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

controls?: Control[];

Valeur de propriété

Office.Control[]

Remarques

Lorsque l’objet Tab fait partie d’un objet Office.RibbonUpdaterData transmis à la requestUpdate méthode Office.Ribbon, cette propriété spécifie les ID des contrôles dont le status d’activation doit être modifié. Toutefois, s’il existe une groups propriété dans l’onglet, cette propriété est ignorée et les propriétés des groupes spécifiés doivent être utilisées pour modifier le controls status activé.

groups

Spécifie un ou plusieurs des groupes de contrôle de l’onglet.

groups?: Group[];

Valeur de propriété

Office.Group[]

Remarques

Lorsque l’objet Tab 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 Tab est ignorée.

Ensemble de conditions requises : RibbonApi 1.1

Exemples

/**
 * Shows or hides a contextual tab.
 */
async function setContextualTabVisibility(visible: boolean) {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "ContextualTab1",
                visible: visible,
                groups: [
                {
                    id: "TableToolsGroup",
                    controls: [
                        { id: "FormatTableButton", enabled: true },
                        { id: "SortTableButton", enabled: true },
                    ],
                },
                ],
            },
        ],
    });
}

id

Identifiant de l’onglet comme spécifié dans le manifeste.

id: string;

Valeur de propriété

string

Exemples

// Office.Tab objects are properties of ribbon updater objects that are passed to the 
// Office.ribbon.requestUpdate method. The following shows how to set the visibility of 
// a custom contextual tab.

async function showDataTab() {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "CtxTab1",
                visible: true
            }
        ]});
}

// The the following does the same thing in TypeScript.

const showDataTab = async () => {
    const myContextualTab: Office.Tab = { id: "CtxTab1", visible: true };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}

visible

Indique si l’onglet est visible sur le ruban. Utilisé uniquement avec les onglets contextuels.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu de conditions requises : RibbonApi 1.2

Exemples

// Office.Tab objects are properties of ribbon updater objects that are passed to the 
// Office.ribbon.requestUpdate method. The following shows how to set the visibility of 
// a custom contextual tab.

async function showDataTab() {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "CtxTab1",
                visible: true
            }
        ]});
}

// The following does the same thing in TypeScript.

const showDataTab = async () => {
    const myContextualTab: Office.Tab = { id: "CtxTab1", visible: true };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}