Export (0) Print
Expand All

CustomTaskPaneCollection.Add Method (UserControl, String)

Creates a new CustomTaskPane and adds it to the current CustomTaskPaneCollection. The custom task pane is based on the specified UserControl and has the specified title.

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

CustomTaskPane Add(
	UserControl control,
	string title
)

Parameters

control
Type: System.Windows.Forms.UserControl

A UserControl that provides the user interface for the new custom task pane.

title
Type: System.String

The text that appears in the title bar of the new custom task pane.

Return Value

Type: Microsoft.Office.Tools.CustomTaskPane
A CustomTaskPane that represents the new custom task pane.

ExceptionCondition
ArgumentNullException

control or title is null.

ObjectDisposedException

The Dispose method has already been called on the CustomTaskPaneCollection.

Use this method to create a new CustomTaskPane that is associated with the active window of the Microsoft Office application.

Although a CustomTaskPaneCollection object is a collection of CustomTaskPane objects, the Add method accepts UserControl objects instead of CustomTaskPane objects. For more information, see Custom Task Panes.

If you want to specify a particular window and associate the custom task pane with it, use the Add(UserControl, String, Object) method.

The following code example demonstrates how to create a custom task pane by using the Add(UserControl, String) method. The example also uses properties of the CustomTaskPane object to modify the default appearance of the custom task pane. This code example is part of a larger example provided for CustomTaskPane.

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);
}

Show:
© 2014 Microsoft