CustomTaskPaneCollection.Add, méthode (UserControl, String)

Article
01/06/2014

Crée un nouveau CustomTaskPane et l'ajoute à la CustomTaskPaneCollection en cours. Le volet Office personnalisé est basé sur le UserControl spécifié et a le titre spécifié.

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

Syntaxe

'Déclaration
Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane

CustomTaskPane Add(
    UserControl control,
    string title
)

Paramètres

control
Type : System.Windows.Forms.UserControl
UserControl qui fournit l'interface utilisateur pour le nouveau volet Office personnalisé.

title
Type : System.String
Texte qui apparaît dans la barre de titre du nouveau volet Office personnalisé.

Valeur de retour

Type : Microsoft.Office.Tools.CustomTaskPane
CustomTaskPane qui représente le nouveau volet Office personnalisé.

Exceptions

Exception	Condition
ArgumentNullException	control ou title est nullune référence null (Nothing en Visual Basic).
ObjectDisposedException	La méthode Dispose a déjà été appelée dans la CustomTaskPaneCollection.

Notes

Utilisez cette méthode pour créer un nouveau CustomTaskPane associé à la fenêtre active de l'application Microsoft Office.

Bien qu'un objet CustomTaskPaneCollection soit une collection d'objets CustomTaskPane, la méthode Add accepte les objets UserControl au lieu des objets CustomTaskPane. Pour plus d'informations, consultez Volets de tâches personnalisés.

Si vous souhaitez spécifier une fenêtre particulière et lui associer le volet de tâches personnalisé, utilisez la méthode Add(UserControl, String, Object).

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 également des propriétés de l'objet CustomTaskPane pour modifier l'apparence par défaut du volet Office personnalisé. Cet exemple de code fait partie d'un exemple plus complet, fourni pour CustomTaskPane.

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 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);
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.