Export (0) Print
Expand All

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

The Window type exposes the following members.

  NameDescription
Public propertyAutoHidesGets or sets whether the tool window is able to be hidden.
Public propertyCaptionGets or sets the title of the window.
Public propertyCollectionGets the collection containing the Window object supporting this property.
Public propertyContextAttributesGets 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.
Public propertyDocumentGets the Document object associated with the item, if one exists.
Public propertyDocumentDataInfrastructure. Microsoft Internal Use Only.
Public propertyDTEGets the top-level extensibility object.
Public propertyHeightGets or sets a value indicating the dimensions of the window in pixels.
Public propertyHWndInfrastructure. Microsoft Internal Use Only.
Public propertyIsFloatingGets or sets a value indicating whether the tool window is floating over other windows.
Public propertyKindGets a string indicating the type of window.
Public propertyLeftGets or sets the distance between the internal left edge of an object and the left edge of its container.
Public propertyLinkableGets or sets a value indicating whether the tool window can be docked with other tool windows.
Public propertyLinkedWindowFrameGets a Window object representing the window frame containing the window.
Public propertyLinkedWindowsGets a collection of all linked windows contained in the linked window frame.
Public propertyObjectGets an object that can be accessed by name at run time.
Public propertyObjectKindGets the type of the Window object, which is a GUID string representing the tool contained in the window.
Public propertyProjectGets the Project object associated with the Window object.
Public propertyProjectItemGets the ProjectItem object associated with the Window object.
Public propertySelectionGets an object representing the current selection on the Window object.
Public propertyTopGets or sets the distance between the internal top edge of an object and the top edge of its container.
Public propertyTypeInfrastructure. Microsoft Internal Use Only.
Public propertyVisibleGets or sets the visibility of a window.
Public propertyWidthGets or sets the width of the window in character units.
Public propertyWindowStateGets or sets the state, such as minimized, normal, and so forth, of the window.
Top

  NameDescription
Public methodActivateMoves the focus to the current item.
Public methodAttachInfrastructure. Microsoft Internal Use Only.
Public methodCloseCloses the open document and optionally saves it, or closes and destroys the window.
Public methodDetachInfrastructure. Microsoft Internal Use Only.
Public methodSetFocusInfrastructure. Microsoft Internal Use Only.
Public methodSetKindInfrastructure. Microsoft Internal Use Only.
Public methodSetSelectionContainerAllows setting objects to be active in the Properties window when this window is active.
Public methodSetTabPictureSets the picture to display in a tool window.
Top

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

Community Additions

ADD
Show:
© 2014 Microsoft