API Reference
TocBlock
Table of contents block generated from document headings.
Inheritance
- MarkdownBlock
- TocBlock
Constructors
public TocBlock() #Methods
Inherited Methods
public Void Accept(MarkdownVisitor visitor) #VoidParameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #IEnumerable<TObject>Type Parameters
- TObject
public IEnumerable<MarkdownObject> Descendants() #IEnumerable<MarkdownObject>public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Boolean Ordered { get; set; } #When true, renders an ordered list; otherwise unordered.
public Boolean NormalizeLevels { get; set; } #Normalize indentation to the minimum included heading level (default true).
public Boolean IncludeTitle { get; set; } #Include a title above the generated table of contents when an output format supports it.
public String Title { get; set; } #Title text for output formats that render TOC chrome.
public Int32 TitleLevel { get; set; } #Heading level for the title when an output format renders it as a heading.
public Int32 MinLevel { get; set; } #Minimum heading level included by the table of contents.
public Int32 MaxLevel { get; set; } #Maximum heading level included by the table of contents.
public TocLayout Layout { get; set; } #Preferred visual layout for output formats that support TOC chrome.
public TocChrome Chrome { get; set; } #Preferred visual chrome for output formats that support TOC containers.
public TocScope Scope { get; set; } #Scope used when the TOC entries were realized from a placeholder.
public String ScopeHeadingTitle { get; set; } #Heading title used when Scope is HeadingTitle.
public Boolean RequireTopLevel { get; set; } #When true, top-level headings are included even when MinLevel starts deeper.
public Boolean TitleHeadingAlreadyRendered { get; set; } #True when a TOC builder already emitted the title as the preceding heading.
public List<Entry> Entries { get; } #Entries included in the TOC.
Inherited Properties
public MarkdownObject Parent { get; } #public MarkdownDoc Document { get; } #public MarkdownObject Root { get; } #public Nullable<Int32> IndexInParent { get; } #public MarkdownObject PreviousSibling { get; } #public MarkdownObject NextSibling { get; } #public Nullable<MarkdownSourceSpan> SourceSpan { get; set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #