SandcastleProject.AddFileToProject Method

SandcastleProjectAddFileToProject Method

Add a new file build item to the project

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public FileItem AddFileToProject(
	string sourceFile,
	string destFile
)

Public Function AddFileToProject ( 
	sourceFile As String,
	destFile As String
) As FileItem

public:
FileItem^ AddFileToProject(
	String^ sourceFile, 
	String^ destFile
)

member AddFileToProject : 
        sourceFile : string * 
        destFile : string -> FileItem

Parameters

sourceFile: Type: SystemString
The source filename
destFile: Type: SystemString
The optional destination path. If empty, null, or it does not start with the project folder, the file is copied to the root folder of the project.

Return Value

Type: FileItem
The new FileItem.

Remarks

If the file does not exist in the project, it is copied to the destination path or project folder if not already there. The default build action is determined based on the filename's extension. If the file is already part of the project, the existing item is returned.

Reference

SandcastleProject Class

SandcastleBuilder.Utils Namespace