Vue d'ensemble des volets de tâches personnalisés

Article
08/10/2011

Les volets de tâches sont des panneaux d'interface utilisateur généralement ancrés à l'un des côtés d'une fenêtre dans une application Microsoft Office. Les volets de tâches personnalisés vous permettent de créer votre propre volet de tâches et de fournir aux utilisateurs une interface familière pour accéder aux fonctionnalités de la solution. Par exemple, l'interface peut comporter des contrôles exécutant du code pour modifier des documents ou afficher des données à partir d'une source de données.

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

Notes

Les volets de tâches personnalisés sont différents du volet Actions. Le volet Actions fait quant à lui partie des personnalisations au niveau du document pour Microsoft Office Word et Microsoft Office Excel. Pour plus d'informations, consultez Vue d'ensemble du volet Actions.

Avantages des volets de tâches personnalisés

Les volets de tâches personnalisés vous permettent d'intégrer des fonctionnalités personnalisées à une interface utilisateur familière. Vous pouvez créer rapidement un volet de tâches personnalisé à l'aide des outils Visual Studio.

Interface utilisateur familière

Les utilisateurs des applications de Microsoft Office System ont déjà l'habitude d'utiliser les volets de tâches, comme le volet de tâches Styles et mise en forme de Word. Le comportement des volets de tâches personnalisés est identique à celui des autres volets de tâches de Microsoft Office System. Les utilisateurs peuvent ancrer les volets de tâches personnalisés aux différents côtés de la fenêtre d'application ou les faire glisser n'importe où dans la fenêtre. Vous pouvez créer un complément affichant simultanément plusieurs volets de tâches personnalisés. Les utilisateurs peuvent contrôler chacun de ces volets individuellement.

Prise en charge des Windows Forms

L'interface utilisateur d'un volet de tâches personnalisé que vous créez à l'aide des outils de développement Office dans Visual Studio est basée sur les contrôles Windows Forms. Le concepteur Windows Forms familier permet de concevoir l'interface utilisateur pour un volet de tâches personnalisé. Vous pouvez également utiliser la prise en charge de liaison de données dans Windows Forms pour effectuer une liaison d'une source de données aux contrôles dans le volet de tâches.

Création d'un volet de tâches personnalisé

Vous pouvez créer un volet de tâches personnalisé de base via les deux étapes suivantes :

Créez une interface utilisateur pour votre volet de tâches personnalisé en ajoutant des contrôles Windows Forms à un objet UserControl.
Instanciez le volet de tâches personnalisé en passant le contrôle utilisateur à l'objet CustomTaskPaneCollection dans votre complément. Cette collection retourne un nouvel objet CustomTaskPane que vous pouvez utiliser pour modifier l'apparence du volet de tâches et répondre aux événements d'utilisateur.

Pour une procédure pas à pas, consultez Comment : ajouter un volet de tâches personnalisé à une application.

Création de l'interface utilisateur

Tous les volets de tâches personnalisés créés à l'aide des outils de développement Office dans Visual Studio contiennent un objet UserControl. Ce contrôle utilisateur fournit l'interface utilisateur de votre volet de tâches personnalisé. Vous pouvez créer le contrôle utilisateur au moment du design ou de l'exécution. Si vous créez le contrôle utilisateur au moment du design, vous pouvez utiliser le concepteur Windows Forms pour construire l'interface utilisateur de votre volet de tâches.

Instanciation du volet de tâches personnalisé

Après avoir créé un contrôle utilisateur contenant l'interface utilisateur du volet de tâches personnalisé, vous devez instancier un CustomTaskPane. Pour ce faire, transférez le contrôle utilisateur à la CustomTaskPaneCollection de votre complément en appelant une des méthodes Add. Cette collection est exposée comme le champ CustomTaskPanes de la classe ThisAddIn. L'exemple de code suivant est destiné à être exécuté depuis la classe ThisAddIn.

myUserControl1 = New MyUserControl
myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "My Task Pane")
myCustomTaskPane.Visible = True

myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1, "My Task Pane");
myCustomTaskPane.Visible = true;

La méthode Add retourne un nouvel objet CustomTaskPane. Cet objet vous permet de modifier l'apparence du volet de tâches et de répondre aux événements utilisateur.

Contrôle du volet de tâches dans plusieurs fenêtres

Les volets de tâches personnalisés sont associés à une fenêtre frame de document, qui présente une vue d'un document ou d'un élément à l'utilisateur. Le volet de tâches n'est visible que lorsque la fenêtre associée est visible.

Pour déterminer quelles sont les fenêtres qui affichent le volet de tâches personnalisé, utilisez la surcharge de méthode Add appropriée lorsque vous créez le volet de tâches :

Pour associer le volet de tâches à la fenêtre active, utilisez la méthode CustomTaskPaneCollection.Add(UserControl, String).
Pour associer le volet de tâches à un document hébergé par une fenêtre spécifiée, utilisez la méthode CustomTaskPaneCollection.Add(UserControl, String, Object).

Certaines applications Office nécessitent des instructions explicites pour connaître le moment auquel créer ou afficher votre volet de tâches, lorsque plusieurs fenêtres sont ouvertes. Il est donc important de se demander où instancier le volet de tâches personnalisé dans votre code afin de vous assurer que le volet apparaîtra avec les documents et éléments appropriés dans l'application. Pour plus d'informations, consultez Gestion des volets de tâches personnalisés dans plusieurs fenêtres d'application.

Accès à l'application depuis le volet de tâches

Pour automatiser l'application à partir du contrôle utilisateur, vous pouvez directement accéder au modèle objet à l'aide de la classe Globals.ThisAddIn.Application de votre code. La classe Globals statique permet d'accéder à l'objet ThisAddIn. Le champ Application de cet objet est le point d'entrée dans le modèle objet de l'application.

Pour plus d'informations sur le champ Application de l'objet ThisAddIn, consultez Programmation de compléments d'application. Pour une procédure pas à pas montrant comment automatiser une application à partir d'un volet de tâches personnalisé, consultez Procédure pas à pas : automatisation d'une application à partir d'un volet de tâches personnalisé. Pour plus d'informations sur la classe Globals, consultez Accès global aux objets dans les projets Office.

Gestion de l'interface utilisateur du volet de tâches

Après avoir créé le volet de tâches, vous pouvez utiliser les propriétés et événements de l'objet CustomTaskPane pour contrôler l'interface utilisateur du volet et répondre quand l'utilisateur modifie le volet de tâches.

Affichage du volet de tâches personnalisé

Par défaut, le volet de tâches n'est pas visible. Pour qu'il soit visible, vous devez affecter la valeur true à la propriété Visible.

Les utilisateurs peuvent à tout moment fermer un volet de tâches en cliquant sur le bouton Fermer (X) situé dans le coin du volet. Toutefois, il n'existe aucune manière par défaut permettant de le rouvrir. Si un utilisateur ferme un volet de tâches personnalisé, il ne peut pas l'afficher de nouveau sauf si vous lui permettez de le faire.

Si vous créez un volet de tâches personnalisé dans votre complément, vous devez également créer un élément d'interface utilisateur, tel qu'un bouton, sur lequel les utilisateurs peuvent cliquer pour afficher ou masquer votre volet de tâches personnalisé. Si vous créez un volet de tâches personnalisé dans une application Microsoft Office prenant en charge la personnalisation du ruban, vous pouvez ajouter un groupe de contrôles au ruban à l'aide d'un bouton permettant d'afficher ou de masquer votre volet de tâches personnalisé. Pour obtenir une procédure pas à pas illustrant ce processus, consultez Procédure pas à pas : synchronisation d'un volet de tâches personnalisé avec un bouton dans le ruban.

Si vous créez un volet de tâches personnalisé dans une application Microsoft Office qui ne prend en charge la personnalisation du ruban, vous pouvez ajouter un CommandBarButton qui permet d'afficher ou de masquer votre volet de tâches personnalisé.

Modification de l'apparence du volet de tâches

Vous pouvez contrôler la taille et l'emplacement d'un volet de tâches personnalisé à l'aide des propriétés de l'objet CustomTaskPane. Vous pouvez apporter de nombreuses autres modifications à l'apparence d'un volet de tâches personnalisé à l'aide des propriétés de l'objet UserControl présent dans le volet de tâches personnalisé. Par exemple, vous pouvez spécifier une image d'arrière-plan pour un volet de tâches personnalisé à l'aide de la propriété BackgroundImage du contrôle utilisateur.

Le tableau suivant répertorie les modifications que vous pouvez apporter à un volet de tâches personnalisé à l'aide des propriétés CustomTaskPane.

Tâche	Propriété
Pour changer la taille du volet de tâches	Height Width
Pour changer l'emplacement du volet de tâches	DockPosition
Pour masquer ou afficher le volet de tâches	Visible
Pour empêcher l'utilisateur de modifier l'emplacement du volet de tâches	DockPositionRestrict

Programmation des événements d'un volet de tâches personnalisé

Vous souhaitez que votre complément réponde à toute modification de l'utilisateur dans le volet de tâches personnalisé. Par exemple, si l'utilisateur remplace l'orientation verticale du volet par une orientation horizontale, vous souhaitez repositionner les contrôles.

Le tableau suivant répertorie les événements que vous pouvez traiter pour répondre aux modifications apportées par l'utilisateur dans le volet de tâches personnalisé.

Tâche	Événement
Pour répondre lorsque l'utilisateur modifie l'emplacement du volet de tâches	DockPositionChanged
Pour répondre lorsque l'utilisateur affiche ou masque le volet de tâches	VisibleChanged

Nettoyage des ressources utilisées par le volet de tâches

Une fois un volet de tâches personnalisé créé, l'objet CustomTaskPane reste en mémoire aussi longtemps que votre complément fonctionne. L'objet reste encore en mémoire lorsque l'utilisateur a cliqué sur le bouton Fermer (X) situé dans le volet de tâches.

Pour nettoyer des ressources utilisées par le volet de tâches pendant que le complément s'exécute, utilisez les méthodes Remove ou RemoveAt. Ces méthodes suppriment l'objet CustomTaskPane spécifié de la collection CustomTaskPanes, et appellent la méthode Dispose() de l'objet.

Le Visual Studio Tools pour Office Runtime nettoie automatiquement les ressources utilisées par le volet de tâches personnalisé lorsque le complément est déchargé. N'appelez pas les méthodes Remove ou RemoveAt dans le gestionnaire d'événements ThisAddIn_Shutdown dans votre projet. Ces méthodes lèveront une ObjectDisposedException car le Visual Studio Tools pour Office Runtime nettoie les ressources utilisées par l'objet CustomTaskPane avant que ThisAddIn_Shutdown ne soit appelé. Pour plus d'informations sur ThisAddIn_Shutdown, consultez Événements dans les projets Office.