TocBlock
OfficeIMO.Markdown
MarkdownTable of contents block generated from document headings.
Inheritance
- MarkdownObject
- MarkdownBlock
- TocBlock
Constructors
public TocBlock() #Inherited Methods
public void Accept(MarkdownVisitor visitor) #Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns
IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns
IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Type Parameters
- TObject
Returns
IEnumerable<TObject>public IEnumerable<MarkdownObject> Descendants() #Returns
IEnumerable<MarkdownObject>Properties
public bool Ordered { get; set; } #When true, renders an ordered list; otherwise unordered.
public bool NormalizeLevels { get; set; } #Normalize indentation to the minimum included heading level (default true).
public bool 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 int TitleLevel { get; set; } #Heading level for the title when an output format renders it as a heading.
public int MinLevel { get; set; } #Minimum heading level included by the table of contents.
public int MaxLevel { get; set; } #Maximum heading level included by the table of contents.
public MarkdownTocLayout Layout { get; set; } #Preferred visual layout for output formats that support TOC chrome.
public MarkdownTocChrome Chrome { get; set; } #Preferred visual chrome for output formats that support TOC containers.
public MarkdownTocScope Scope { get; set; } #Scope used when the TOC entries were realized from a placeholder.
public string? ScopeHeadingTitle { get; set; } #Heading title used when TocBlock.Scope is MarkdownTocScope.HeadingTitle.
public bool RequireTopLevel { get; set; } #When true, top-level headings are included even when TocBlock.MinLevel starts deeper.
public bool TitleHeadingAlreadyRendered { get; set; } #True when a TOC builder already emitted the title as the preceding heading.
Inherited Properties
public MarkdownSourceSpan? SourceSpan { get; internal set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #