Sdílet prostřednictvím

CustomTaskPaneCollection.Add – metoda (UserControl, String)

  • Článek

Vytvoří nový CustomTaskPane a přidá ji do aktuální CustomTaskPaneCollection. Vlastní úloha podokno je založena na určeném UserControl a má zadaného názvu.

Obor názvů:  Microsoft.Office.Tools
Sestavení:  Microsoft.Office.Tools.Common (v Microsoft.Office.Tools.Common.dll)

Syntaxe

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

CustomTaskPane Add(
    UserControl control,
    string title
)

Parametry

  • title
    Typ: System.String
    Text zobrazený v nové úlohapodokno záhlaví .

Vrácená hodnota

Typ: Microsoft.Office.Tools.CustomTaskPane
A CustomTaskPane , představuje nové vlastní úloha podokno.

Výjimky

Výjimka Podmínka
ArgumentNullException

controlor title is nullodkaz Null (Nothing v jazyce Visual Basic).
ObjectDisposedException

Dispose()Na již byla volánametoda CustomTaskPaneCollection.

Poznámky

Použít této metoda vytvořit nový CustomTaskPane je spojeno s aktivní oknoaplikacesady systém Microsoft Office.

Ačkoli CustomTaskPaneCollection objekt je kolekce CustomTaskPane objekty, Add metoda přijímá UserControl objekty namísto CustomTaskPane objektů. Další informace naleznete v tématu Custom Task Panes Overview.

Pokud chcete určit konkrétní okno a přidružit vlastní úloha podokno , použijte Add(UserControl, String, Object) metoda.

Příklady

Následující příklad kódu ukazuje, jak vytvořit vlastní úloha podokno pomocí Add(UserControl, String) metoda. Příklad používá také vlastnosti CustomTaskPane objekt upravit výchozí vzhled úloha podokno. Příklad kódu je součástí větší příklad k 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);
}

Zabezpečení rozhraní .NET Framework

Viz také

Odkaz

CustomTaskPaneCollection Rozhraní

Add – přetížení

Microsoft.Office.Tools – obor názvů