Window Interface

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

The Window object represents a window in the environment.

public interface class Window

public interface class Window

__interface Window

[System.Runtime.InteropServices.Guid("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Window

[<System.Runtime.InteropServices.Guid("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Window = interface

Public Interface Window

Derived

EnvDTE80.Window2

Attributes

GuidAttribute TypeLibTypeAttribute

Examples

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  

Properties

AutoHides	Gets or sets whether the tool window is able to be hidden.
Caption	Gets or sets the title of the window.
Collection	Gets the collection containing the Window object supporting this property.
ContextAttributes	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.
Document	Gets the Document object associated with the item, if one exists.
DocumentData[String]	Microsoft Internal Use Only.
DTE	Gets the top-level extensibility object.
Height	Gets or sets a value indicating the dimensions of the window in pixels.
HWnd	Microsoft Internal Use Only.
IsFloating	Gets or sets a value indicating whether the tool window is floating over other windows.
Kind	Gets a string indicating the type of window.
Left	Gets or sets the distance between the internal left edge of an object and the left edge of its container.
Linkable	Gets or sets a value indicating whether the tool window can be docked with other tool windows.
LinkedWindowFrame	Gets a Window object representing the window frame containing the window.
LinkedWindows	Gets a collection of all linked windows contained in the linked window frame.
Object	Gets an object that can be accessed by name at run time.
ObjectKind	Gets the type of the Window object, which is a GUID string representing the tool contained in the window.
Project	Gets the Project object associated with the Window object.
ProjectItem	Gets the ProjectItem object associated with the Window object.
Selection	Gets an object representing the current selection on the Window object.
Top	Gets or sets the distance between the internal top edge of an object and the top edge of its container.
Type	Microsoft Internal Use Only.
Visible	Gets or sets the visibility of a window.
Width	Gets or sets the width of the window in character units.
WindowState	Gets or sets the state, such as minimized, normal, and so forth, of the window.

Methods

Activate()	Moves the focus to the current item.
Attach(IntPtr)
Close(vsSaveChanges)	Closes the open document and optionally saves it, or closes and destroys the window.
Detach()	Microsoft Internal Use Only.
SetFocus()	Microsoft Internal Use Only.
SetKind(vsWindowType)	Microsoft Internal Use Only.
SetSelectionContainer(Object[])	Allows setting objects to be active in the Properties window when this window is active.
SetTabPicture(Object)	Sets the picture to display in a tool window.