TocEntryCollection.AddTopicsFromFolder Method

TocEntryCollectionAddTopicsFromFolder Method

Add all topics from the specified folder recursively to the collection and to the given project file.

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

Syntax

C++

Copy

public void AddTopicsFromFolder(
	string folder,
	string basePath,
	SandcastleProject project
)

Public Sub AddTopicsFromFolder ( 
	folder As String,
	basePath As String,
	project As SandcastleProject
)

public:
void AddTopicsFromFolder(
	String^ folder, 
	String^ basePath, 
	SandcastleProject^ project
)

member AddTopicsFromFolder : 
        folder : string * 
        basePath : string * 
        project : SandcastleProject -> unit

Parameters

folder: Type: SystemString
The folder from which to get the files
basePath: Type: SystemString
The base path to remove from files copied from another folder into the project folder. On the first call, this should match the folder value.
project: Type: SandcastleBuilder.UtilsSandcastleProject
The project to which the files are added

Remarks

Only actual HTML content topic files are added. They must have a ".htm?" extension. Folders will be added as sub-topics recursively. If a file with the same name as the folder exists, it will be associated with the container node. If no such file exists, an empty container node is created.

Reference

TocEntryCollection Class

SandcastleBuilder.Utils.ConceptualContent Namespace