Package.CreateToolWindow Method (Type, Int32)

 

Creates a tool window of the specified type with the specified ID.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

abstract CreateToolWindow : 
        toolWindowType:Type *
        id:int -> WindowPane
override CreateToolWindow : 
        toolWindowType:Type *
        id:int -> WindowPane

Parameters

toolWindowType
Type: System.Type

The type of tool window to create.

id
Type: System.Int32

The tool window ID. This is 0 for a single-instance tool window.

Return Value

Type: Microsoft.VisualStudio.Shell.WindowPane

An instance of the requested tool window.

Exception Condition
ArgumentNullException

toolWindowType is null.

ArgumentException
  • id is less than 0.

  • toolWindowType is not derived from ToolWindowPane type.

The CreateToolWindow method creates an instance of the given tool window. This is used within the Package base class when implementing the Visual Studio interface tool window creation code as well as the FindToolWindow method.

Return to top
Show: