Windows::CreateToolWindow Method (AddIn^, String^, String^, String^, Object^)

 

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

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

Window^ CreateToolWindow(
	AddIn^ AddInInst,
	String^ ProgID,
	String^ Caption,
	String^ GuidPosition,
	Object^% DocObj
)

Parameters

AddInInst
Type: EnvDTE::AddIn^

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

ProgID
Type: System::String^

Required. The programmatic ID of the Document object or ActiveX control.

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.

DocObj
Type: System::Object^

Required. The Document object or control to be hosted in the tool window.

Return Value

Type: EnvDTE::Window^

A Window object.

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.

Return to top
Show: