ISandcastleProject.AddFileToProject Method

Definition

Namespace

Sandcastle.Core.Project

Assembly

Sandcastle.Core.dll

Add a new file build item to the project

IFileItem AddFileToProject(string sourceFile, string destinationFile)

Parameters

sourceFile string

The source filename

destinationFile string

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.

Returns

IFileItem

The new IFileItem

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.