Get Started

API Reference

Class

MarkdownInlineMarkdownRenderContext

Edit on GitHub
Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Source OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:27
Modifiers sealed

Context available while rendering a markdown inline node back to Markdown text.

Inheritance

  • Object
  • MarkdownInlineMarkdownRenderContext

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) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:44
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 requiredposition: 0
options OfficeIMO.Markdown.TocOptions requiredposition: 1
titleAnchor System.String = null optionalposition: 2
public MarkdownSyntaxNode FindSyntaxNode(Object associatedObject) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:50
Returns: MarkdownSyntaxNode

Finds the final syntax-tree node associated with a parsed model object, or null when no document context is active.

Parameters

associatedObject System.Object requiredposition: 0
public Int32 GetBlockIndex(IMarkdownBlock block) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:27
Returns: Int32

Returns the zero-based index of a top-level block in Blocks, or -1 when unavailable.

Parameters

block OfficeIMO.Markdown.IMarkdownBlock requiredposition: 0
public String GetHeadingAnchor(IMarkdownBlock heading) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:32
Returns: String

Returns the resolved anchor id for a heading block within the current rendered document.

Parameters

heading OfficeIMO.Markdown.IMarkdownBlock requiredposition: 0
public String GetPrecedingHeadingAnchor(Int32 blockIndex, TocOptions options) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:38
Returns: String

Returns the anchor id of the nearest preceding heading according to the supplied TOC options.

Parameters

blockIndex System.Int32 requiredposition: 0
options OfficeIMO.Markdown.TocOptions requiredposition: 1
TryCreateOriginalSourceSlice 6 overloads
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:138
Returns: Boolean

Creates an original-input source slice for the final syntax node associated with a parsed model object.

Parameters

associatedObject System.Object requiredposition: 0
slice OfficeIMO.Markdown.MarkdownSourceSlice@ requiredposition: 1
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:148
Returns: Boolean

Creates an original-input source slice for the final syntax node associated with a parsed model object.

Parameters

associatedObject System.Object requiredposition: 0
slice OfficeIMO.Markdown.MarkdownSourceSlice@ requiredposition: 1
failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@ requiredposition: 2
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required
failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@ required
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required
failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@ required
TryCreateSourceSlice 3 overloads
public Boolean TryCreateSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:80
Returns: Boolean

Creates a normalized source slice for the final syntax node associated with a parsed model object.

Parameters

associatedObject System.Object requiredposition: 0
slice OfficeIMO.Markdown.MarkdownSourceSlice@ requiredposition: 1
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required
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 required
slice OfficeIMO.Markdown.MarkdownSourceSlice@ required

Properties

public MarkdownWriteOptions Options { get; } #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:17

Active markdown writer options.

public IReadOnlyList<IMarkdownBlock> Blocks { get; } #
OfficeIMO.Markdown/Utilities/MarkdownInlineMarkdownRenderContext.cs:22

Top-level blocks being rendered for the current document, or an empty list when no document context is active.