MarkdownDocumentTransformContext
OfficeIMO.Markdown
Context passed to markdown document transforms.
Inheritance
- object
- MarkdownDocumentTransformContext
Usage
Explore 13 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 13
- Method IMarkdownDocumentTransform.Transform
- Method MarkdownColonListBoundaryTransform.Transform
- Method MarkdownCompactHeadingBoundaryTransform.Transform
- Method MarkdownCompactStrongLabelListBoundaryTransform.Transform
- Method MarkdownHeadingListBoundaryTransform.Transform
- Method MarkdownInlineNormalizationTransform.Transform
- Method MarkdownIntelligenceXCachedToolEvidenceMarkerTransform.Transform
- Method MarkdownIntelligenceXLegacyToolHeadingTransform.Transform
- Method MarkdownJsonVisualCodeBlockTransform.Transform
- Method MarkdownListParagraphStrongArtifactTransform.Transform
- Method MarkdownRegisteredFencedBlockTransform.Transform
- Method MarkdownSimpleDefinitionListParagraphTransform.Transform
- Method MarkdownStandaloneHashHeadingSeparatorTransform.Transform
Constructors
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownLoadOptions? readerOptions = null) #Creates a transform context for a reader-driven pipeline.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownLoadOptions? = null
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, object? sourceOptions) #Creates a transform context for an HTML-import pipeline.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- sourceOptions object?
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownLoadOptions? readerOptions, object? sourceOptions) #Creates a transform context for pipelines that want both reader options and source options, such as renderer-owned AST transforms that run after markdown parsing.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownLoadOptions?
- sourceOptions object?
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownLoadOptions? readerOptions, object? sourceOptions, ICollection<MarkdownDocumentTransformDiagnostic>? diagnostics) #Creates a transform context with an explicit diagnostics sink.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownLoadOptions?
- sourceOptions object?
- diagnostics System.Collections.Generic.ICollection<OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic>?
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownLoadOptions? readerOptions, object? sourceOptions, ICollection<MarkdownDocumentTransformDiagnostic>? diagnostics, MarkdownSyntaxNode? syntaxTree) #Creates a transform context with diagnostics and an original syntax tree.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownLoadOptions?
- sourceOptions object?
- diagnostics System.Collections.Generic.ICollection<OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic>?
- syntaxTree OfficeIMO.Markdown.MarkdownSyntaxNode?
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownLoadOptions? readerOptions, object? sourceOptions, ICollection<MarkdownDocumentTransformDiagnostic>? diagnostics, MarkdownSyntaxNode? syntaxTree, IReadOnlyList<MarkdownSourceSpan?>? topLevelBlockSourceSpans, string? sourceMarkdown = null, string? originalMarkdown = null, bool preservesOriginalMarkdown = false) #Creates a transform context with diagnostics, syntax tree, and explicit top-level block source spans.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownLoadOptions?
- sourceOptions object?
- diagnostics System.Collections.Generic.ICollection<OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic>?
- syntaxTree OfficeIMO.Markdown.MarkdownSyntaxNode?
- topLevelBlockSourceSpans System.Collections.Generic.IReadOnlyList<OfficeIMO.Markdown.MarkdownSourceSpan?>?
- sourceMarkdown string? = null
- originalMarkdown string? = null
- preservesOriginalMarkdown bool = false
Methods
public MarkdownSyntaxNode? FindSyntaxNode(object associatedObject) #Finds the syntax-tree node associated with a parsed model object before the transform pipeline started.
Parameters
- associatedObject object
Returns
MarkdownSyntaxNode?public bool TryCreateOriginalSourceSlice(object associatedObject, out MarkdownSourceSlice slice) #Creates an original-input source slice for the 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 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 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 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 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 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 MarkdownDocumentTransformSource Source { get; } #Source of the current transform pipeline invocation.
public MarkdownLoadOptions? ReaderOptions { get; } #Reader options used when the pipeline runs after markdown parsing.
public object? SourceOptions { get; } #Source options object used by the caller when the pipeline runs outside the markdown reader.
public ICollection<MarkdownDocumentTransformDiagnostic>? Diagnostics { get; } #Optional diagnostics sink populated by the document transform pipeline.
public MarkdownSyntaxNode? SyntaxTree { get; } #Optional original syntax tree for the document before the current transform pipeline runs.
public IReadOnlyList<MarkdownSourceSpan?>? TopLevelBlockSourceSpans { get; } #Optional per-top-level-block source spans for the document before the current transform pipeline runs.
public string SourceMarkdown { get; } #Normalized markdown source text used to compute MarkdownDocumentTransformContext.SyntaxTree source spans.
public string OriginalMarkdown { get; } #Raw markdown input retained when trivia preservation is enabled; otherwise this falls back to MarkdownDocumentTransformContext.SourceMarkdown.
public bool PreservesOriginalMarkdown { get; } #Indicates whether MarkdownDocumentTransformContext.OriginalMarkdown contains the exact reader input captured before normalization.