TopicCollection.GenerateTableOfContents Method

TopicCollectionGenerateTableOfContents Method

Generate the table of contents for the conceptual topics

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

Syntax

C++

Copy

public void GenerateTableOfContents(
	TocEntryCollection toc,
	IBasePathProvider pathProvider,
	bool includeInvisibleItems
)

Public Sub GenerateTableOfContents ( 
	toc As TocEntryCollection,
	pathProvider As IBasePathProvider,
	includeInvisibleItems As Boolean
)

public:
virtual void GenerateTableOfContents(
	TocEntryCollection^ toc, 
	IBasePathProvider^ pathProvider, 
	bool includeInvisibleItems
) sealed

abstract GenerateTableOfContents : 
        toc : TocEntryCollection * 
        pathProvider : IBasePathProvider * 
        includeInvisibleItems : bool -> unit 
override GenerateTableOfContents : 
        toc : TocEntryCollection * 
        pathProvider : IBasePathProvider * 
        includeInvisibleItems : bool -> unit

Parameters

toc: Type: SandcastleBuilder.Utils.ConceptualContentTocEntryCollection
The table of contents collection
pathProvider: Type: SandcastleBuilder.UtilsIBasePathProvider
The base path provider
includeInvisibleItems: Type: SystemBoolean
True to include items marked invisible (useful for previewing) or false to exclude them.

Implements

ITableOfContentsGenerateTableOfContents(TocEntryCollection, IBasePathProvider, Boolean)

Reference

TopicCollection Class

SandcastleBuilder.Utils.ConceptualContent Namespace