Procédure pas à pas : créer un onglet personnalisé à l’aide du Concepteur de ruban

Article
10/10/2023

Le Concepteur de ruban vous permet de créer un onglet personnalisé puis d'ajouter et de positionner des contrôles dessus.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document pour Excel. Pour plus d’informations, consultez Fonctionnalités disponibles par application Office lication et le type de projet.

Cette procédure pas à pas décrit les tâches suivantes :

Créer des volets Actions.
Créez un onglet personnalisé.
Masquez et affichez les volets Actions à l’aide de boutons sous l’onglet personnalisé.

Remarque

Il est possible que pour certains des éléments de l'interface utilisateur de Visual Studio, votre ordinateur affiche des noms ou des emplacements différents de ceux indiqués dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d’informations, consultez Personnaliser l’IDE Visual Studio.

Prérequis

Vous devez disposer des éléments suivants pour exécuter cette procédure pas à pas :

Une édition de Visual Studio qui inclut les outils de développement Microsoft Office. Pour plus d’informations, consultez Configurer un ordinateur pour développer des solutions Bureau.
Microsoft Excel

Créer un projet de classeur Excel

Les étapes pour utiliser le Concepteur de ruban sont presque identiques pour toutes les applications Office. Cet exemple utilise un classeur Excel.

Pour créer un projet de classeur Excel

Créez un projet de classeur Excel avec le nom MyExcelRibbon. Pour plus d'informations, consultez How to: Create Office Projects in Visual Studio.

Visual Studio ouvre le nouveau classeur dans le concepteur et ajoute le projet MyExcelRibbon à Explorateur de solutions.

Créer des volets Actions

Ajoutez deux volets Actions personnalisés au projet. Vous ajouterez ultérieurement à l'onglet personnalisé des boutons qui affichent et masquent ces volets Actions.

Pour créer des volets Actions

Dans le menu Projet , choisissez Ajouter un nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément , sélectionnez ActionsPaneControl, puis choisissez Ajouter.

Le fichier ActionsPaneControl1.cs ou ActionsPaneControl1.vb s’ouvre dans le concepteur.
Sous l’onglet Contrôles communs de la boîte à outils, ajoutez une étiquette à l’aire du concepteur.
Dans la fenêtre Propriétés , définissez la propriété Text de label1 sur Actions Pane 1.
Répétez les étapes 1 à 5 pour créer un deuxième volet Actions et une deuxième étiquette. Définissez la propriété Text de la deuxième étiquette sur Actions Pane 2.

Créer un onglet personnalisé

L'une des règles de conception d'une application Office stipule que les utilisateurs doivent toujours avoir le contrôle de l'interface utilisateur de l'application Office. Pour ajouter cette fonction pour les volets Actions, vous pouvez ajouter des boutons qui affichent et masquent chaque volet Actions à partir d'un onglet personnalisé sur le ruban. Pour créer un onglet personnalisé, ajoutez un élément ruban (Concepteur visuel) au projet. Le concepteur vous permet d'ajouter et de position des contrôles, de définir les propriétés des contrôles et de gérer les événements de contrôle.

Pour créer un onglet personnalisé

Dans le menu Projet , choisissez Ajouter un nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément , sélectionnez Ruban (Concepteur visuel).
Remplacez le nom du nouveau ruban par MyRibbon, puis choisissez Ajouter.

Le fichier MyRibbon.cs ou MyRibbon.vb s'ouvre dans le Concepteur de ruban et affiche un onglet et un groupe par défaut.
Dans le Concepteur de ruban, choisissez l'onglet par défaut.
Dans la fenêtre Propriétés , développez la propriété ControlId , puis définissez la propriété ControlIdType sur Custom.
Définissez la propriété Label sur Mon onglet personnalisé.
Dans le Concepteur de ruban, choisissez groupe1.
Dans la fenêtre Propriétés , définissez Étiquette sur Gestionnaire du volet Actions.
À partir de l’onglet Contrôles du ruban Bureau de la boîte à outils, faites glisser un bouton sur le groupe1.
Sélectionnez le bouton1.
Dans la fenêtre Propriétés , définissez Étiquette sur Afficher le volet Actions 1.
Ajoutez un deuxième bouton au groupe1 et définissez la propriété Label sur Afficher le volet Actions 2.
À partir de l’onglet Contrôles du ruban Bureau de la boîte à outils, faites glisser un contrôle ToggleButton sur group1.
Définissez la propriété Label sur Masquer le volet Actions.

Masquer et afficher les volets Actions à l’aide de boutons sous l’onglet personnalisé

La dernière étape consiste à ajouter le code qui répond à l'utilisateur. Ajoutez les gestionnaires d'événements pour les événements Click des deux boutons et l'événement Click du bouton bascule. Ajoutez le code aux gestionnaires d'événements pour permettre de masquer et d'afficher les volets Actions.

Pour masquer et afficher des volets Actions à l'aide de boutons dans l'onglet personnalisé

Dans Explorateur de solutions, ouvrez le menu contextuel de MyRibbon.cs ou MyRibbon.vb, puis choisissez Afficher le code.

Ajoutez le code suivant en haut de la classe MyRibbon. Ce code crée deux objets du volet Actions.

ActionsPaneControl1 actionsPane1 = new ActionsPaneControl1();
ActionsPaneControl2 actionsPane2 = new ActionsPaneControl2();

Dim actionsPane1 As New ActionsPaneControl1()
Dim actionsPane2 As New ActionsPaneControl2()

Remplacez la méthode MyRibbon_Load par le code suivant. Ce code ajoute les objets du volet Actions à la collection Controls et masque les objets. Le code Visual C# attache également les délégués à plusieurs événements de contrôle du ruban.

private void MyRibbon_Load(object sender, RibbonUIEventArgs e)
{
    Globals.ThisWorkbook.ActionsPane.Controls.Add(actionsPane1);
    Globals.ThisWorkbook.ActionsPane.Controls.Add(actionsPane2);
    actionsPane1.Hide();
    actionsPane2.Hide();
    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = false;

    this.button1.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(
        this.button1_Click);
    this.button2.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(
        this.button2_Click);
    this.toggleButton1.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(
        this.toggleButton1_Click);


}

Private Sub MyRibbon_Load(ByVal sender As System.Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonUIEventArgs) Handles MyBase.Load
    Globals.ThisWorkbook.ActionsPane.Controls.Add(actionsPane1)
    Globals.ThisWorkbook.ActionsPane.Controls.Add(actionsPane2)
    actionsPane1.Hide()
    actionsPane2.Hide()
    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = False
End Sub

Ajoutez les trois méthodes de gestionnaire d'événements suivantes à la classe MyRibbon. Ces méthodes gèrent les événements Click des deux boutons et l'événement Click du bouton bascule. Les gestionnaires d'événements pour button1 et button2 affichent d'autres volets Actions. Le gestionnaire d'événements pour toggleButton1 affiche et masque le volet Actions actif.

private void button1_Click(object sender, RibbonControlEventArgs e)
{
    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = true;
    actionsPane2.Hide();
    actionsPane1.Show();
    toggleButton1.Checked = false;
}

private void button2_Click(object sender, RibbonControlEventArgs e)
{
    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = true;
    actionsPane1.Hide();
    actionsPane2.Show();
    toggleButton1.Checked = false;

}

private void toggleButton1_Click(object sender, RibbonControlEventArgs e)
{
    if (toggleButton1.Checked == true)
    {
        Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = false;
    }
    else
    {
        Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = true;
    }

}

Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles Button1.Click
    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = True
    actionsPane2.Hide()
    actionsPane1.Show()
    ToggleButton1.Checked = False
End Sub

Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles Button2.Click

    Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = True
    actionsPane1.Hide()
    actionsPane2.Show()
    ToggleButton1.Checked = False

End Sub


Private Sub ToggleButton1_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles ToggleButton1.Click

    If ToggleButton1.Checked Then
        Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = False
    Else
        Globals.ThisWorkbook.Application.DisplayDocumentActionTaskPane = True
    End If

End Sub

Tester l’onglet personnalisé

Lorsque vous exécutez le projet, Excel démarre et l’onglet Mon onglet Onglet personnalisé s’affiche sur le ruban. Choisissez les boutons de Mon onglet personnalisé pour afficher et masquer les volets Actions.

Pour tester l'onglet personnalisé

Appuyez sur F5 pour exécuter votre projet.
Sélectionnez l’onglet Mes onglets personnalisés.
Dans le groupe Gestionnaire de volet Actions personnalisées, choisissez Afficher le volet Actions 1.

Le volet Actions s’affiche et affiche l’étiquette Actions Pane 1.
Choisissez Afficher le volet Actions 2.

Le volet Actions s’affiche et affiche l’étiquette Actions Pane 2.
Sélectionnez Masquer le volet Actions.

Les volets Actions ne sont plus visibles.

Étapes suivantes

Pour plus d'informations sur la personnalisation de l'interface utilisateur d'Office, consultez les rubriques suivantes :

Ajouter une interface utilisateur contextuelle à une personnalisation au niveau du document. Pour plus d’informations, consultez la vue d’ensemble du volet Actions.
Étendre un formulaire Microsoft Office standard ou personnalisé. Pour plus d’informations, consultez Procédure pas à pas : Concevoir une zone de formulaire Outlook.