CustomTaskPaneCollection.Add Method (UserControl, String, Object)

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

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

Syntax

'Declaration
Function Add ( _
    control As UserControl, _
    title As String, _
    window As Object _
) As CustomTaskPane
CustomTaskPane Add(
    UserControl control,
    string title,
    Object window
)

Parameters

  • title
    Type: System.String
    The text that appears in the title bar of the new custom task pane.
  • window
    Type: System.Object
    An object that represents the application window to associate the new custom task pane with.

Return Value

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

Exceptions

Exception Condition
ArgumentNullException

control or title is nulla null reference (Nothing in Visual Basic).

ObjectDisposedException

The Dispose() method has already been called on the CustomTaskPaneCollection.

Remarks

Use this method to create a new CustomTaskPane that is associated with a specific application window. This method is useful if you want to create custom task panes that are visible with multiple Inspectors or Explorers in Outlook, or with multiple documents in Word or InfoPath. For more information, see Managing Custom Task Panes in Multiple Application Windows.

The type of the window parameter depends on the application. The following table lists the valid types of the window parameter.

Application

Parameter type

Word

Microsoft.Office.Interop.Word.Window

Excel

Microsoft.Office.Interop.Excel.Window

PowerPoint

Microsoft.Office.Interop.PowerPoint.DocumentWindow

InfoPath

Microsoft.Office.Interop.InfoPath.WindowObject

Outlook

Microsoft.Office.Interop.Outlook.Explorer

-or-

Microsoft.Office.Interop.Outlook.Inspector

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

.NET Framework Security

See Also

Reference

CustomTaskPaneCollection Interface

Add Overload

Microsoft.Office.Tools Namespace

Other Resources

Custom Task Panes Overview

Managing Custom Task Panes in Multiple Application Windows