Sandcastle Help File Builder Documentation
Sandcastle
Add a new file build item to the project
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
The new FileItem
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
C#
public FileItem AddFileToProject(
string sourceFile,
string destFile
)VB
Public Function AddFileToProject (
sourceFile As String,
destFile As String
) As FileItemC++
public:
FileItem^ AddFileToProject(
String^ sourceFile,
String^ destFile
)F#
member AddFileToProject :
sourceFile : string *
destFile : string -> FileItem Parameters
- sourceFile String
- The source filename
- destFile 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.
Return Value
FileItemThe 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.