Windows.CreateLinkedWindowFrame(Window, Window, vsLinkedWindowType) Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Creates a Window object and places two windows in it.

public:
 EnvDTE::Window ^ CreateLinkedWindowFrame(EnvDTE::Window ^ Window1, EnvDTE::Window ^ Window2, EnvDTE::vsLinkedWindowType Link);

public:
 EnvDTE::Window ^ CreateLinkedWindowFrame(EnvDTE::Window ^ Window1, EnvDTE::Window ^ Window2, EnvDTE::vsLinkedWindowType Link);

EnvDTE::Window CreateLinkedWindowFrame(EnvDTE::Window const & Window1, EnvDTE::Window const & Window2, EnvDTE::vsLinkedWindowType Link);

[System.Runtime.InteropServices.DispId(303)]
public EnvDTE.Window CreateLinkedWindowFrame (EnvDTE.Window Window1, EnvDTE.Window Window2, EnvDTE.vsLinkedWindowType Link);

[<System.Runtime.InteropServices.DispId(303)>]
abstract member CreateLinkedWindowFrame : EnvDTE.Window * EnvDTE.Window * EnvDTE.vsLinkedWindowType -> EnvDTE.Window

Public Function CreateLinkedWindowFrame (Window1 As Window, Window2 As Window, Link As vsLinkedWindowType) As Window

Parameters

Window1

Window

Required. The first Window object to link to the other.

Window2

Window

Required. The second Window object to link to the other.

Link

vsLinkedWindowType

Required. A vsLinkedWindowType constant indicating the way the windows should be joined.

Returns

Window

A Window object.

Attributes

DispIdAttribute

Examples

Sub CreateLinkedWindowFrameExample()  
   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 the 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 order of the Window arguments determines the order of the linked windows. The two windows to be linked must be visible. If either window is hidden, you get an exception. You can use the Visible property to display windows.