API Reference
MarkdownParseResult
Result of parsing markdown into both the object model and a syntax tree.
Inheritance
- Object
- MarkdownParseResult
Methods
public MarkdownSyntaxNode FindDeepestFinalNodeAtLine(Int32 lineNumber) #MarkdownSyntaxNodeFinds the deepest syntax node in the final document tree whose source span contains the given 1-based line number.
Parameters
- lineNumber System.Int32
public MarkdownSyntaxNode FindDeepestFinalNodeAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownSyntaxNodeFinds the deepest syntax node in the final document tree whose source span contains the given 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownSyntaxNode FindDeepestFinalNodeContainingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the deepest syntax node in the final document tree whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindDeepestFinalNodeOverlappingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the deepest syntax node in the final document tree whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindDeepestNodeAtLine(Int32 lineNumber) #MarkdownSyntaxNodeFinds the deepest syntax node whose source span contains the given 1-based line number.
Parameters
- lineNumber System.Int32
public MarkdownSyntaxNode FindDeepestNodeAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownSyntaxNodeFinds the deepest syntax node whose source span contains the given 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownSyntaxNode FindDeepestNodeContainingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the deepest syntax node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindDeepestNodeOverlappingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the deepest syntax node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtLine(Int32 lineNumber) #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
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathAtPosition(Int32 lineNumber, Int32 columnNumber) #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
- columnNumber System.Int32
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathContainingSpan(MarkdownSourceSpan span) #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
public IReadOnlyList<MarkdownSyntaxNode> FindFinalNodePathOverlappingSpan(MarkdownSourceSpan span) #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
public MarkdownSyntaxNode FindNearestBlockAtLine(Int32 lineNumber) #MarkdownSyntaxNodeFinds the nearest block-like syntax node whose source span contains the given 1-based line number.
Parameters
- lineNumber System.Int32
public MarkdownSyntaxNode FindNearestBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownSyntaxNodeFinds the nearest block-like syntax node whose source span contains the given 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownSyntaxNode FindNearestBlockContainingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the nearest block-like syntax node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindNearestBlockOverlappingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the nearest block-like syntax node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindNearestFinalBlockAtLine(Int32 lineNumber) #MarkdownSyntaxNodeFinds 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
public MarkdownSyntaxNode FindNearestFinalBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownSyntaxNodeFinds 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
- columnNumber System.Int32
public MarkdownSyntaxNode FindNearestFinalBlockContainingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the nearest block-like syntax node in the final document tree whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public MarkdownSyntaxNode FindNearestFinalBlockOverlappingSpan(MarkdownSourceSpan span) #MarkdownSyntaxNodeFinds the nearest block-like syntax node in the final document tree whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtLine(Int32 lineNumber) #IReadOnlyList<MarkdownSyntaxNode>Finds the syntax node path from the document root to the deepest node containing the given 1-based line number.
Parameters
- lineNumber System.Int32
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtPosition(Int32 lineNumber, Int32 columnNumber) #IReadOnlyList<MarkdownSyntaxNode>Finds the syntax node path from the document root to the deepest node containing the given 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathContainingSpan(MarkdownSourceSpan span) #IReadOnlyList<MarkdownSyntaxNode>Finds the syntax node path from the document root to the deepest node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathOverlappingSpan(MarkdownSourceSpan span) #IReadOnlyList<MarkdownSyntaxNode>Finds the syntax node path from the document root to the deepest node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public MarkdownDoc Document { get; } #The parsed markdown object model.
public MarkdownSyntaxNode SyntaxTree { get; } #The original syntax tree produced before document transforms were applied. When a transform replaces the document instance, this tree intentionally drops semantic AssociatedObject bindings to avoid stale object references. Use FinalSyntaxTree for syntax-to-model navigation against Document.
public MarkdownSyntaxNode FinalSyntaxTree { get; } #The syntax tree corresponding to the final returned Document.
public IReadOnlyList<MarkdownDocumentTransformDiagnostic> TransformDiagnostics { get; } #Optional document-transform diagnostics captured during parsing.