Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MarkdownRendererParseResult

Namespace OfficeIMO.MarkdownRenderer
Assembly OfficeIMO.MarkdownRenderer
Modifiers sealed

Result of parsing markdown through the renderer-owned pipeline.

Inheritance

  • Object
  • MarkdownRendererParseResult

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public MarkdownSyntaxNode FindDeepestFinalNodeAtLine(Int32 lineNumber) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the final document tree whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindDeepestFinalNodeAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the final document tree whose source span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public MarkdownSyntaxNode FindDeepestFinalNodeContainingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the final document tree whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindDeepestFinalNodeOverlappingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the final document tree whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindDeepestNodeAtLine(Int32 lineNumber) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the original syntax tree whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindDeepestNodeAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the original syntax tree whose source span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public MarkdownSyntaxNode FindDeepestNodeContainingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the original syntax tree whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindDeepestNodeOverlappingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the deepest syntax node in the original syntax tree whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtLine(Int32 lineNumber) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the final document root to the deepest node containing the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the final document root to the deepest node containing the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathContainingSpan(MarkdownSourceSpan span) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the final document root to the deepest node whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathOverlappingSpan(MarkdownSourceSpan span) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the final document root to the deepest node whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockAtLine(Int32 lineNumber) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the original syntax tree whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the original syntax tree whose source span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public MarkdownSyntaxNode FindNearestBlockContainingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the original syntax tree whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockOverlappingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the original syntax tree whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestFinalBlockAtLine(Int32 lineNumber) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the final document tree whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindNearestFinalBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the final document tree whose source span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public MarkdownSyntaxNode FindNearestFinalBlockContainingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the final document tree whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestFinalBlockOverlappingSpan(MarkdownSourceSpan span) #
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node in the final document tree whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtLine(Int32 lineNumber) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the original document root to the deepest node containing the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtPosition(Int32 lineNumber, Int32 columnNumber) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the original document root to the deepest node containing the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathContainingSpan(MarkdownSourceSpan span) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the original document root to the deepest node whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathOverlappingSpan(MarkdownSourceSpan span) #
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the syntax node path from the original document root to the deepest node whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0

Properties

public MarkdownDoc Document { get; } #

The final renderer-owned markdown document after parsing and renderer transforms.

public String PreprocessedMarkdown { get; } #

The final markdown text after renderer preprocessing and before parsing.

public String SourceMarkdown { get; } #

The reader-normalized markdown source text used to compute syntax source spans.

public String OriginalMarkdown { get; } #

The original reader 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.

public MarkdownSyntaxNode SyntaxTree { get; } #

The original syntax tree produced before document transforms were applied.

public MarkdownSyntaxNode FinalSyntaxTree { get; } #

The syntax tree corresponding to the final renderer-owned Document.

public IReadOnlyList<MarkdownDocumentTransformDiagnostic> TransformDiagnostics { get; } #

Document-transform diagnostics from the reader and renderer pipelines.

public IReadOnlyList<MarkdownRendererPreProcessorDiagnostic> PreProcessorDiagnostics { get; } #

Renderer pre-parse processing diagnostics.

public IReadOnlyList<MarkdownReferenceLinkDefinition> ReferenceLinkDefinitions { get; } #

Effective reference-style link definitions collected by the reader parse.

public IReadOnlyList<MarkdownAbbreviationDefinition> AbbreviationDefinitions { get; } #

Effective abbreviation definitions collected by the reader parse.