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

  • Article

Cette procédure pas à pas montre comment créer un onglet ruban personnalisé à l’aide de l’élément Ruban (XML).

S’applique à : Les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document et aux projets de complément VSTO pour les applications suivantes : Excel ; InfoPath 2013 et InfoPath 2010 ; Outlook; Powerpoint; Projet; Visio; Mot. 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 :

  • Ajout de boutons à l’onglet Compléments . L’onglet Compléments est l’onglet par défaut défini dans le fichier XML du ruban.

  • Automatisation de Microsoft Bureau Word à l’aide des boutons de l’onglet Compléments.

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 :

Créer le projet

La première étape consiste à créer un projet de complément VSTO Word. Vous personnaliserez ultérieurement l’onglet Compléments de ce document.

Pour créer un projet

  1. Créez un projet de complément Word avec le nom MyRibbonAddIn.

    Pour plus d’informations, consultez Guide pratique pour créer des projets Bureau dans Visual Studio.

    Visual Studio ouvre le fichier de code ThisAddIn.cs ou ThisAddIn.vb et ajoute le projet MyRibbonAddIn à Explorateur de solutions.

Créer l’onglet Compléments VSTO

Pour créer l’onglet Compléments , ajoutez un élément de ruban (XML) à votre projet. À une étape ultérieure de cette procédure pas à pas, vous ajouterez des boutons à cet onglet.

Pour créer l’onglet Compléments

  1. Dans le menu Projet , cliquez sur Ajouter un nouvel élément.

  2. Dans la boîte de dialogue Ajouter un nouvel élément , sélectionnez Ruban (XML).

  3. Remplacez le nom du nouveau ruban par MyRibbon, puis cliquez sur Ajouter.

    Le fichier MyRibbon.cs ou MyRibbon.vb s’ouvre dans le concepteur. Un fichier XML nommé MyRibbon.xml est également ajouté à votre projet.

  4. Dans Explorateur de solutions, cliquez avec le bouton droit sur ThisAddin.cs ou ThisAddin.vb, puis cliquez sur Afficher le code.

  5. Ajoutez le code suivant à la classe ThisAddin . Ce code substitue la méthode CreateRibbonExtensibilityObject et retourne la classe Ribbon XML à l'application Office.

    protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

  6. Dans Explorateur de solutions, cliquez avec le bouton droit sur le projet MyRibbonAddIn, puis cliquez sur Générer. Vérifiez que le projet se génère sans erreur.

Ajouter des boutons à l’onglet Compléments

L'objectif de ce complément VSTO est de permettre aux utilisateurs d'ajouter du texte réutilisable et un tableau spécifique au document actif. Pour fournir l’interface utilisateur, ajoutez deux boutons à l’onglet Compléments en modifiant le fichier XML du ruban. À une étape ultérieure de cette procédure pas à pas, vous définirez des méthodes de rappel pour les boutons. Pour plus d’informations sur le fichier XML du ruban, consultez le fichier XML du ruban.

Pour ajouter des boutons à l’onglet Compléments

  1. Dans Explorateur de solutions, cliquez avec le bouton droit sur MyRibbon.xml, puis cliquez sur Ouvrir.

  2. Remplacez le contenu de l’élément tabulation par le code XML suivant. Ce code XML modifie l’étiquette du groupe de contrôles par défaut en contenu et ajoute deux nouveaux boutons avec les étiquettes Insérer du texte et insérer un tableau.

    <tab idMso="TabAddIns">
    <group id="ContentGroup" label="Content">
        <button id="textButton" label="Insert Text"
             screentip="Text" onAction="OnTextButton"
             supertip="Inserts text at the cursor location."/>
        <button id="tableButton" label="Insert Table"
             screentip="Table" onAction="OnTableButton"
             supertip="Inserts a table at the cursor location."/>
    </group>
</tab>

Automatiser le document à l’aide des boutons

Vous devez ajouter onAction des méthodes de rappel pour les boutons Insérer du texte et insérer un tableau pour effectuer des actions lorsque l’utilisateur clique dessus. Pour plus d’informations sur les méthodes de rappel pour les contrôles de ruban, consultez Le code XML du ruban.

Pour ajouter des méthodes de rappel pour les boutons

  1. Dans Explorateur de solutions, cliquez avec le bouton droit sur MyRibbon.cs ou MyRibbon.vb, puis cliquez sur Ouvrir.

  2. Ajoutez le code suivant en haut du fichier MyRibbon.cs ou MyRibbon.vb . Ce code crée un alias pour l'espace de noms Microsoft.Office.Interop.Word.

    using Word = Microsoft.Office.Interop.Word;

  3. Ajoutez la méthode suivante à la classe MyRibbon. Il s’agit d’une méthode de rappel pour le bouton Insérer du texte qui ajoute une chaîne au document actif à l’emplacement actuel du curseur.

    public void OnTextButton(Office.IRibbonControl control)
{
    Word.Range currentRange = Globals.ThisAddIn.Application.Selection.Range;
    currentRange.Text = "This text was added by the Ribbon.";
}

  4. Ajoutez la méthode suivante à la classe MyRibbon. Il s’agit d’une méthode de rappel pour le bouton Insérer une table qui ajoute une table au document actif à l’emplacement actuel du curseur.

    public void OnTableButton(Office.IRibbonControl control)
{
    object missing = System.Type.Missing;
    Word.Range currentRange = Globals.ThisAddIn.Application.Selection.Range;
    Word.Table newTable = Globals.ThisAddIn.Application.ActiveDocument.Tables.Add(
    currentRange, 3, 4, ref missing, ref missing);

    // Get all of the borders except for the diagonal borders.
    Word.Border[] borders = new Word.Border[6];
    borders[0] = newTable.Borders[Word.WdBorderType.wdBorderLeft];
    borders[1] = newTable.Borders[Word.WdBorderType.wdBorderRight];
    borders[2] = newTable.Borders[Word.WdBorderType.wdBorderTop];
    borders[3] = newTable.Borders[Word.WdBorderType.wdBorderBottom];
    borders[4] = newTable.Borders[Word.WdBorderType.wdBorderHorizontal];
    borders[5] = newTable.Borders[Word.WdBorderType.wdBorderVertical];

    // Format each of the borders.
    foreach (Word.Border border in borders)
    {
        border.LineStyle = Word.WdLineStyle.wdLineStyleSingle;
        border.Color = Word.WdColor.wdColorBlue;
    }
}

Test du complément VSTO

Lorsque vous exécutez le projet, Word s’ouvre et l’onglet nommé Compléments s’affiche sur le ruban. Cliquez sur les boutons Insérer du texte et insérer un tableau sous l’onglet Compléments pour tester le code.

Pour tester votre complément VSTO

  1. Appuyez sur F5 pour exécuter votre projet.

  2. Vérifiez que l’onglet Compléments est visible sur le ruban.

  3. Cliquez sur l'onglet Compléments .

  4. Vérifiez que le groupe de contenu est visible sur le ruban.

  5. Cliquez sur le bouton Insérer du texte dans le groupe Contenu.

    Une chaîne est ajoutée au document à l'emplacement actuel du curseur.

  6. Cliquez sur le bouton Insérer un tableau dans le groupe Contenu.

    Un tableau est ajouté au document à l'emplacement actuel du curseur.

Étapes suivantes

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

  • Personnalisez le ruban d’une autre application Office lication. Pour plus d’informations sur les applications qui prennent en charge la personnalisation du ruban, consultez la vue d’ensemble du ruban.

  • Personnalisez le ruban d’une application Office lication à l’aide du Concepteur de ruban. Pour plus d'informations, consultez Ribbon Designer.

  • Créer un volet Actions personnalisé. Pour plus d’informations, consultez la vue d’ensemble du volet Actions.

  • Personnaliser l'interface utilisateur de Microsoft Office Outlook à l'aide de zones de formulaire Outlook. Pour plus d’informations, consultez Procédure pas à pas : Concevoir une zone de formulaire Outlook.

Contenu connexe