Vue d’ensemble du modèle objet du ruban

Le runtime Visual Studio Tools pour Office expose un modèle objet fortement typé que vous pouvez utiliser pour obtenir et définir les propriétés des contrôles du ruban au moment de l’exécution. Par exemple, vous pouvez remplir dynamiquement des contrôles de menu, ou afficher et masquer les contrôles de manière contextuelle. Vous pouvez également ajouter des onglets, des groupes et des contrôles à un ruban, mais uniquement avant le chargement du ruban par l’application Office. Pour plus d’informations, consultez Définir les propriétés qui deviennent en lecture seule.

S’applique à : Les informations contenues dans cette rubrique s’appliquent aux projets de niveau document et aux projets de complément VSTO pour les applications suivantes : Excel ; InfoPath 2013 et InfoPath 2010 ; Perspective; PowerPoint ; Projet; Visio ; Mot. Pour plus d’informations, consultez Fonctionnalités disponibles par type d’application et de projet Office.

Ce modèle objet Ruban se compose principalement de la classe Ruban, des événements de ruban et des classes de contrôle Ruban.

Classe de ruban

Lorsque vous ajoutez un nouvel élément ruban (Concepteur visuel) à un projet, Visual Studio ajoute une classe de ruban à votre projet. La classe Ribbon hérite de la RibbonBase classe.

Cette classe apparaît sous la forme d’une classe partielle qui est divisée entre le fichier de code du ruban et le fichier de code du Concepteur de ruban.

Événements du ruban

La classe Ribbon contient les trois événements suivants :

Contrôles du ruban

L’espace Microsoft.Office.Tools.Ribbon de noms contient un type pour chaque contrôle que vous voyez dans le groupe Contrôles du ruban Office de la boîte à outils.

Le tableau suivant montre le type de chaque Ribbon contrôle. Pour obtenir une description de chaque contrôle, consultez la vue d’ensemble du ruban.

L’espace Microsoft.Office.Tools.Ribbon de noms utilise le préfixe « Ribbon » pour ces types afin d’éviter un conflit de noms avec les noms des classes de contrôle dans l’espace System.Windows.Forms de noms.

Lorsque vous ajoutez un contrôle au Concepteur de ruban, le Concepteur de ruban déclare la classe de ce contrôle en tant que champ dans le fichier de code du Concepteur de ruban.

Tâches courantes utilisant les propriétés des contrôles du ruban

Chaque Ribbon contrôle contient des propriétés que vous pouvez utiliser pour effectuer différentes tâches, telles que l’affectation d’une étiquette à un contrôle ou le masquage et l’affichage de contrôles.

Dans certains cas, les propriétés deviennent en lecture seule une fois le ruban chargé ou après l’ajout d’un contrôle à un menu dynamique. Pour plus d’informations, consultez Définir les propriétés qui deviennent en mode lecture seule.

Le tableau suivant décrit certaines des tâches que vous pouvez effectuer à l’aide Ribbon des propriétés de contrôle.

Définir des propriétés qui deviennent en mode lecture seule

Certaines propriétés ne peuvent être définies qu’avant le chargement du ruban. Il existe trois endroits pour définir ces propriétés :

• Dans la fenêtre Propriétés de Visual Studio.

• Dans le constructeur de la classe Ribbon .

• Dans la méthode CreateRibbonExtensibilityObject de la classe ThisAddin, ThisWorkbook, ou ThisDocument de votre projet.

  Les menus dynamiques fournissent certaines exceptions. Vous pouvez créer des contrôles, définir leurs propriétés, puis les ajouter à un menu dynamique au moment de l’exécution, même après le chargement du ruban qui contient le menu.

  Les propriétés des contrôles que vous ajoutez à un menu dynamique peuvent être définies à tout moment.

  Pour plus d’informations, consultez Propriétés qui deviennent en lecture seule.

Définir des propriétés dans le constructeur du ruban

Vous pouvez définir les propriétés d’un Ribbon contrôle dans le constructeur de la classe Ribbon . Ce code doit apparaître après l’appel à la InitializeComponent méthode. L’exemple suivant ajoute un nouveau bouton à un groupe si l’heure actuelle est 17 h 00, heure du Pacifique (UTC-8) ou plus tard.

Ajoutez le code ci-dessous.

public Ribbon1()
    : base(Globals.Factory.GetRibbonFactory())
{
    InitializeComponent();
    if (System.DateTime.Now.Hour > 16)
    {
        Microsoft.Office.Tools.Ribbon.RibbonButton button =
            this.Factory.CreateRibbonButton();
        button.Label = "New Button";
        group1.Items.Add(button);
    }
}

<System.Diagnostics.DebuggerNonUserCode()> _
Public Sub New()
    MyBase.New(Globals.Factory.GetRibbonFactory())

    'This call is required by the Component Designer.
    InitializeComponent()
    Dim MyButton As Microsoft.Office.Tools.Ribbon.RibbonButton = _
        Me.Factory.CreateRibbonButton()
    MyButton.Label = "New Button"
    If System.DateTime.Now.Hour > 16 Then
        Group1.Items.Add(MyButton)
    End If

End Sub

Dans les projets Visual C# que vous avez mis à niveau à partir de Visual Studio 2008, le constructeur apparaît dans le fichier de code du ruban.

Dans les projets Visual Basic ou dans les projets Visual C# que vous avez créés dans Visual Studio 2013, le constructeur apparaît dans le fichier de code du Concepteur de ruban. Ce fichier est nommé YourRibbonItem. Designer.cs ou YourRibbonItem. Designer.vb. Pour afficher ce fichier dans les projets Visual Basic, vous devez d’abord cliquer sur le bouton Afficher tous les fichiers dans l’Explorateur de solutions.

Définir des propriétés dans la méthode CreateRibbonExtensibilityObject

Vous pouvez définir les propriétés d’un Ribbon contrôle lorsque vous remplacez la CreateRibbonExtensibilityObject méthode dans la ThisAddin, ThisWorkbook ou ThisDocument classe de votre projet. Pour plus d’informations sur la méthode, consultez la Vue d’ensemble du ruban.

L’exemple suivant définit les propriétés du ruban dans la CreateRibbonExtensibilityObject méthode de la ThisWorkbook classe d’un projet de classeur Excel.

Ajoutez le code ci-dessous.

protected override Microsoft.Office.Core.IRibbonExtensibility
    CreateRibbonExtensibilityObject()
{
    bool myCondition = false;
    if (myCondition == true)
    {
        Ribbon1 tempRibbon = new Ribbon1();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabHome";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager( 
            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[]
             { tempRibbon });
    }
    else
    {
        Ribbon2 tempRibbon = new Ribbon2();
        tempRibbon.tab1.ControlId.ControlIdType =
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office;
        tempRibbon.tab1.ControlId.OfficeId = "TabInsert";
        return Globals.Factory.GetRibbonFactory().CreateRibbonManager(
                            new Microsoft.Office.Tools.Ribbon.IRibbonExtension[] { tempRibbon });
    }
}

Protected Overrides Function CreateRibbonExtensibilityObject() _
    As Microsoft.Office.Core.IRibbonExtensibility
    Dim myCondition As Boolean = True
    If myCondition = True Then
        Dim tempRibbon As New Ribbon1()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabHome"
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    Else
        Dim tempRibbon As New Ribbon2()
        tempRibbon.Tab1.ControlId.ControlIdType = _
            Microsoft.Office.Tools.Ribbon.RibbonControlIdType.Office
        tempRibbon.Tab1.ControlId.OfficeId = "TabInsert"
        Return Globals.Factory.GetRibbonFactory.CreateRibbonManager _
            (New Microsoft.Office.Tools.Ribbon.IRibbonExtension() {tempRibbon})
    End If
End Function

Propriétés qui passent en mode lecture seule

Le tableau suivant montre les propriétés qui ne peuvent être définies qu’avant le chargement du ruban.

Définir les propriétés des rubans qui s’affichent dans les inspecteurs Outlook

Une nouvelle instance du ruban est créée chaque fois qu’un utilisateur ouvre un inspecteur dans lequel le ruban apparaît. Toutefois, vous pouvez définir les propriétés répertoriées dans le tableau ci-dessus uniquement avant la création de la première instance du ruban. Une fois la première instance créée, ces propriétés deviennent en lecture seule, car la première instance définit le fichier XML utilisé par Outlook pour charger le ruban.

Si vous avez une logique conditionnelle qui définit l’une de ces propriétés sur une valeur différente lorsque d’autres instances du ruban sont créées, ce code n’aura aucun effet.

Événements de contrôle du ruban

Chaque classe de contrôle contient un ou plusieurs événements. Le tableau suivant décrit ces événements.

Les gestionnaires d’événements pour ces événements ont les deux paramètres suivants.

Contenu connexe

• Accéder au ruban au moment de l’exécution
• Vue d’ensemble du ruban
• Guide pratique pour commencer à personnaliser le ruban
• Éditeur de ruban
• Procédure pas à pas : créer un onglet personnalisé à l’aide du Concepteur de ruban
• Procédure pas à pas : mettre à jour les contrôles sur un ruban au moment de l’exécution
• Personnaliser un ruban pour Outlook
• Guide pratique pour personnaliser un onglet intégré
• Guide pratique pour ajouter des contrôles à la vue Backstage
• Guide pratique pour exporter un ruban à partir du Concepteur de ruban vers le code XML du ruban
• Comment afficher les erreurs d'interface utilisateur du complément