Class TocGeneratorService

Inheritance
object
TocGeneratorService
Implements
Inherited Members
Namespace: Volo.Docs.TableOfContents
Assembly: Volo.Docs.Application.dll
Syntax
public class TocGeneratorService : ITocGeneratorService, IApplicationService, IRemoteService, ITransientDependency

Constructors

TocGeneratorService()

Declaration
public TocGeneratorService()

Methods

AppendInlineText(Inline, StringBuilder, Queue<Inline>)

Declaration
protected virtual void AppendInlineText(Inline inline, StringBuilder builder, Queue<Inline> processingQueue)
Parameters
Type Name Description
Inline inline
StringBuilder builder
Queue<Inline> processingQueue

BuildHierarchicalStructure(List<TocHeading>, int)

Declaration
protected virtual List<TocItem> BuildHierarchicalStructure(List<TocHeading> headings, int topLevel)
Parameters
Type Name Description
List<TocHeading> headings
int topLevel
Returns
Type Description
List<TocItem>

CreateMarkdownPipeline()

Declaration
protected virtual MarkdownPipeline CreateMarkdownPipeline()
Returns
Type Description
MarkdownPipeline

CreateTocHeading(HeadingBlock)

Declaration
protected virtual TocHeading CreateTocHeading(HeadingBlock headingBlock)
Parameters
Type Name Description
HeadingBlock headingBlock
Returns
Type Description
TocHeading

GenerateTocHeadings(string)

Declaration
public virtual List<TocHeading> GenerateTocHeadings(string markdownContent)
Parameters
Type Name Description
string markdownContent
Returns
Type Description
List<TocHeading>

GenerateTocItems(List<TocHeading>, int, int)

Declaration
public virtual List<TocItem> GenerateTocItems(List<TocHeading> tocHeadings, int topLevel, int levelCount)
Parameters
Type Name Description
List<TocHeading> tocHeadings
int topLevel
int levelCount
Returns
Type Description
List<TocItem>

GenerateTocItems(string, int, int?)

Declaration
public virtual List<TocItem> GenerateTocItems(string markdownContent, int levelCount, int? topLevel = null)
Parameters
Type Name Description
string markdownContent
int levelCount
int? topLevel
Returns
Type Description
List<TocItem>

GetDirectChildren(List<TocHeading>, int, int)

Declaration
protected virtual List<TocItem> GetDirectChildren(List<TocHeading> allHeadings, int parentIndex, int parentLevel)
Parameters
Type Name Description
List<TocHeading> allHeadings
int parentIndex
int parentLevel
Returns
Type Description
List<TocItem>

GetMaxLevel(List<TocHeading>, int, int)

Declaration
protected virtual int GetMaxLevel(List<TocHeading> tocHeadings, int topLevel, int levelCount)
Parameters
Type Name Description
List<TocHeading> tocHeadings
int topLevel
int levelCount
Returns
Type Description
int

GetPlainText(ContainerInline)

Declaration
protected virtual string GetPlainText(ContainerInline container)
Parameters
Type Name Description
ContainerInline container
Returns
Type Description
string

GetTopLevel(List<TocHeading>)

Declaration
public virtual int GetTopLevel(List<TocHeading> headings)
Parameters
Type Name Description
List<TocHeading> headings
Returns
Type Description
int

HasExactCount<T>(IEnumerable<T>, int)

Declaration
protected virtual bool HasExactCount<T>(IEnumerable<T> enumerable, int count)
Parameters
Type Name Description
IEnumerable<T> enumerable
int count
Returns
Type Description
bool
Type Parameters
Name Description
T

ProcessInlineContent(ContainerInline)

Declaration
protected virtual string ProcessInlineContent(ContainerInline container)
Parameters
Type Name Description
ContainerInline container
Returns
Type Description
string

Implements

Extension Methods