Procédure pas à pas : synchronisation d'un volet de tâches personnalisé avec un bouton dans le ruban

Article
03/04/2013

Cette procédure pas à pas indique comment créer un volet de tâches 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 de tâches 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 de tâches personnalisés.

S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau application pour Outlook 2013 et Outlook 2010. Pour en savoir plus, consultez Fonctionnalités disponibles par type d'application et de projet Office.

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

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

Conception de l'interface utilisateur du volet de tâches personnalisé.
Ajout d'un bouton bascule au ruban.
Synchronisation du bouton bascule avec le volet de tâches 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.Ces éléments dépendent de l'édition de Visual Studio dont vous disposez et des paramètres que vous utilisez.Pour plus d’informations, consultez Paramètres Visual Studio.

Composants requis

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :

Une édition de Visual Studio 2012 qui inclut les outils de développement Microsoft Office. Pour plus d'informations, consultez [Configuration d'un ordinateur pour développer des solutions Office](bb398242\(v=vs.110\).md).

Microsoft Excel 2010 ou Microsoft Excel 2013.

Création du projet de complément

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

Pour créer un projet

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 Comment : créer des projets Office dans Visual Studio.

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

Ajout d'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 de tâches personnalisé, vous pouvez ajouter un bouton bascule du ruban qui permet d'afficher et de masquer le volet de tâches.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

Dans le menu Projet, cliquez sur 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 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.
Dans le Concepteur de ruban, cliquez sur group1.
Dans la fenêtre Propriétés, définissez la propriété Label sur la valeur Gestionnaire de volets de tâches.
Dans l'onglet Contrôles de ruban Office de la boîte à outils, faites glisser un contrôle ToggleButton dans le groupe Gestionnaire de volets de tâches.
Cliquez sur toggleButton1.
Dans la fenêtre Propriétés, définissez la propriété Label sur la valeur Afficher le Volet Office.

Conception de l'interface utilisateur du volet de tâches personnalisé

Il n'existe pas de concepteur visuel pour les volets de tâches personnalisés, mais 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 de tâches personnalisé.

Pour concevoir l'interface utilisateur du volet de tâches personnalisé

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

Le contrôle utilisateur s'affiche dans le concepteur.
Dans l'onglet Contrôles communs de la boîte à outils, faites glisser un contrôle TextBox vers le contrôle utilisateur.

Création du volet de tâches personnalisé

Pour créer le volet de tâches personnalisé lors du démarrage du complément, ajoutez le contrôle utilisateur au volet de tâches dans le gestionnaire d'événements Startup du complément.Par défaut, le volet de tâches personnalisé n'est pas visible.À une étape ultérieure de cette procédure pas à pas, vous ajouterez du code qui permet d'afficher ou de masquer le volet de tâches lorsque l'utilisateur clique sur le bouton bascule ajouté au ruban.

Pour créer le volet de tâches personnalisé

Dans l'Explorateur de solutions, développez Excel.
Cliquez avec le bouton droit sur ThisAddIn.cs ou ThisAddIn.vb, puis cliquez sur Afficher le code.

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

Private taskPaneControl1 As TaskPaneControl
Private WithEvents taskPaneValue As Microsoft.Office.Tools.CustomTaskPane

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

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 de tâches personnalisé (par défaut, la propriété Visible de la classe CustomTaskPane a la valeur false).Le code Visual C# attache également un gestionnaire d'événements à l'événement VisibleChanged.

Private Sub ThisAddIn_Startup(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles Me.Startup

    taskPaneControl1 = New TaskPaneControl()
    taskPaneValue = Me.CustomTaskPanes.Add( _
        taskPaneControl1, "MyCustomTaskPane")
End Sub

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

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

Private Sub taskPaneValue_VisibleChanged(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles taskPaneValue.VisibleChanged

    Globals.Ribbons.ManageTaskPaneRibbon.ToggleButton1.Checked = taskPaneValue.Visible
End Sub

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

Ajoutez la propriété suivante à la classe ThisAddIn.Cette propriété expose l'objet privé myCustomTaskPane1 à d'autres classes.À une étape ultérieure de cette procédure pas à pas, vous ajouterez du code à la classe MyRibbon qui utilise cette propriété.
```
Public ReadOnly Property TaskPane() As Microsoft.Office.Tools.CustomTaskPane
    Get
        Return taskPaneValue
    End Get
End Property
```
```
public Microsoft.Office.Tools.CustomTaskPane TaskPane
{
    get
    {
        return taskPaneValue;
    }
}
```

Masquage et affichage du volet de tâches personnalisé à l'aide du bouton bascule

La dernière étape consiste à ajouter du code qui permet d'afficher ou de masquer le volet de tâches personnalisé lorsque l'utilisateur clique sur le bouton bascule du ruban.

Pour afficher et masquer le volet de tâches personnalisé à l'aide du bouton bascule

Dans le Concepteur de ruban, double-cliquez sur le bouton bascule Afficher le Volet de tâches.

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.

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 de tâches personnalisé, selon l'état du bouton bascule (activé ou désactivé).

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

    Globals.ThisAddIn.TaskPane.Visible = _
        TryCast(sender, Microsoft.Office.Tools.Ribbon.RibbonToggleButton).Checked
End Sub

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

Test du complément

Lorsque vous exécutez le projet, Excel s'ouvre sans afficher le volet de tâches personnalisé.Cliquez sur le bouton bascule du ruban pour tester le code.

Pour tester votre complément

Appuyez sur F5 pour exécuter votre projet.

Assurez-vous qu'Excel s'ouvre et que l'onglet Compléments s'affiche sur le ruban.
Cliquez sur l'onglet Compléments du ruban.
Dans le groupe Gestionnaire de volets de tâches, cliquez sur le bouton bascule Afficher le Volet de tâches.

Assurez-vous que le volet de tâches s'affiche et se masque en alternance lorsque vous cliquez sur le bouton bascule.
Lorsque le volet de tâches est visible, cliquez sur le bouton Fermer (X) dans l'angle du volet de tâches.

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

Étapes suivantes

Pour en savoir plus sur la création de volets de tâches personnalisés, consultez les rubriques ci-dessous :

Créer un volet de tâches personnalisé dans un complément pour une autre application.Pour plus d'informations sur les applications prenant en charge les volets de tâches personnalisés, consultez Volets de tâches personnalisés.
Automatiser une application à partir d'un volet de tâches personnalisé.Pour plus d’informations, consultez Procédure pas à pas : automatisation d'une application à partir d'un volet de tâches personnalisé.
Créer un volet de tâches personnalisé pour chaque message électronique ouvert dans Outlook.Pour plus d’informations, consultez Procédure pas à pas : affichage de volets de tâches personnalisés avec des messages électroniques dans Outlook.