Windows.CreateToolWindow Method

Creates a new tool window containing the specified Document object or ActiveX control.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function CreateToolWindow ( _
    AddInInst As AddIn, _
    ProgID As String, _
    Caption As String, _
    GuidPosition As String, _
    <OutAttribute> ByRef DocObj As Object _
) As Window
Window CreateToolWindow(
    AddIn AddInInst,
    string ProgID,
    string Caption,
    string GuidPosition,
    out Object DocObj
)
Window^ CreateToolWindow(
    [InAttribute] AddIn^ AddInInst, 
    [InAttribute] String^ ProgID, 
    [InAttribute] String^ Caption, 
    [InAttribute] String^ GuidPosition, 
    [InAttribute] [OutAttribute] Object^% DocObj
)
abstract CreateToolWindow : 
        AddInInst:AddIn * 
        ProgID:string * 
        Caption:string * 
        GuidPosition:string * 
        DocObj:Object byref -> Window
function CreateToolWindow(
    AddInInst : AddIn, 
    ProgID : String, 
    Caption : String, 
    GuidPosition : String, 
    DocObj : Object
) : Window

Parameters

  • AddInInst
    Type: EnvDTE.AddIn

    Required. An AddIn object whose lifetime determines the lifetime of the tool window.

  • Caption
    Type: System.String

    Required. The caption for the new tool window.

  • GuidPosition
    Type: System.String

    Required. A unique identifier for the new tool window, which can be used as an index to Item.

Return Value

Type: EnvDTE.Window
A Window object.

Remarks

If you attempt to set any of the visibility states of the new tool window — such as height, width, or position — before the tool window is visible, you get an error. Therefore, make sure that the window is visible before attempting to set any such properties.

For information about creating ActiveX controls, see Creating an MFC ActiveX Control.

.NET Framework Security

See Also

Reference

Windows Interface

EnvDTE Namespace