Window2.LinkedWindowFrame Property

Article
03/18/2013

Gets a Window object representing the window frame containing the window.

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

Syntax

'Declaration
ReadOnly Property LinkedWindowFrame As Window

Window LinkedWindowFrame { get; }

property Window^ LinkedWindowFrame {
    Window^ get ();
}

abstract LinkedWindowFrame : Window

function get LinkedWindowFrame () : Window

Property Value

Type: EnvDTE.Window
A Window object.

Implements

Window.LinkedWindowFrame

Remarks

Note that if the window is docked to the side of the main window, then the LinkedWindowFrame is the same object as the main environment window.

If the window is not linked, is of type LinkedWindowFrame, is hidden, or is a document, then LinkedWindowFrame returns Nothing. Hidden windows are not considered linked because they are not in a window frame.

Examples

This example creates a linked window frame, adds the Output Window and Solution Explorer to the linked frame as vertical windows, activates the linked window frame, and then undocks the windows from the frame.

For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    LinkedWindowFrameExample(_applicationObject)
End Sub
Sub LinkedWindowFrameExample(ByVal dte As DTE2)
    Dim Frame As Window2
    Dim w1 As Window2 = _
    CType(dte.Windows.Item _
(Constants.vsWindowKindSolutionExplorer),Window2)
     Dim w2 As Window2 = CType(dte.Windows.Item _
(Constants.vsWindowKindOutput), Window2)
    ' Create a linked window frame and dock Solution Explorer 
    ' and the Ouput window together inside it.
    Frame = Ctype(dte.Windows.CreateLinkedWindowFrame(w1, w2, _
    vsLinkedWindowType.vsLinkedWindowTypeVertical), Window2)
    MsgBox("Activating the linked window frame...")
    Frame.LinkedWindows.Item(1).LinkedWindowFrame.Activate()
    MsgBox("Removing Solution Explorer from the linked frame...")
    Frame.LinkedWindows.Remove(w1)
    MsgBox("Removing the Output window from the linked frame...")
    Frame.LinkedWindows.Remove(w2)
End Sub

using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
public void OnConnection(object application,
 ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    LinkedWindowFrameExample(_applicationObject);
}
public void LinkedWindowFrameExample(DTE2 dte)
{
    Window2 w1 = (Window2)_applicationObject.Windows.Item
(Constants.vsWindowKindSolutionExplorer);
    Window2 w2 = (Window2)_applicationObject.Windows.Item
(Constants.vsWindowKindOutput);
    Window2 Frame = 
(Window2)_applicationObject.Windows.CreateLinkedWindowFrame
(w1, w2, vsLinkedWindowType.vsLinkedWindowTypeVertical);
    MessageBox.Show("Activating the linked window frame...");
    Frame.LinkedWindows.Item(1).LinkedWindowFrame.Activate();
    MessageBox.Show("Removing Solution Explorer 
from the linked frame...");
    Frame.LinkedWindows.Remove(w1);
    MessageBox.Show("Removing the Output window from the 
linked frame...");
    Frame.LinkedWindows.Remove(w2);
}

.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.

Share via