Window Interface

 

The Window object represents a window in the environment.

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

[GuidAttribute("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")]
public interface Window

NameDescription
System_CAPS_pubpropertyAutoHides

Gets or sets whether the tool window is able to be hidden.

System_CAPS_pubpropertyCaption

Gets or sets the title of the window.

System_CAPS_pubpropertyCollection

Gets the collection containing the Window object supporting this property.

System_CAPS_pubpropertyContextAttributes

Gets a ContextAttributes collection which allows automation clients to add new attributes to the current selected items in the Dynamic Help window and provide contextual help for the additional attributes.

System_CAPS_pubpropertyDocument

Gets the Document object associated with the item, if one exists.

System_CAPS_pubpropertyDocumentData[String]

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyHeight

Gets or sets a value indicating the dimensions of the window in pixels.

System_CAPS_pubpropertyHWnd

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyIsFloating

Gets or sets a value indicating whether the tool window is floating over other windows.

System_CAPS_pubpropertyKind

Gets a string indicating the type of window.

System_CAPS_pubpropertyLeft

Gets or sets the distance between the internal left edge of an object and the left edge of its container.

System_CAPS_pubpropertyLinkable

Gets or sets a value indicating whether the tool window can be docked with other tool windows.

System_CAPS_pubpropertyLinkedWindowFrame

Gets a Window object representing the window frame containing the window.

System_CAPS_pubpropertyLinkedWindows

Gets a collection of all linked windows contained in the linked window frame.

System_CAPS_pubpropertyObject

Gets an object that can be accessed by name at run time.

System_CAPS_pubpropertyObjectKind

Gets the type of the Window object, which is a GUID string representing the tool contained in the window.

System_CAPS_pubpropertyProject

Gets the Project object associated with the Window object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the Window object.

System_CAPS_pubpropertySelection

Gets an object representing the current selection on the Window object.

System_CAPS_pubpropertyTop

Gets or sets the distance between the internal top edge of an object and the top edge of its container.

System_CAPS_pubpropertyType

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyVisible

Gets or sets the visibility of a window.

System_CAPS_pubpropertyWidth

Gets or sets the width of the window in character units.

System_CAPS_pubpropertyWindowState

Gets or sets the state, such as minimized, normal, and so forth, of the window.

NameDescription
System_CAPS_pubmethodActivate()

Moves the focus to the current item.

System_CAPS_pubmethodAttach(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodClose(vsSaveChanges)

Closes the open document and optionally saves it, or closes and destroys the window.

System_CAPS_pubmethodDetach()

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodSetFocus()

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodSetKind(vsWindowType)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodSetSelectionContainer(Object[])

Allows setting objects to be active in the Properties window when this window is active.

System_CAPS_pubmethodSetTabPicture(Object)

Sets the picture to display in a tool window.

Sub WindowExample()
   Dim Frame As Window
   Dim w1 As Window = DTE.Windows.Item(Constants.vsWindowKindSolutionExplorer)
   Dim w2 As Window = DTE.Windows.Item(Constants.vsWindowKindOutput)
   Dim w3 As Window = DTE.Windows.Item(Constants.vsWindowKindCommandWindow)

   ' Create a linked window frame and dock Solution Explorer 
   ' and Ouput window together inside it.
   Frame = DTE.Windows.CreateLinkedWindowFrame(w1, w2, vsLinkedWindowType.vsLinkedWindowTypeDocked)
   MsgBox("Total number of windows in the linked window frame: " & Frame.LinkedWindows.Count)

   ' Add another tool window, the Command window, to the frame with 
   ' the other two.
   Frame.LinkedWindows.Add(w3)
   MsgBox("Total number of windows in the linked window frame: " & Frame.LinkedWindows.Count)

   ' Resize the entire linked window frame.
   Frame.Width = 500
   Frame.Height = 600
   MsgBox("Frame height and width changed. Now changing Command window height.")

   ' Resize the height of the Command window.
   Frame.LinkedWindows.Item(3).Height = 800
   MsgBox("Now undocking the Command window from the frame.")

   ' Undock the Command window from the frame.
   Frame.LinkedWindows.Remove(w3)
End Sub
Return to top
Show: