Freigeben über

CustomTaskPaneCollection.Add-Methode (UserControl, String)

  • Artikel

Erstellt einen neuen CustomTaskPane und fügt ihn der aktuellen CustomTaskPaneCollection hinzu. Der benutzerdefinierte Aufgabenbereich basiert auf dem angegebenen UserControl und verfügt über den angegebenen Titel.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Syntax

'Declaration
Function Add ( _
    control As UserControl, _
    title As String _
) As CustomTaskPane

CustomTaskPane Add(
    UserControl control,
    string title
)

Parameter

  • title
    Typ: System.String
    Der Text, der in der Titelleiste des neuen benutzerdefinierten Aufgabenbereichs angezeigt wird.

Rückgabewert

Typ: Microsoft.Office.Tools.CustomTaskPane
Ein CustomTaskPane, der den neuen benutzerdefinierten Aufgabenbereich darstellt.

Ausnahmen

Ausnahme Bedingung
ArgumentNullException

control oder title ist nullNULL-Verweis (Nothing in Visual Basic).
ObjectDisposedException

Die Dispose()-Methode wurde bereits für die CustomTaskPaneCollection aufgerufen.

Hinweise

Verwenden Sie diese Methode, um einen neuen CustomTaskPane zu erstellen, der dem aktiven Fenster der Microsoft Office-Anwendung zugeordnet ist.

Obwohl ein CustomTaskPaneCollection-Objekt eine Auflistung von CustomTaskPane-Objekten ist, akzeptiert die Add-Methode UserControl-Objekte anstelle von CustomTaskPane-Objekten. Weitere Informationen finden Sie unter Übersicht über benutzerdefinierte Aufgabenbereiche.

Wenn Sie ein bestimmtes Fenster angeben und ihm den benutzerdefinierten Aufgabenbereich zuordnen möchten, verwenden Sie die Add(UserControl, String, Object)-Methode.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie mithilfe der Add(UserControl, String)-Methode ein benutzerdefinierter Aufgabenbereich erstellt wird. In diesem Beispiel werden zudem Eigenschaften des CustomTaskPane-Objekts verwendet, um die Standarddarstellung des benutzerdefinierten Aufgabenbereichs zu ändern. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels zu 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);
}

.NET Framework-Sicherheit

Siehe auch

Referenz

CustomTaskPaneCollection Schnittstelle

Add-Überladung

Microsoft.Office.Tools-Namespace