CustomTaskPaneCollection.Add 方法 (UserControl, String)

  • 發行項

建立新的 CustomTaskPane，並將它加入至目前的 CustomTaskPaneCollection。 自訂工作窗格是以指定的 UserControl 做為基礎，並具有指定的標題。

命名空間：  Microsoft.Office.Tools
組件：  Microsoft.Office.Tools.Common (在 Microsoft.Office.Tools.Common.dll 中)

語法

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

CustomTaskPane Add(
    UserControl control,
    string title
)

參數

  • title
    型別：System.String
    出現在新自訂工作窗格標題列中的文字。

傳回值

型別：Microsoft.Office.Tools.CustomTaskPane
代表新自訂工作窗格的 CustomTaskPane。

例外狀況

例外狀況 條件
ArgumentNullException

control 或 title 是 nullNull 參照 (即 Visual Basic 中的 Nothing)。
ObjectDisposedException

已經在 CustomTaskPaneCollection 上呼叫過 Dispose() 方法。

備註

請使用此方法建立與 Microsoft Office 應用程式使用中視窗關聯的新 CustomTaskPane。

雖然 CustomTaskPaneCollection 物件是 CustomTaskPane 物件的集合，但是 Add 方法會接受 UserControl 物件，而不是 CustomTaskPane 物件。 如需詳細資訊，請參閱自訂工作窗格概觀。

如果要指定特定的視窗，並使自訂工作窗格與它產生關聯，請使用 Add(UserControl, String, Object) 方法。

範例

下列程式碼範例示範如何使用 Add(UserControl, String) 方法建立自訂工作窗格。 此範例也使用 CustomTaskPane 物件的屬性來修改自訂工作窗格的預設外觀。 這個程式碼範例是 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 安全性

請參閱

參考

CustomTaskPaneCollection 介面

Add 多載

Microsoft.Office.Tools 命名空間