LinkedWindows::Item Method (Object^)

Visual Studio 2015

Returns a Window object in a LinkedWindows collection.

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

Syntax

Window^ Item(
	Object^ index
)

Parameters

index: Type: System::Object^
Required. The index of the Window object to return.

Return Value

Type: EnvDTE::Window^

A Window object.

Remarks

The value passed to Index is either an integer that is an index to a Window object in its LinkedWindows collection or the name of a Window object in the collection.

The Item method throws a ArgumentException exception if the collection cannot find the object that corresponds to the index value.

Examples

Sub LinkedWindowsExample()
   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