CustomTaskPane, interface

Article
08/10/2011

Représente un volet Office personnalisé dans une application Microsoft Office.

Espace de noms : Microsoft.Office.Tools
Assembly : Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)

Syntaxe

'Déclaration
<GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")> _
Public Interface CustomTaskPane _
    Inherits IDisposable

[GuidAttribute("881b42fd-484d-4494-8500-779de4e4aac1")]
public interface CustomTaskPane : IDisposable

Le type CustomTaskPane expose les membres suivants.

Propriétés

	Nom	Description
	Control	Obtient le UserControl qui fournit l'interface utilisateur du volet Office personnalisé.
	DockPosition	Obtient ou définit une valeur qui spécifie l'emplacement du volet Office personnalisé par rapport à la fenêtre d'application.
	DockPositionRestrict	Obtient ou définit une valeur qui empêche l'ancrage du volet Office personnalisé à la position spécifiée.
	Height	Obtient ou définit la hauteur, en points, du volet Office personnalisé.
	Title	Obtient le titre du volet Office personnalisé.
	Visible	Obtient ou définit une valeur qui indique si le volet Office personnalisé est visible.
	Width	Obtient ou définit la largeur, en points, du volet Office personnalisé.
	Window	Obtient la fenêtre de document à laquelle est associé le volet Office personnalisé.

Début

Méthodes

	Nom	Description
	Dispose	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de IDisposable.)

Début

Événements

	Nom	Description
	DockPositionChanged	Se produit lorsque l'utilisateur modifie l'emplacement d'ancrage du volet Office personnalisé ou lorsque le code modifie la valeur de la propriété DockPosition.
	VisibleChanged	Se produit lorsque l'utilisateur affiche ou ferme le volet Office personnalisé ou lorsque le code modifie la valeur de la propriété Visible.

Début

Notes

Utilisez un objet CustomTaskPane dans un complément d'application pour modifier un volet de tâches personnalisé ou pour répondre lorsque l'emplacement ou la visibilité du volet de tâches personnalisé change. 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 d'application. Pour plus d'informations sur la création de volets de tâches personnalisés, consultez Vue d'ensemble des volets de tâches personnalisés.

Pour contrôler la taille ou l'emplacement du volet de tâches personnalisé, vous pouvez utiliser des propriétés telles que Height, Width et Visible.

Pour répondre lorsque le volet de tâches personnalisé se déplace ou change de visibilité, vous pouvez gérer les événements DockPositionChanged et VisibleChanged.

Notes

Cette interface est implémentée par Visual Studio Tools pour Office Runtime. Elle n'est pas destinée à être implémentée dans votre code. Pour plus d'informations, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent .NET Framework 4. Dans les projets qui ciblent .NET Framework 3.5, ce type peut contenir d'autres membres, et les exemples de code qui y figurent sont susceptibles de ne pas fonctionner. Pour obtenir de la documentation sur ce type dans les projets ciblant .NET Framework 3.5, consultez la section de référence suivante dans la documentation Visual Studio 2008 : https://go.microsoft.com/fwlink/?LinkId=160658.

Exemples

L'exemple de code suivant montre comment créer un volet de tâches personnalisé à l'aide de la méthode Add(UserControl, String). L'exemple utilise des propriétés de l'objet CustomTaskPane pour définir l'apparence par défaut du volet de tâches personnalisé et définit un gestionnaire d'événements pour l'événement DockPositionChanged. Pour compiler cet exemple, copiez le code dans la classe ThisAddIn, dans un projet de complément pour une application prenant en charge les volets de tâches personnalisés. Remplacez la méthode ThisAddIn_Startup par défaut dans la classe ThisAddIn par la méthode ThisAddIn_Startup dans cet exemple. Cet exemple suppose également que le projet contient un UserControl appelé MyUserControl et le UserControl, un FlowLayoutPanel appelé FlowPanel.

Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane

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

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

    With myCustomTaskPane
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
        .Height = 500
        .Width = 500
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
        .Width = 300
        .Visible = True
    End With
End Sub

Private Sub myCustomTaskPane_DockPositionChanged(ByVal sender As Object, _
    ByVal e As EventArgs) Handles myCustomTaskPane.DockPositionChanged

    Dim taskPane As Microsoft.Office.Tools.CustomTaskPane = _
        TryCast(sender, Microsoft.Office.Tools.CustomTaskPane)

    If taskPane IsNot Nothing Then

        ' Adjust sizes of user control and flow panel to fit current task pane size.
        Dim userControl As MyUserControl = TryCast(taskPane.Control, MyUserControl)
        Dim paneSize As System.Drawing.Size = _
            New System.Drawing.Size(taskPane.Width, taskPane.Height)
        userControl.Size = paneSize
        userControl.FlowPanel.Size = paneSize

        ' Adjust flow direction of controls on the task pane.
        If taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionTop Or _
            taskPane.DockPosition = _
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom Then

            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.LeftToRight
        Else
            userControl.FlowPanel.FlowDirection = _
                System.Windows.Forms.FlowDirection.TopDown
        End If
    End If
End Sub

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    myUserControl1 = new MyUserControl();
    myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
        "New Task Pane");

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
    myCustomTaskPane.Height = 500;
    myCustomTaskPane.Width = 500;

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionRight;
    myCustomTaskPane.Width = 300;

    myCustomTaskPane.Visible = true;
    myCustomTaskPane.DockPositionChanged +=
        new EventHandler(myCustomTaskPane_DockPositionChanged);
}

private void myCustomTaskPane_DockPositionChanged(object sender, EventArgs e)
{
    Microsoft.Office.Tools.CustomTaskPane taskPane =
        sender as Microsoft.Office.Tools.CustomTaskPane;

    if (taskPane != null)
    {
        // Adjust sizes of user control and flow panel to fit current task pane size.
        MyUserControl userControl = taskPane.Control as MyUserControl;
        System.Drawing.Size paneSize = new System.Drawing.Size(taskPane.Width, taskPane.Height);
        userControl.Size = paneSize;
        userControl.FlowPanel.Size = paneSize;

        // Adjust flow direction of controls on the task pane.
        if (taskPane.DockPosition == 
            Office.MsoCTPDockPosition.msoCTPDockPositionTop ||
            taskPane.DockPosition ==
            Office.MsoCTPDockPosition.msoCTPDockPositionBottom)
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.LeftToRight;
        }
        else
        {
            userControl.FlowPanel.FlowDirection =
                System.Windows.Forms.FlowDirection.TopDown;
        }
    }
}