Get Started

API Reference

Class

MarkdownSyntaxNode

Edit on GitHub
Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Source OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:33
Modifiers sealed

A lightweight syntax-tree node built from the parsed markdown document.

Inheritance

  • Object
  • MarkdownSyntaxNode

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

Accepted by parameters

Constructors

public MarkdownSyntaxNode(MarkdownSyntaxKind kind, Nullable<MarkdownSourceSpan> sourceSpan = null, String literal = null, IReadOnlyList<MarkdownSyntaxNode> children = null, Object associatedObject = null, String customKind = null) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:33

Create a syntax node.

Parameters

kind OfficeIMO.Markdown.MarkdownSyntaxKind requiredposition: 0
sourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 1
literal System.String = null optionalposition: 2
children System.Collections.Generic.IReadOnlyList{OfficeIMO.Markdown.MarkdownSyntaxNode} = null optionalposition: 3
associatedObject System.Object = null optionalposition: 4
customKind System.String = null optionalposition: 5

Methods

public IEnumerable<MarkdownSyntaxNode> Ancestors() #
Returns: IEnumerable<MarkdownSyntaxNode>

Returns ancestor nodes from the immediate parent up to the root.

public IEnumerable<MarkdownSyntaxNode> AncestorsAndSelf() #
Returns: IEnumerable<MarkdownSyntaxNode>

Returns this node followed by its ancestors up to the root.

public IEnumerable<MarkdownSyntaxNode> Descendants() #
Returns: IEnumerable<MarkdownSyntaxNode>

Returns all descendant nodes in depth-first order, excluding this node.

public IEnumerable<MarkdownSyntaxNode> DescendantsAndSelf() #
Returns: IEnumerable<MarkdownSyntaxNode>

Returns this node and all descendant nodes in depth-first order.

public MarkdownSyntaxNode FindDeepestNodeAtLine(Int32 lineNumber) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:86
Returns: MarkdownSyntaxNode

Finds the deepest node whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindDeepestNodeAtPosition(Int32 lineNumber, Int32 columnNumber) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:99
Returns: MarkdownSyntaxNode

Finds the deepest node 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) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:126
Returns: MarkdownSyntaxNode

Finds the deepest node whose source span fully contains the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindDeepestNodeOverlappingSpan(MarkdownSourceSpan span) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:153
Returns: MarkdownSyntaxNode

Finds the deepest node whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockAtLine(Int32 lineNumber) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:179
Returns: MarkdownSyntaxNode

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

Parameters

lineNumber System.Int32 requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:182
Returns: MarkdownSyntaxNode

Finds the nearest block-like syntax node 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) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:185
Returns: MarkdownSyntaxNode

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

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
public MarkdownSyntaxNode FindNearestBlockOverlappingSpan(MarkdownSourceSpan span) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:188
Returns: MarkdownSyntaxNode

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

Parameters

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

Finds the node path from this node to the deepest node whose source span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtPosition(Int32 lineNumber, Int32 columnNumber) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:119
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the node path from this node to the deepest node whose source span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1
public IReadOnlyList<MarkdownSyntaxNode> FindNodePathContainingSpan(MarkdownSourceSpan span) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:146
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the node path from this node 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) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:173
Returns: IReadOnlyList<MarkdownSyntaxNode>

Finds the node path from this node to the deepest node whose source span overlaps the given span.

Parameters

span OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0

Properties

public MarkdownSyntaxKind Kind { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:8

Node kind.

public Nullable<MarkdownSourceSpan> SourceSpan { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:10

Optional source span from the original markdown.

public String Literal { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:12

Optional literal payload for leaf-like nodes.

public String CustomKind { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:14

Optional custom extension kind for nodes emitted by syntax-aware extensions.

public Object AssociatedObject { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:16

Optional originating model object (document/block/inline) for AST-aware consumers.

public MarkdownSyntaxNode Parent { get; set; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:18

Parent syntax node when this node belongs to a larger syntax tree.

public IReadOnlyList<MarkdownSyntaxNode> Children { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:20

Child syntax nodes.

public Boolean IsBlockLike { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:22

Whether this node behaves like a block/container boundary for navigation.

public Int32 IndexInParent { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:24

Zero-based child index within Parent when available.

public MarkdownSyntaxNode PreviousSibling { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:26

Nearest previous sibling node when present.

public MarkdownSyntaxNode NextSibling { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:28

Nearest next sibling node when present.

public MarkdownSyntaxNode Root { get; } #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSyntaxNode.cs:30

Document root for this node.