Window2.Visible Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Gets or sets the visibility of a window.

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

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

[System.Runtime.InteropServices.DispId(106)]
public bool Visible { [System.Runtime.InteropServices.DispId(106)] get; [System.Runtime.InteropServices.DispId(106)] set; }

[<System.Runtime.InteropServices.DispId(106)>]
[<get: System.Runtime.InteropServices.DispId(106)>]
[<set: System.Runtime.InteropServices.DispId(106)>]
member this.Visible : bool with get, set

Public Property Visible As Boolean

Property Value

Boolean

true if the window is visible; otherwise, false.

Implements

Visible

Attributes

DispIdAttribute

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.

Imports EnvDTE  
Imports EnvDTE80  
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 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.");  
}  

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.