Office.Ribbon interface

Paquet:

office

Interface qui contient toutes les fonctionnalités fournies pour gérer l’état du ruban Office.

Remarques

Ensemble de conditions requises : RibbonAPI 1.1

Méthodes

requestCreateControls(tabDefinition)	Inscrit un onglet contextuel personnalisé auprès d’Office et définit les contrôles de l’onglet.
requestUpdate(input)	Envoie une demande à Office pour mettre à jour le ruban.

Détails de la méthode

requestCreateControls(tabDefinition)

Inscrit un onglet contextuel personnalisé auprès d’Office et définit les contrôles de l’onglet.

requestCreateControls(tabDefinition: Object): Promise<void>;

Paramètres

tabDefinition

Object

Spécifie les propriétés de l’onglet et les contrôles enfants et leurs propriétés. Ce paramètre n’est pas fortement typé, car sa forme est définie par un schéma JSON qui peut être versionné. Pour créer l’objet de paramètre, transmettez une chaîne JSON conforme au schéma JSON du ruban dynamique Office à JSON.parse, puis transmettez l’objet retourné à cette méthode. Pour obtenir IntelliSense pour le JSON dans Visual Studio Code, consultez Modification de JSON avec Visual Studio Code - Schémas et paramètres JSON.

Retours

Promise<void>

Remarques

Ensemble de conditions requises : RibbonAPI 1.2

Cette méthode demande uniquement l’inscription de l’onglet. L’inscription réelle est contrôlée par l’application Office et peut ne pas être terminée lorsque l’objet retourné Promise est résolu. Pour plus d’informations et des exemples de code, consultez Créer des onglets contextuels personnalisés.

Exemples

// Registers a custom contextual tab with Office.
Office.onReady(async () => {
    const contextualTabJSON = ` ... `; // Assign the JSON string.
    const contextualTab = JSON.parse(contextualTabJSON);
    await Office.ribbon.requestCreateControls(contextualTab);
});

requestUpdate(input)

Envoie une demande à Office pour mettre à jour le ruban.

requestUpdate(input: RibbonUpdaterData): Promise<void>;

Paramètres

input

Office.RibbonUpdaterData

Représente les mises à jour à apporter au ruban. Notez que seules les modifications spécifiées dans le paramètre d’entrée sont apportées.

Retours

Promise<void>

Remarques

Ensemble de conditions requises : RibbonAPI 1.1

Notez que cette API est uniquement pour demander une mise à jour. La mise à jour réelle de l’interface utilisateur du ruban est contrôlée par l’application Office. Par conséquent, le moment exact de la mise à jour (ou de l’actualisation) du ruban ne peut pas être déterminé par l’achèvement de cette API.

Pour obtenir des exemples de code, consultez Activer et désactiver les commandes de complément et Créer des onglets contextuels personnalisés.

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