Udostępnij za pośrednictwem


Window Interface

The Window object represents a window in the environment.

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

Syntax

'Declaration
<GuidAttribute("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")> _
Public Interface Window
[GuidAttribute("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")]
public interface Window
[GuidAttribute(L"0BEAB46B-4C07-4F94-A8D7-1626020E4E53")]
public interface class Window
[<GuidAttribute("0BEAB46B-4C07-4F94-A8D7-1626020E4E53")>]
type Window =  interface end
public interface Window

The Window type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method Activate Moves the focus to the current item.
Public method Attach Infrastructure. Microsoft Internal Use Only.
Public method Close Closes the open document and optionally saves it, or closes and destroys the window.
Public method Detach Infrastructure. Microsoft Internal Use Only.
Public method SetFocus Infrastructure. Microsoft Internal Use Only.
Public method SetKind Infrastructure. Microsoft Internal Use Only.
Public method SetSelectionContainer Allows setting objects to be active in the Properties window when this window is active.
Public method SetTabPicture Sets the picture to display in a tool window.

Top

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

See Also

Reference

EnvDTE Namespace