SandcastleProject.AddFolderToProject Method

SandcastleProjectAddFolderToProject Method

Add a new folder 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 AddFolderToProject(
	string folder
)

Public Function AddFolderToProject ( 
	folder As String
) As FileItem

public:
FileItem^ AddFolderToProject(
	String^ folder
)

member AddFolderToProject : 
        folder : string -> FileItem

Parameters

folder: Type: SystemString
The folder name

Return Value

Type: FileItem
The new FileItem.

Exceptions

Exception	Condition
ArgumentException	This is thrown if the path matches the project root path or is not below it.

Remarks

If the folder does not exist in the project, it is added and created if not already there. If the folder is already part of the project, the existing item is returned.

Reference

SandcastleProject Class

SandcastleBuilder.Utils Namespace