Window2.Visible Property

  • Article

Gets or sets the visibility of a window.

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

Syntax

'Declaration
Property Visible As Boolean

bool Visible { get; set; }

property bool Visible {
    bool get ();
    void set (bool value);
}

abstract Visible : bool with get, set

function get Visible () : boolean
function set Visible (value : boolean)

Property Value

Type: System.Boolean
true if the window is visible; otherwise, false.

Implements

Window.Visible

Remarks

The Find/Replace utility does not search windows that are not visible in open documents, even if the document associated with the window is still open.

Examples

This example creates a linked window frame, adds the Output Window and Solution Explorer to the linked frame as docked windows, displays some properties, uses the Visible property to set the visibility status of the 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)
    VisibleExample(_applicationObject)
End Sub
Sub VisibleExample(ByVal dte As DTE2)
    Dim Frame As Window2
    Dim w1 As Window2 = CType(_applicationObject.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(_applicationObject.Windows.CreateLinkedWindowFrame _
    (w1, w2, vsLinkedWindowType.vsLinkedWindowTypeDocked), Window2)
    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
    Frame.Left = 100
    Frame.Top = 100
    MsgBox("Frame height, width, and position changed.")
    MsgBox("Set the frame not visible.")
    Frame.Visible = False
    MsgBox("Set the frame visible.")
    Frame.Visible = True
    MsgBox("Undock the windows.")
    Frame.LinkedWindows.Remove(w1)
    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;
    VisibleExample(_applicationObject);
}
public void VisibleExample(DTE2 dte)
{
    Window2 Frame;
    Window2 w1 = (Window2)_applicationObject.Windows.Item
(Constants.vsWindowKindSolutionExplorer);
    Window2 w2 = (Window2)_applicationObject.Windows.Item
(Constants.vsWindowKindOutput);
    // Create a linked window frame and dock Solution Explorer 
    // and the Ouput window together inside it.
    Frame = (Window2)_applicationObject.Windows.CreateLinkedWindowFrame
(w1, w2, vsLinkedWindowType.vsLinkedWindowTypeDocked);
    MessageBox.Show("Total number of windows in the linked 
window frame: " + Frame.LinkedWindows.Count);
    // Resize the entire linked window frame.
    Frame.Width = 500;
    Frame.Height = 600;
    Frame.Left = 100;
    Frame.Top = 100;
    MessageBox.Show("Frame height, width, and position changed.");
    MessageBox.Show("Set the frame not visible.");
    Frame.Visible = false;
    MessageBox.Show("Set the frame visible.");
    Frame.Visible = true;
    Frame.LinkedWindows.Remove(w1);
    Frame.LinkedWindows.Remove(w2);
    MessageBox.Show("Undocked the windows.");
}

.NET Framework Security

See Also

Reference

Window2 Interface

EnvDTE80 Namespace