API Reference
MarkdownDocumentTransformContext
Context passed to markdown document transforms.
Inheritance
- Object
- MarkdownDocumentTransformContext
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) #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}}
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.