Procédure pas à pas : synchroniser un volet Office personnalisé avec un bouton ruban

  • Article

Cette procédure pas à pas montre comment créer un volet Office personnalisé que les utilisateurs peuvent masquer ou afficher en cliquant sur un bouton bascule sur le ruban. Vous devez toujours créer un élément d’interface utilisateur, comme un bouton, sur lequel les utilisateurs peuvent cliquer pour afficher ou masquer le volet Office personnalisé. En effet, les applications Microsoft Office ne proposent aucune méthode par défaut permettant aux utilisateurs d’afficher ou de masquer des volets Office personnalisés.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets de complément VSTO pour Outlook. Pour plus d’informations, consultez Fonctionnalités disponibles par application Office lication et le type de projet.

Cette procédure pas à pas utilise spécifiquement Excel. Toutefois, les concepts qui y sont présentés sont applicables à toutes les applications susmentionnées.

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

  • Conception de l’interface utilisateur du volet Office personnalisé.

  • Ajout d’un bouton bascule au ruban.

  • Synchronisation du bouton bascule avec le volet Office 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 :

Créer le projet de complément

Dans cette étape, vous allez créer un projet de complément VSTO pour Excel.

Pour créer un projet

  1. Créez un projet de complément Excel nommé SynchroniserVoletOfficeEtRubanà l’aide du modèle de projet de complément Excel. 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 SynchronizeTaskPaneAndRibbon à Explorateur de solutions.

Ajouter un bouton bascule au ruban

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 permettre aux utilisateurs de contrôler le volet Office personnalisé, vous pouvez ajouter un bouton bascule au ruban permettant d’afficher et de masquer le volet Office. Pour créer un bouton bascule, 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 plus d’informations, consultez concepteur de ruban.

Pour ajouter un bouton bascule au ruban

  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 (Concepteur visuel).

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

    Le fichier ManageTaskPaneRibbon.cs ou ManageTaskPaneRibbon.vb s’ouvre dans le Concepteur de ruban et affiche un onglet et un groupe par défaut.

  4. Dans le Concepteur de ruban, cliquez sur group1.

  5. Dans la fenêtre Propriétés , définissez la propriété Label sur la valeur Gestionnaire de volets des tâches.

  6. Sous l’onglet Contrôles de ruban Office de la boîte à outils, faites glisser un contrôle ToggleButton dans le groupe Gestionnaire de volets Office .

  7. Cliquez sur toggleButton1.

  8. Dans la fenêtre Propriétés , affectez à la propriété Label la valeur Afficher le Volet Office.

Concevoir l’interface utilisateur du volet Office personnalisé

Il n’existe aucun concepteur visuel pour les volets Office personnalisés. Toutefois, vous pouvez concevoir un contrôle utilisateur avec la disposition de votre choix. À une étape ultérieure de cette procédure, vous ajouterez le contrôle utilisateur au volet des tâches personnalisé.

Pour concevoir l’interface utilisateur du volet Office personnalisé

  1. Dans le menu Projet , cliquez sur Ajouter un contrôle utilisateur.

  2. Dans la boîte de dialogue Ajouter un nouvel élément , remplacez le nom du nouveau contrôle utilisateur par ContrôleVoletOffice, puis cliquez sur Ajouter.

    Le contrôle utilisateur s'ouvre dans le concepteur.

  3. Sous l’onglet Contrôles communs de la boîte à outils, faites glisser un contrôle TextBox vers le contrôle utilisateur.

Créer le volet Office personnalisé

Pour créer le volet Office personnalisé au démarrage du complément VSTO, ajoutez le contrôle utilisateur au volet Office dans le gestionnaire d’événements Startup du complément VSTO. Par défaut, le volet Office personnalisé n’est pas visible. Plus loin dans cette procédure pas à pas, vous allez ajouter du code qui affichera ou masquera le volet Office lorsque l’utilisateur clique sur le bouton bascule que vous avez ajouté au ruban.

Pour créer le volet Office personnalisé

  1. Dans l' Explorateur de solutions, développez Excel.

  2. Cliquez avec le bouton droit sur ThisAddIn.cs ou ThisAddIn.vb , puis cliquez sur Afficher le code.

  3. Ajoutez le code suivant à la classe ThisAddIn . Ce code déclare une instance de TaskPaneControl en tant que membre de ThisAddIn.

    private TaskPaneControl taskPaneControl1;
private Microsoft.Office.Tools.CustomTaskPane taskPaneValue;

  4. Remplacez le gestionnaire d'événements ThisAddIn_Startup par le code suivant. Ce code ajoute l’objet TaskPaneControl au champ CustomTaskPanes , mais il n’affiche pas le volet Office personnalisé (par défaut, la propriété Visible de la classe CustomTaskPane a la valeur false). Le code Visual C# attache un gestionnaire d’événements à l’événement VisibleChanged .

    private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    taskPaneControl1 = new TaskPaneControl();
    taskPaneValue = this.CustomTaskPanes.Add(
        taskPaneControl1, "MyCustomTaskPane");
    taskPaneValue.VisibleChanged +=
        new EventHandler(taskPaneValue_VisibleChanged);
}

  5. Ajoutez la méthode suivante à la classe ThisAddIn. Cette méthode gère l’événement VisibleChanged . Lorsque l’utilisateur ferme le volet Office en cliquant sur le bouton Fermer (X), cette méthode met à jour l’état du bouton bascule sur le ruban.

    private void taskPaneValue_VisibleChanged(object sender, System.EventArgs e)
{
    Globals.Ribbons.ManageTaskPaneRibbon.toggleButton1.Checked = 
        taskPaneValue.Visible;
}

  6. Ajoutez la propriété suivante à la classe ThisAddIn . Cette propriété expose l’objet privé taskPaneValue à d’autres classes. Ultérieurement dans cette procédure, vous ajouterez du code à la classe MyRibbon qui utilise cette propriété.

    public Microsoft.Office.Tools.CustomTaskPane TaskPane
{
    get
    {
        return taskPaneValue;
    }
}

Masquer et afficher le volet Office personnalisé à l’aide du bouton bascule

La dernière étape consiste à ajouter du code permettant d’afficher ou masquer le volet Office personnalisé lorsque l’utilisateur clique sur le bouton bascule du ruban.

Pour afficher et masquer le volet Office personnalisé à l’aide du bouton bascule

  1. Dans le Concepteur de ruban, double-cliquez sur le bouton bascule Afficher le Volet Office .

    Visual Studio génère automatiquement un gestionnaire d’événements nommé toggleButton1_Click, qui gère l’événement Click du bouton bascule. Visual Studio ouvre également le fichier MyRibbon.cs ou MyRibbon.vb dans l’éditeur de code

  2. Remplacez le gestionnaire d'événements toggleButton1_Click par le code suivant. Lorsque l’utilisateur clique sur le bouton bascule, ce code affiche ou masque le volet Office personnalisé, selon l’état du bouton bascule (activé ou désactivé).

    private void toggleButton1_Click(object sender, RibbonControlEventArgs e)
{
    Globals.ThisAddIn.TaskPane.Visible = ((RibbonToggleButton)sender).Checked;
}

Tester le complément

Lorsque vous exécutez le projet, Excel s’ouvre sans afficher le volet Office personnalisé. Cliquez sur le bouton bascule du ruban pour tester le code.

Pour tester votre complément VSTO

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

    Vérifiez qu’Excel s’ouvre et que l’onglet Compléments s’affiche dans le ruban.

  2. Cliquez sur l’onglet Compléments du ruban.

  3. Dans le groupe Gestionnaire de volets de tâches , cliquez sur le bouton bascule Afficher le Volet Office .

    Vérifiez que le volet Office est alternativement affiché et masqué lorsque vous cliquez sur le bouton bascule.

  4. Lorsque le volet Office est visible, cliquez sur le bouton Fermer (X) dans le coin du volet Office.

    Vérifiez que le bouton bascule n’est pas enfoncé.

Étapes suivantes

Pour plus d’informations sur la création de volets Office personnalisés, consultez les rubriques suivantes :

Contenu connexe