API Reference
MarkdownDocumentTransformContext
Context passed to markdown document transforms.
Inheritance
- Object
- MarkdownDocumentTransformContext
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method IMarkdownDocumentTransform.Transform
- Method MarkdownColonListBoundaryTransform.Transform
- Method MarkdownCompactHeadingBoundaryTransform.Transform
- Method MarkdownCompactStrongLabelListBoundaryTransform.Transform
- Method MarkdownDocumentTransformPipeline.Apply
- 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, Object sourceOptions) #Creates a transform context for a reader-driven pipeline.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownReaderOptions = null
MarkdownDocumentTransformContext(OfficeIMO.Markdown.MarkdownDocumentTransformSource source, System.Object sourceOptions) #Creates a transform context for an HTML-import pipeline.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- sourceOptions System.Object
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownReaderOptions 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.MarkdownReaderOptions
- sourceOptions System.Object
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownReaderOptions readerOptions, Object sourceOptions, ICollection<MarkdownDocumentTransformDiagnostic> diagnostics) #Creates a transform context with an explicit diagnostics sink.
Parameters
- source OfficeIMO.Markdown.MarkdownDocumentTransformSource
- readerOptions OfficeIMO.Markdown.MarkdownReaderOptions
- sourceOptions System.Object
- diagnostics System.Collections.Generic.ICollection{OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic}
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownReaderOptions 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.MarkdownReaderOptions
- sourceOptions System.Object
- diagnostics System.Collections.Generic.ICollection{OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic}
- syntaxTree OfficeIMO.Markdown.MarkdownSyntaxNode
public MarkdownDocumentTransformContext(MarkdownDocumentTransformSource source, MarkdownReaderOptions readerOptions, Object sourceOptions, ICollection<MarkdownDocumentTransformDiagnostic> diagnostics, MarkdownSyntaxNode syntaxTree, IReadOnlyList<Nullable<MarkdownSourceSpan>> topLevelBlockSourceSpans, String sourceMarkdown = null, String originalMarkdown = null, Boolean 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.MarkdownReaderOptions
- sourceOptions System.Object
- diagnostics System.Collections.Generic.ICollection{OfficeIMO.Markdown.MarkdownDocumentTransformDiagnostic}
- syntaxTree OfficeIMO.Markdown.MarkdownSyntaxNode
- topLevelBlockSourceSpans System.Collections.Generic.IReadOnlyList{System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan}}
- sourceMarkdown System.String = null
- originalMarkdown System.String = null
- preservesOriginalMarkdown System.Boolean = false
Methods
public MarkdownSyntaxNode FindSyntaxNode(Object associatedObject) #MarkdownSyntaxNodeFinds the syntax-tree node associated with a parsed model object before the transform pipeline started.
Parameters
- associatedObject System.Object
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #BooleanCreates an original-input source slice for the 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 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 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 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 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 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
Properties
public MarkdownDocumentTransformSource Source { get; } #Source of the current transform pipeline invocation.
public MarkdownReaderOptions 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<Nullable<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 SyntaxTree source spans.
public String OriginalMarkdown { get; } #Raw markdown input retained when trivia preservation is enabled; otherwise this falls back to SourceMarkdown.
public Boolean PreservesOriginalMarkdown { get; } #Indicates whether OriginalMarkdown contains the exact reader input captured before normalization.