Office.Tab interface

Paquet:

office

Représente un onglet individuel et l’état qu’il doit avoir. Pour obtenir des exemples de code, consultez Activer et désactiver les commandes de complément et Créer des onglets contextuels personnalisés.

Remarques

Ensemble de conditions requises : RibbonAPI 1.1

Propriétés

controls	Spécifie un ou plusieurs 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ôles sous l’onglet.
id	Identificateur de l’onglet tel que spécifié dans le manifeste.
visible	Spécifie 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 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 passé à la requestUpdate méthode d’Office.Ribbon, cette propriété spécifie les ID des contrôles dont le status activé doit être modifié. Toutefois, s’il existe une groups propriété sous l’onglet, cette propriété est ignorée et les controls propriétés des groupes spécifiés doivent être utilisées pour modifier les status activés.

groups

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

groups?: Group[];

Valeur de propriété

Office.Group[]

Remarques

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

Ensemble de conditions requises : RibbonAPI 1.1

id

Identificateur de l’onglet tel que 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

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

visible?: boolean;

Valeur de propriété

boolean

Remarques

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