Solution2 Interface

Represents all projects and solution-wide properties in the integrated development environment (IDE).

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

Syntax

'Declaration
<GuidAttribute("FA238614-FBB1-4314-A7F7-49AE8BB6C6BA")> _
Public Interface Solution2 _
    Inherits _Solution

[GuidAttribute("FA238614-FBB1-4314-A7F7-49AE8BB6C6BA")]
public interface Solution2 : _Solution

[GuidAttribute(L"FA238614-FBB1-4314-A7F7-49AE8BB6C6BA")]
public interface class Solution2 : _Solution

[<GuidAttribute("FA238614-FBB1-4314-A7F7-49AE8BB6C6BA")>]
type Solution2 =  
    interface
        interface _Solution
    end

public interface Solution2 extends _Solution

The Solution2 type exposes the following members.

Properties

	Name	Description
	AddIns	Gets an AddIns collection, which contains all currently available Add-ins associated with the solution.
	Count	Gets a value indicating the number of projects in the solution.
	DTE	Gets the top-level extensibility object.
	Extender	Gets the requested Extender object if it is available for this object.
	ExtenderCATID	Gets the Extender category ID (CATID) for the object.
	ExtenderNames	Gets a list of available Extenders for the object.
	FileName	Infrastructure. Microsoft Internal Use Only.
	FullName	Gets the full path and name of the object's file.
	Globals	Gets the Globals object that contains any variable values that may be saved in the solution (.sln) file, the project file, or the user's profile data.
	IsDirty	Infrastructure. Microsoft Internal Use Only.
	IsOpen	Gets a value which indicates whether a solution is open.
	Parent	Gets the immediate parent object of a Solution2 object.
	Projects	Gets a collection of the projects currently in the solution.
	Properties	Gets a collection of all properties that pertain to the Solution2 object.
	Saved	Gets or sets a value indicating whether a solution has not been modified since last being saved or opened.
	SolutionBuild	Gets the SolutionBuild object for the solution, which represents the root of the build automation model at the solution level.
	TemplatePath	Superseded by GetProjectTemplate.

Top

Methods

	Name	Description
	AddFromFile	Adds a project to the solution that is based on a project file already stored in the system.
	AddFromTemplate	Copies an existing project file, and any items or subdirectories it contains, to the specified location and adds it to the solution.
	AddSolutionFolder	Adds a solution folder to a ProjectItems collection.
	Close	Closes the current solution.
	Create	Creates an empty solution in the specified directory with the specified name.
	FindProjectItem	Locates an item in a project.
	GetEnumerator	Returns an enumeration for items in a collection.
	GetProjectItemTemplate	Returns a path to the indicated project item template.
	GetProjectTemplate	Returns a path to the indicated project template.
	Item	Returns an indexed member of a Projects collection.
	Open	Opens a specified solution.
	ProjectItemsTemplatePath	Superseded by GetProjectItemTemplate.
	Remove	Removes the specified project from the solution.
	SaveAs	Saves the solution.

Top

Remarks

This interface contains a collection of all projects in the current instance of the IDE and all solution-wide properties, such as build configurations. It contains a project element for every project, whether it is a wrapped project, a subproject, or a top-level project.

You can find the open solution by using the DTE.Solution property. To refer to virtual projects, such as MiscFiles or SolutionItems, use Solution.Item(EnvDTE.Constants.vsProjectKindMisc or Solution.Item(EnvDTE.Constants.vsProjectKindSolutionItems.

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 code creates a new console application solution in the given path.

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)
    SolutionExample(_applicationObject)
End Sub

Sub SolutionExample(ByVal dte As DTE2)
    ' This function creates a solution and adds a Visual Basic Console
    ' project to it.
    Try
        Dim soln As Solution2 = CType(DTE.Solution, Solution2)
        Dim vbTemplatePath As String
        ' This path must exist on your computer.
        ' Replace <file path> below with an actual path.
        Dim vbPrjPath As String = <file path>
        MsgBox("starting")
        ' Get the project template path for a Visual Basic console application project.
        vbTemplatePath = soln.GetProjectTemplate _
        ("ConsoleApplication.zip", "VisualBasic")
        ' Create a new Visual Baic Console project using the template obtained 
        ' above.
        soln.AddFromTemplate(vbTemplatePath, vbPrjPath, _
        "New Visual Basic Console Project", False)
        MsgBox("done")
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

//you will need to add this reference to your project as well
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.
    SolutionExample((DTE2)_applicationObject);
}

public void SolutionExample(DTE2 dte)
{
    // This function creates a solution and adds a Visual C# Console
    // project to it.
    try{
        Solution2 soln = (Solution2)_applicationObject.Solution;
        String csTemplatePath;
        // The file path must exist on your computer.
        // Replace <file path> below with an actual path.
        String csPrjPath = <file path>;
    MessageBox.Show("Starting...");
csTemplatePath = 
soln.GetProjectTemplate("ConsoleApplication.zip", "CSharp");
        // Create a new C# Console project using the template obtained 
        // above.
        soln.AddFromTemplate(csTemplatePath, csPrjPath,
 "New CSharp Console Project", false);
        MessageBox.Show("Done!");
    }
    catch(SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

See Also

Reference

EnvDTE80 Namespace