Office.Control interface

Paquet:
office

Représente un contrôle ou une commande individuelle et l’état qu’il doit avoir.

Remarques

Pour obtenir des exemples de code montrant comment utiliser un Control objet et ses propriétés, consultez les sections Modifier la disponibilité des commandes de complément et Créer des onglets contextuels personnalisés.

Ensemble de conditions requises : RibbonApi 1.1

Utilisateur

Exemples

// This snippet enables a control (a button) in a custom ribbon tab.
// Note that "MyButton", "OfficeAddinTab1", and "CustomGroup111" are defined in the manifest.
const enableButton = async () => {
    const button: Control = { id: "MyButton", enabled: true };
    const parentGroup: Group = { id: "CustomGroup111", controls: [button] };
    const parentTab: Tab = { id: "OfficeAddinTab1", groups: [parentGroup] };
    const ribbonUpdater: RibbonUpdaterData = { tabs: [parentTab] };
    Office.ribbon.requestUpdate(ribbonUpdater);
}

Propriétés

enabled

Indique si le contrôle doit être activé ou désactivé. La valeur par défaut est true.
id

Identificateur du contrôle comme spécifié dans le manifeste.
visible

Indique si le contrôle est affiché ou masqué dans un onglet personnalisé. La valeur par défaut est true.

Détails de la propriété

enabled

Indique si le contrôle doit être activé ou désactivé. La valeur par défaut est true.

enabled?: boolean;

Valeur de propriété

boolean

id

Identificateur du contrôle comme spécifié dans le manifeste.

id: string;

Valeur de propriété

string

visible

Indique si le contrôle est affiché ou masqué dans un onglet personnalisé. La valeur par défaut est true.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu de conditions requises : RibbonApi 1.3

Important : La visibilité des boutons et des contrôles de menu peut être configurée, mais la visibilité des éléments individuels dans un menu ne peut pas être configurée.

Exemples

// Hide the Export Report button from the ribbon.
const button: Office.Control = {
    id: "Contoso.ExportReportButton",
    visible: false
};

// Specify the button's parent group and tab.
const group: Office.Group = {
    id: "Contoso.ReportingGroup",
    controls: [button]
};
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);