MarkdownWriteContext
OfficeIMO.Markdown
Context available while rendering a markdown document body back to Markdown text.
Inheritance
- object
- MarkdownWriteContext
Usage
Explore 4 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters 4
Methods
public IReadOnlyList<Entry> BuildTocEntries(int blockIndex, MarkdownTocOptions options, string? titleAnchor = null) #Builds TOC-style heading entries relative to a specific top-level block index using the supplied TOC options.
Parameters
- blockIndex int
- options OfficeIMO.Markdown.MarkdownTocOptions
- titleAnchor string? = null
Returns
IReadOnlyList<Entry>public MarkdownSyntaxNode? FindSyntaxNode(object associatedObject) #Finds the final syntax-tree node associated with a parsed model object, or null for builder-only documents.
Parameters
- associatedObject object
Returns
MarkdownSyntaxNode?public int GetBlockIndex(IMarkdownBlock block) #Returns the zero-based index of a top-level block in MarkdownWriteContext.Blocks, or -1 when the block is not present.
Parameters
- block OfficeIMO.Markdown.IMarkdownBlock
Returns
intpublic string GetHeadingAnchor(IMarkdownBlock heading) #Returns the resolved anchor id for a heading block within the current rendered document.
Parameters
- heading OfficeIMO.Markdown.IMarkdownBlock
Returns
stringpublic string? GetPrecedingHeadingAnchor(int blockIndex, MarkdownTocOptions options) #Returns 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 int
- options OfficeIMO.Markdown.MarkdownTocOptions
Returns
string?public string RenderBlock(IMarkdownBlock block) #Renders a block through the active Markdown writer dispatcher, including syntax-kind and type-targeted overrides. Custom container renderers should use this for child blocks instead of calling IMarkdownBlock.RenderMarkdown directly.
Parameters
- block OfficeIMO.Markdown.IMarkdownBlock
Returns
stringpublic bool TryCreateOriginalSourceSlice(object associatedObject, out MarkdownSourceSlice slice) #Creates an original-input source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject object
- slice OfficeIMO.Markdown.MarkdownSourceSlice
Returns
boolpublic bool TryCreateOriginalSourceSlice(object associatedObject, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #Creates an original-input source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject object
- slice OfficeIMO.Markdown.MarkdownSourceSlice
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason
Returns
boolpublic bool TryCreateOriginalSourceSlice(MarkdownSyntaxNode syntaxNode, out MarkdownSourceSlice slice) #Creates an original-input source slice for the supplied final syntax node.
Parameters
- syntaxNode OfficeIMO.Markdown.MarkdownSyntaxNode
- slice OfficeIMO.Markdown.MarkdownSourceSlice
Returns
boolpublic bool TryCreateOriginalSourceSlice(MarkdownSyntaxNode syntaxNode, out MarkdownSourceSlice slice, out 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
Returns
boolpublic bool TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out 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
Returns
boolpublic bool TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice, out 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
Returns
boolpublic bool TryCreateSourceSlice(object associatedObject, out MarkdownSourceSlice slice) #Creates a normalized source slice for the final syntax node associated with a parsed model object.
Parameters
- associatedObject object
- slice OfficeIMO.Markdown.MarkdownSourceSlice
Returns
boolpublic bool TryCreateSourceSlice(MarkdownSyntaxNode syntaxNode, out MarkdownSourceSlice slice) #Creates a normalized source slice for the supplied final syntax node.
Parameters
- syntaxNode OfficeIMO.Markdown.MarkdownSyntaxNode
- slice OfficeIMO.Markdown.MarkdownSourceSlice
Returns
boolpublic bool TryCreateSourceSlice(MarkdownSourceSpan sourceSpan, out 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
Returns
boolInherited Methods
Properties
public IReadOnlyList<IMarkdownBlock> Blocks { get; } #Top-level blocks being rendered for the current markdown document.
public MarkdownSaveOptions Options { get; } #Active markdown writer options.
public CancellationToken CancellationToken { get; } #Cancellation requested by the caller of the active Markdown serialization operation.