Solution2.AddSolutionFolder Method

Adds a solution folder to a ProjectItems collection.

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

Syntax

'Declaration
Function AddSolutionFolder ( _
    Name As String _
) As Project
Project AddSolutionFolder(
    string Name
)
Project^ AddSolutionFolder(
    String^ Name
)
abstract AddSolutionFolder : 
        Name:string -> Project
function AddSolutionFolder(
    Name : String
) : Project

Parameters

  • Name
    Type: String

    The name of the solution folder.

Return Value

Type: EnvDTE.Project
A Project object.

Examples

For information on how to run this add-in code, see How to: Compile and Run the Automation Object Model Code Examples

The following example shows how to add a new folder to an open solution.

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)
    SolnFolderExample(_applicationObject)
End Sub
Sub SolnFolderExample(ByVal dte As DTE2)
    ' This add-in adds a new folder to an existing solution.
    Try
        Dim soln As Solution2 =  _
        CType(_applicationObject.Solution, Solution2)
        Dim solnName As String = _
        System.IO.Path.GetFileNameWithoutExtension(soln.FullName)
        MsgBox("Adding a new folder to " & solnName)
        Dim Proj As Project
        proj = soln.AddSolutionFolder("MynewFolder")
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub
using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst,
 ref System.Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    AddSolnFolderExample((DTE2)_applicationObject);
}

public void AddSolnFolderExample(DTE2 dte)
{
    // This add-in adds a folder to an existing solution. 
    // Open a solution in 
    // Visual Studio before running this example.
    try
    {
        Solution2 soln = (Solution2)_applicationObject.Solution;
        string solnName =
 System.IO.Path.GetFileNameWithoutExtension(soln.FullName);
        MessageBox.Show("Adding a folder to the solution " + solnName);
        Project proj = soln.AddSolutionFolder("MyNewFolder");
    }
    catch(SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

.NET Framework Security

See Also

Reference

Solution2 Interface

EnvDTE80 Namespace

Other Resources

How to: Organize a Solution Using Solution Folders