SandcastleProjectAddFolderToProject Method

Add a new folder build item to the project

Definition

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

C#View Source Request Example

public FileItem AddFolderToProject(
	string folder
)

VBView Source Request Example

Public Function AddFolderToProject ( 
	folder As String
) As FileItem

C++View Source Request Example

public:
FileItem^ AddFolderToProject(
	String^ folder
)

F#View Source Request Example

member AddFolderToProject : 
        folder : string -> FileItem

Parameters

folder String: The folder name

Return Value

FileItem
The new FileItem.

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.

Exceptions

ArgumentException

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