ProjectItems.AddFromFileCopy Method

Copies a source file and adds it to the project.

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

Syntax

'Declaration
Function AddFromFileCopy ( _
    FilePath As String _
) As ProjectItem
ProjectItem AddFromFileCopy(
    string FilePath
)
ProjectItem^ AddFromFileCopy(
    String^ FilePath
)
abstract AddFromFileCopy : 
        FilePath:string -> ProjectItem 
function AddFromFileCopy(
    FilePath : String
) : ProjectItem

Parameters

  • FilePath
    Type: System.String
    Required. The path and file name of the project item to be added.

Return Value

Type: EnvDTE.ProjectItem
A ProjectItem object.

Remarks

AddFromFileCopy adds a project item from a file already installed in the project directory structure, or copies it verbatim, if necessary, to move it into the project directory. AddFromFileCopy differs from AddFromFile because it does not add a link, and it differs from AddFromTemplate in that it does not necessarily copy the file or apply a template.

Examples

This example works only in Visual Studio .NET 2003. For more information, see Migrating Code that Creates Projects by Using Templates.

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

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

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

   ' Create a new VB Console application project. Adjust the save path as 
   ' needed.
   proj = soln.AddFromTemplate("C:\Program Files\Microsoft Visual Studio .NET\Vb7\VBWizards\ConsoleApplication\Templates\1033\ConsoleApplication.vbproj", "c:\temp2", "My New Project", True)
   projitems = proj.ProjectItems

   ' Add a project item from a file.
   projitems.AddFromFileCopy("C:\temp\somefile.bas")
End Sub

.NET Framework Security

See Also

Reference

ProjectItems Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples