Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MarkdownRendererParseResult

OfficeIMO.MarkdownRenderer

Namespace
OfficeIMO.MarkdownRenderer
Assembly
OfficeIMO.MarkdownRenderer
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Result of parsing markdown through the renderer-owned pipeline.

Inheritance

  • object
  • MarkdownRendererParseResult

Usage

Explore 1 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.

Returned or exposed by 1

Methods

public MarkdownSyntaxNode? FindDeepestFinalNodeAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestFinalNodeAtPosition(int lineNumber, int columnNumber) #

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

Parameters

lineNumber int required
columnNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestFinalNodeContainingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestFinalNodeOverlappingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestNodeAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestNodeAtPosition(int lineNumber, int columnNumber) #

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

Parameters

lineNumber int required
columnNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestNodeContainingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindDeepestNodeOverlappingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtPosition(int lineNumber, int columnNumber) #

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

Parameters

lineNumber int required
columnNumber int required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathContainingSpan(MarkdownSourceSpan span) #

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 required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathOverlappingSpan(MarkdownSourceSpan span) #

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 required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public MarkdownSyntaxNode? FindNearestBlockAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestBlockAtPosition(int lineNumber, int columnNumber) #

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 int required
columnNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestBlockContainingSpan(MarkdownSourceSpan span) #

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 required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestBlockOverlappingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestFinalBlockAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestFinalBlockAtPosition(int lineNumber, int columnNumber) #

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 int required
columnNumber int required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestFinalBlockContainingSpan(MarkdownSourceSpan span) #

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 required

Returns

MarkdownSyntaxNode?
public MarkdownSyntaxNode? FindNearestFinalBlockOverlappingSpan(MarkdownSourceSpan span) #

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan required

Returns

MarkdownSyntaxNode?
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtLine(int lineNumber) #

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

Parameters

lineNumber int required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtPosition(int lineNumber, int columnNumber) #

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

Parameters

lineNumber int required
columnNumber int required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathContainingSpan(MarkdownSourceSpan span) #

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 required

Returns

IReadOnlyList<MarkdownSyntaxNode>
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathOverlappingSpan(MarkdownSourceSpan span) #

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 required

Returns

IReadOnlyList<MarkdownSyntaxNode>

Properties

public MarkdownDocument 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 MarkdownRendererParseResult.SourceMarkdown.

public bool PreservesOriginalMarkdown { get; } #

Indicates whether MarkdownRendererParseResult.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 MarkdownRendererParseResult.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.