通过

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 命名空间