API Reference
Class
MarkdownBodyRenderContext
Context available while rendering a markdown document body to HTML.
Inheritance
- Object
- MarkdownBodyRenderContext
Methods
public IReadOnlyList<Entry> BuildTocEntries(Int32 blockIndex, TocOptions options, String titleAnchor = null) #Returns:
IReadOnlyList<Entry>Builds TOC-style heading entries relative to a specific top-level block index using the supplied TOC options.
Parameters
- blockIndex System.Int32
- options OfficeIMO.Markdown.TocOptions
- titleAnchor System.String = null
public Int32 GetBlockIndex(IMarkdownBlock block) #Returns:
Int32Returns the zero-based index of a top-level block in Blocks, or -1 when the block is not present.
Parameters
- block OfficeIMO.Markdown.IMarkdownBlock
public String GetHeadingAnchor(IMarkdownBlock heading) #Returns:
StringReturns the resolved anchor id for a heading block within the current rendered body.
Parameters
- heading OfficeIMO.Markdown.IMarkdownBlock
public String GetPrecedingHeadingAnchor(Int32 blockIndex, TocOptions options) #Returns:
StringReturns the anchor id of the nearest preceding heading according to the supplied TOC options, or null when no heading title should be associated with the specified block index.
Parameters
- blockIndex System.Int32
- options OfficeIMO.Markdown.TocOptions
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object