Windows.CreateLinkedWindowFrame Method

Article
02/04/2013

Creates a Window object and places two windows in it.

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

Syntax

'Declaration
Function CreateLinkedWindowFrame ( _
    Window1 As Window, _
    Window2 As Window, _
    Link As vsLinkedWindowType _
) As Window

Window CreateLinkedWindowFrame(
    Window Window1,
    Window Window2,
    vsLinkedWindowType Link
)

Window^ CreateLinkedWindowFrame(
    [InAttribute] Window^ Window1, 
    [InAttribute] Window^ Window2, 
    [InAttribute] vsLinkedWindowType Link
)

abstract CreateLinkedWindowFrame : 
        Window1:Window * 
        Window2:Window * 
        Link:vsLinkedWindowType -> Window

function CreateLinkedWindowFrame(
    Window1 : Window, 
    Window2 : Window, 
    Link : vsLinkedWindowType
) : Window

Parameters

Window1
Type: EnvDTE.Window
Required. The first Window object to link to the other.

Window2
Type: EnvDTE.Window
Required. The second Window object to link to the other.

Link
Type: EnvDTE.vsLinkedWindowType
Required. A vsLinkedWindowType constant indicating the way the windows should be joined.

Return Value

Type: EnvDTE.Window
A Window object.

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.

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.