LinkedWindows.Item(Object) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a Window object in a LinkedWindows collection.

public:
 EnvDTE::Window ^ Item(System::Object ^ index);

public:
 EnvDTE::Window ^ Item(Platform::Object ^ index);

EnvDTE::Window Item(winrt::Windows::Foundation::IInspectable const & index);

[System.Runtime.InteropServices.DispId(0)]
public EnvDTE.Window Item (object index);

[<System.Runtime.InteropServices.DispId(0)>]
abstract member Item : obj -> EnvDTE.Window

Public Function Item (index As Object) As Window

Parameters

index: Object

Required. The index of the Window object to return.

Returns

Window

A Window object.

Attributes: DispIdAttribute

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

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.

Applies to

Condividi tramite