_Solution.AddFromTemplate(String, String, String, Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Copies an existing project file, and any items or subdirectories it contains, to the specified location and adds it to the solution.

EnvDTE::Project AddFromTemplate(std::wstring const & FileName, std::wstring const & Destination, std::wstring const & ProjectName, bool Exclusive = false);

[System.Runtime.InteropServices.DispId(15)]
public EnvDTE.Project AddFromTemplate (string FileName, string Destination, string ProjectName, bool Exclusive = false);

[<System.Runtime.InteropServices.DispId(15)>]
abstract member AddFromTemplate : string * string * string * bool -> EnvDTE.Project

Public Function AddFromTemplate (FileName As String, Destination As String, ProjectName As String, Optional Exclusive As Boolean = false) As Project

Parameters

FileName: String

Required. The full path and file name with extension of the template project file.

Destination: String

Required. The full path of the directory in which to copy the contents of FileName.

ProjectName: String

Required. The name of the project file in the destination directory. This should include the extension. The name displayed is derived from ProjectName.

Exclusive: Boolean

Optional. Indicates whether the project loads in the current solution or its own; true if the current solution is closed and the project is added to a new solution, false if the project is added to the existing open solution.

Returns

Project

A Project object.

Attributes: DispIdAttribute

Examples

Sub SolutionExample()  
   'This function creates a solution and adds a Visual Basic Console  
   'project to it.   
   Dim soln As Solution  
   Dim proj As Project  
   Dim msg As String  

   'Create a reference to the solution.  
   soln = DTE.Solution  

   ' Create a new solution.  
   soln.Create("c:\temp2", "MyNewSolution")  

   ' Create a new VB project from a template.   
   ' Adjust the template path and save path as needed.  
   proj = soln.AddFromTemplate("<template path>\ConsoleApplication.vbproj", "c:\temp2", "My New Project", True)  
   ' Save the new solution and project.  
   soln.SaveAs("c:\temp2\newsolution.sln")  
   msg = "Created new solution: " & soln.FullName & vbCrLf  
   msg = msg & "Created new project: " & proj.Name  
   MsgBox(msg)  
End Sub

Remarks

The name of the project displayed in the Solution Browser is ProjectName without the file extension. AddFromTemplate fails if the new project file name already exists in the destination.

Note

For Visual Basic and Visual C# projects: The Project object returned is null. You can find the Project object created by iterating through the DTE.Solution.Projects collection using the ProjectName parameter to identify the newly created project.

Applies to