Sdílet prostřednictvím

CustomTaskPaneCollection.Add – metoda (UserControl, String)

  • Článek

Vytvoří nový CustomTaskPane a přidá ji do aktuální CustomTaskPaneCollection.Vlastní podokno úloh je založen na zadané UserControl a má zadaný název.

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 záhlaví nové vlastní podokno úloh.

Vrácená hodnota

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

Výjimky

Výjimka Podmínka
ArgumentNullException

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

Dispose Již byla volána metoda na CustomTaskPaneCollection.

Poznámky

Tuto metodu použijte, chcete-li vytvořit nový CustomTaskPane je spojeno s aktivní okno aplikace Microsoft Office.

I když CustomTaskPaneCollection objekt je kolekce CustomTaskPane objekty, Add metoda přijímá UserControl objekty namísto CustomTaskPane objekty.Další informace naleznete v tématu Vlastní podokna úloh.

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

Příklady

Následující příklad kódu ukazuje, jak vytvořit vlastní podokno úloh pomocí Add(UserControl, String) metody.Příklad také používá vlastnosti CustomTaskPane objekt, který chcete změnit výchozí vzhled vlastní podokno úloh.Tento příklad kódu je součástí většího příkladu určeného pro 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é

Referenční dokumentace

CustomTaskPaneCollection Rozhraní

Add – přetížení

Microsoft.Office.Tools – obor názvů