Share via


SolutionFolder.Hidden Property

Sets or gets the hidden attribute of the solution.

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

Syntax

'Declaration
Property Hidden As Boolean
bool Hidden { get; set; }
property bool Hidden {
    bool get ();
    void set (bool value);
}
abstract Hidden : bool with get, set
function get Hidden () : boolean 
function set Hidden (value : boolean)

Property Value

Type: System.Boolean
Determines if a solution is hidden from view in the solution explorer.

Examples

This example creates a new solution folder and adds a project to it from an existing file. It also adds a new nested solution folder to the first one, by using the AddSolutionFolder method and then displays the Hidden property and sets it to false. Before running this example, create a "Projects" folder off your main drive ("C:" in this example), and create a Visual C# class library project named "ClassLibrary1" in that folder. Open a project in the Visual Studio integrated development environment (IDE) before running this add-in.

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)
    solnFolderHiddenExample(_applicationObject)
End Sub
Sub solnFolderHiddenExample(ByVal dte As DTE2)
    ' Before running this example, create a "Projects" folder
    ' off your main drive (C: in this example), and create a C# 
    ' class library project named ClassLibrary1 in that folder.
    Dim soln As Solution2 = CType(_applicationObject.Solution _
    , Solution2)
    Dim prj As Project
    Dim SF As SolutionFolder
    Try
        Dim prjPath As String = _
        "C:\Projects\ClassLibrary1\ClassLibrary1\ClassLibrary1.csproj"
        ' Open a project in the Visual Studio IDE before 
        ' running this add-in.
        ' Add a solution folder.
        prj = soln.AddSolutionFolder("A new soln folder")
        SF = CType(prj.Object, SolutionFolder)
        ' Add a project to the new solution folder.
        SF.AddFromFile(prjPath)
        MsgBox("Added a new solution folder that contains  _
        a C# project named ClassLibrary1.")
        SF.AddSolutionFolder("New solnFolder2")
        MsgBox("Added a new solution folder _
        named 'New solnFolder2'.")
        MsgBox("The Hidden property value is set to: "  _
        & SF.Hidden.ToString())
        MsgBox("Set the 'Hidden' property to 'False'.")
        SF.Hidden = False
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
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;
    solnFolderHiddenExample(_applicationObject);
}
public void solnFolderHiddenExample(DTE2 dte)
{
    // Before running this example, create a "Projects" folder
    // off your main drive (C: in this example), and create a C# 
    // class library project, named ClassLibrary1 in that folder.
    Solution2 soln = (Solution2)_applicationObject.Solution;
    Project prj;
    SolutionFolder SF;
    try
    {
        String prjPath = 
"C:\\Projects\\ClassLibrary1\\ClassLibrary1\\ClassLibrary1.csproj";
        // Open a project in Visual Studio IDE before 
        // running this add-in.
        // Add a solution folder.
        prj = soln.AddSolutionFolder("A new soln folder");
        SF = (SolutionFolder)prj.Object;
        // Add a project to the new solution folder.
        SF.AddFromFile(prjPath);
        MessageBox.Show("Added a new solution folder that 
contains a C# project named ClassLibrary1.");
        SF.AddSolutionFolder("New solnFolder2");
        MessageBox.Show("Added a new solution folder 
named 'New solnFolder2'.");
        MessageBox.Show("The Hidden property value is set to: " 
+ SF.Hidden.ToString());
        MessageBox.Show("Set the 'Hidden' property to 'false'.");
        SF.Hidden = false;
    }
    catch(SystemException ex)
    {
    MessageBox.Show(ex.ToString());
    }
}

.NET Framework Security

See Also

Reference

SolutionFolder Interface

EnvDTE80 Namespace