API Reference
MarkdownInlineHtmlRenderContext
Context available while rendering a markdown inline node to HTML.
Inheritance
- Object
- MarkdownInlineHtmlRenderContext
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
Methods
public IReadOnlyList<Entry> BuildTocEntries(Int32 blockIndex, TocOptions options, String titleAnchor = null) #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 String EncodeAttributeValue(String value) #StringEncodes a quoted HTML attribute value with the active HTML escaping policy.
Parameters
- value System.String
public String EncodeText(String text) #StringEncodes text content with the active HTML escaping policy.
Parameters
- text System.String
public String EncodeUrlAttribute(String url) #StringEncodes a URL-bearing HTML attribute value with the active URL and HTML escaping policy.
Parameters
- url System.String
public MarkdownSyntaxNode FindSyntaxNode(Object associatedObject) #MarkdownSyntaxNodeFinds the final syntax-tree node associated with a parsed model object, or null when no body context is active.
Parameters
- associatedObject System.Object
public Int32 GetBlockIndex(IMarkdownBlock block) #Int32Returns the zero-based index of a top-level block in Blocks, or -1 when unavailable.
Parameters
- block OfficeIMO.Markdown.IMarkdownBlock
public String GetHeadingAnchor(IMarkdownBlock heading) #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) #StringReturns the anchor id of the nearest preceding heading according to the supplied TOC options.
Parameters
- blockIndex System.Int32
- options OfficeIMO.Markdown.TocOptions
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #BooleanCreates an original-input source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject System.Object
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates an original-input source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject System.Object
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
TryCreateOriginalSourceSlice(OfficeIMO.Markdown.MarkdownSyntaxNode syntaxNode, OfficeIMO.Markdown.MarkdownSourceSlice@ slice) #Creates an original-input source slice for the supplied final syntax node.
Parameters
- syntaxNode OfficeIMO.Markdown.MarkdownSyntaxNode
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
TryCreateOriginalSourceSlice(OfficeIMO.Markdown.MarkdownSyntaxNode syntaxNode, OfficeIMO.Markdown.MarkdownSourceSlice@ slice, OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@ failureReason) #Creates an original-input source slice for the supplied final syntax node.
Parameters
- syntaxNode OfficeIMO.Markdown.MarkdownSyntaxNode
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
TryCreateOriginalSourceSlice(OfficeIMO.Markdown.MarkdownSourceSpan sourceSpan, OfficeIMO.Markdown.MarkdownSourceSlice@ slice) #Creates an original-input source slice for a token or field source span captured during parsing.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
TryCreateOriginalSourceSlice(OfficeIMO.Markdown.MarkdownSourceSpan sourceSpan, OfficeIMO.Markdown.MarkdownSourceSlice@ slice, OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@ failureReason) #Creates an original-input source slice for a token or field source span captured during parsing.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #BooleanCreates a normalized source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject System.Object
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
TryCreateSourceSlice(OfficeIMO.Markdown.MarkdownSyntaxNode syntaxNode, OfficeIMO.Markdown.MarkdownSourceSlice@ slice) #Creates a normalized source slice for the supplied final syntax node.
Parameters
- syntaxNode OfficeIMO.Markdown.MarkdownSyntaxNode
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
TryCreateSourceSlice(OfficeIMO.Markdown.MarkdownSourceSpan sourceSpan, OfficeIMO.Markdown.MarkdownSourceSlice@ slice) #Creates a normalized source slice for a token or field source span captured during parsing.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object