MarkdownSyntaxNode
OfficeIMO.Markdown
A lightweight syntax-tree node built from the parsed markdown document.
Inheritance
- object
- MarkdownSyntaxNode
Usage
Explore 121 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 92
- Method ISyntaxMarkdownBlock.BuildSyntaxNode
- Method ISyntaxMarkdownBlockWithContext.BuildSyntaxNode
- Method ISyntaxMarkdownInline.BuildSyntaxNode
- Method MarkdownBlockSyntaxBuilderContext.BuildBlock
- Method MarkdownBlockSyntaxBuilderContext.BuildChildSyntaxNodes
- Method MarkdownBlockSyntaxBuilderContext.BuildInlineContainerNode
- Method MarkdownBlockSyntaxBuilderContext.BuildOwnedChildSyntaxNodes
- Method MarkdownBodyRenderContext.FindSyntaxNode
- Method MarkdownDocumentTransformContext.FindSyntaxNode
- Property MarkdownDocumentTransformContext.SyntaxTree
- Property MarkdownGeneratedSyntaxDiagnostic.SyntaxNode
- Method MarkdownInlineHtmlRenderContext.FindSyntaxNode
- Method MarkdownInlineMarkdownRenderContext.FindSyntaxNode
- Method MarkdownInlineSyntaxBuilderContext.BuildChildren
- Property MarkdownNativeBlock.SyntaxNode
- Property MarkdownNativeCalloutBlock.SyntaxNode
- Property MarkdownNativeCodeBlock.SyntaxNode
- Property MarkdownNativeCustomContainerBlock.SyntaxNode
- Property MarkdownNativeDefinitionListBlock.SyntaxNode
- Property MarkdownNativeDefinitionListDefinition.SyntaxNode
- Property MarkdownNativeDefinitionListGroup.SyntaxNode
- Property MarkdownNativeDefinitionListTerm.SyntaxNode
- Property MarkdownNativeDetailsBlock.SyntaxNode
- Property MarkdownNativeDocument.FinalSyntaxTree
- Property MarkdownNativeDocument.SyntaxTree
- Property MarkdownNativeFootnoteDefinitionBlock.SyntaxNode
- Property MarkdownNativeFrontMatterBlock.SyntaxNode
- Property MarkdownNativeHeadingBlock.SyntaxNode
- Property MarkdownNativeHtmlBlock.SyntaxNode
- Property MarkdownNativeImageBlock.SyntaxNode
- Property MarkdownNativeInline.SyntaxNode
- Property MarkdownNativeInlineMetadata.SyntaxNode
- Property MarkdownNativeListBlock.SyntaxNode
- Property MarkdownNativeListItem.SyntaxNode
- Property MarkdownNativeListItemParagraph.SyntaxNode
- Property MarkdownNativeOtherBlock.SyntaxNode
- Property MarkdownNativeParagraphBlock.SyntaxNode
- Property MarkdownNativeQuoteBlock.SyntaxNode
- Property MarkdownNativeTableBlock.SyntaxNode
- Property MarkdownNativeTableCell.SyntaxNode
- Property MarkdownNativeTableRow.SyntaxNode
- Property MarkdownNativeThematicBreakBlock.SyntaxNode
- Property MarkdownNativeVisualBlock.SyntaxNode
- Method MarkdownParseInfo.FindDeepestFinalNodeAtLine
- Method MarkdownParseInfo.FindDeepestFinalNodeAtPosition
- Method MarkdownParseInfo.FindDeepestFinalNodeContainingSpan
- Method MarkdownParseInfo.FindDeepestFinalNodeOverlappingSpan
- Method MarkdownParseInfo.FindDeepestNodeAtLine
- Method MarkdownParseInfo.FindDeepestNodeAtPosition
- Method MarkdownParseInfo.FindDeepestNodeContainingSpan
- Method MarkdownParseInfo.FindDeepestNodeOverlappingSpan
- Method MarkdownParseInfo.FindFinalNodeForAssociatedObject
- Method MarkdownParseInfo.FindFinalNodePathAtLine
- Method MarkdownParseInfo.FindFinalNodePathAtPosition
- Method MarkdownParseInfo.FindFinalNodePathContainingSpan
- Method MarkdownParseInfo.FindFinalNodePathOverlappingSpan
- Method MarkdownParseInfo.FindNearestBlockAtLine
- Method MarkdownParseInfo.FindNearestBlockAtPosition
- Method MarkdownParseInfo.FindNearestBlockContainingSpan
- Method MarkdownParseInfo.FindNearestBlockOverlappingSpan
- Method MarkdownParseInfo.FindNearestFinalBlockAtLine
- Method MarkdownParseInfo.FindNearestFinalBlockAtPosition
- Method MarkdownParseInfo.FindNearestFinalBlockContainingSpan
- Method MarkdownParseInfo.FindNearestFinalBlockOverlappingSpan
- Method MarkdownParseInfo.FindNodePathAtLine
- Method MarkdownParseInfo.FindNodePathAtPosition
- Method MarkdownParseInfo.FindNodePathContainingSpan
- Method MarkdownParseInfo.FindNodePathOverlappingSpan
- Property MarkdownParseInfo.FinalSyntaxTree
- Property MarkdownParseInfo.SyntaxTree
- Method MarkdownSyntaxNode.Ancestors
- Method MarkdownSyntaxNode.AncestorsAndSelf
- Method MarkdownSyntaxNode.Descendants
- Method MarkdownSyntaxNode.DescendantsAndSelf
- Method MarkdownSyntaxNode.FindDeepestNodeAtLine
- Method MarkdownSyntaxNode.FindDeepestNodeAtPosition
- Method MarkdownSyntaxNode.FindDeepestNodeContainingSpan
- Method MarkdownSyntaxNode.FindDeepestNodeOverlappingSpan
- Method MarkdownSyntaxNode.FindNearestBlockAtLine
- Method MarkdownSyntaxNode.FindNearestBlockAtPosition
- Method MarkdownSyntaxNode.FindNearestBlockContainingSpan
- Method MarkdownSyntaxNode.FindNearestBlockOverlappingSpan
- Method MarkdownSyntaxNode.FindNodePathAtLine
- Method MarkdownSyntaxNode.FindNodePathAtPosition
- Method MarkdownSyntaxNode.FindNodePathContainingSpan
- Method MarkdownSyntaxNode.FindNodePathOverlappingSpan
- Property MarkdownSyntaxNode.Children
- Property MarkdownSyntaxNode.NextSibling
- Property MarkdownSyntaxNode.Parent
- Property MarkdownSyntaxNode.PreviousSibling
- Property MarkdownSyntaxNode.Root
- Method MarkdownWriteContext.FindSyntaxNode
Accepted by parameters 29
- Method MarkdownBlockSyntaxBuilderContext.GetAggregateSpan
- Method MarkdownBodyRenderContext.TryCreateOriginalSourceSlice
- Method MarkdownBodyRenderContext.TryCreateSourceSlice
- Constructor MarkdownDocumentTransformContext.MarkdownDocumentTransformContext
- Method MarkdownDocumentTransformContext.TryCreateOriginalSourceSlice
- Method MarkdownDocumentTransformContext.TryCreateSourceSlice
- Method MarkdownInlineHtmlRenderContext.TryCreateOriginalSourceSlice
- Method MarkdownInlineHtmlRenderContext.TryCreateSourceSlice
- Method MarkdownInlineMarkdownRenderContext.TryCreateOriginalSourceSlice
- Method MarkdownInlineMarkdownRenderContext.TryCreateSourceSlice
- Method MarkdownInlineSyntaxBuilderContext.GetAggregateSpan
- Method MarkdownParseInfo.TryCreateOriginalSourceSlice
- Method MarkdownParseInfo.TryCreateSourceMapping
- Method MarkdownParseInfo.TryCreateSourceSlice
- Method MarkdownSyntaxBlockHtmlContextualRenderer.BeginInvoke
- Method MarkdownSyntaxBlockHtmlContextualRenderer.Invoke
- Method MarkdownSyntaxBlockHtmlRenderExtension.Matches
- Method MarkdownSyntaxBlockMarkdownContextualRenderer.BeginInvoke
- Method MarkdownSyntaxBlockMarkdownContextualRenderer.Invoke
- Method MarkdownSyntaxBlockMarkdownRenderExtension.Matches
- Method MarkdownSyntaxInlineHtmlContextualRenderer.BeginInvoke
- Method MarkdownSyntaxInlineHtmlContextualRenderer.Invoke
- Method MarkdownSyntaxInlineHtmlRenderExtension.Matches
- Method MarkdownSyntaxInlineMarkdownContextualRenderer.BeginInvoke
- Method MarkdownSyntaxInlineMarkdownContextualRenderer.Invoke
- Method MarkdownSyntaxInlineMarkdownRenderExtension.Matches
- Constructor MarkdownSyntaxNode.MarkdownSyntaxNode
- Method MarkdownWriteContext.TryCreateOriginalSourceSlice
- Method MarkdownWriteContext.TryCreateSourceSlice
Constructors
public MarkdownSyntaxNode(MarkdownSyntaxKind kind, MarkdownSourceSpan? sourceSpan = null, string? literal = null, IReadOnlyList<MarkdownSyntaxNode>? children = null, object? associatedObject = null, string? customKind = null, MarkdownAttributeSet? attributes = null, bool isGenerated = false) #Create a syntax node.
Parameters
- kind OfficeIMO.Markdown.MarkdownSyntaxKind
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan? = null
- literal string? = null
- children System.Collections.Generic.IReadOnlyList<OfficeIMO.Markdown.MarkdownSyntaxNode>? = null
- associatedObject object? = null
- customKind string? = null
- attributes OfficeIMO.Markdown.MarkdownAttributeSet? = null
- isGenerated bool = false
Methods
public IEnumerable<MarkdownSyntaxNode> Ancestors() #Returns ancestor nodes from the immediate parent up to the root.
Returns
IEnumerable<MarkdownSyntaxNode>public IEnumerable<MarkdownSyntaxNode> AncestorsAndSelf() #Returns this node followed by its ancestors up to the root.
Returns
IEnumerable<MarkdownSyntaxNode>public IEnumerable<MarkdownSyntaxNode> Descendants() #Returns all descendant nodes in depth-first order, excluding this node.
Returns
IEnumerable<MarkdownSyntaxNode>public IEnumerable<MarkdownSyntaxNode> DescendantsAndSelf() #Returns this node and all descendant nodes in depth-first order.
Returns
IEnumerable<MarkdownSyntaxNode>public MarkdownSyntaxNode? FindDeepestNodeAtLine(int lineNumber) #Finds the deepest node whose source span contains the given 1-based line number.
Parameters
- lineNumber int
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindDeepestNodeAtPosition(int lineNumber, int columnNumber) #Finds the deepest node whose source span contains the given 1-based line and column.
Parameters
- lineNumber int
- columnNumber int
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindDeepestNodeContainingSpan(MarkdownSourceSpan span) #Finds the deepest node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindDeepestNodeOverlappingSpan(MarkdownSourceSpan span) #Finds the deepest node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindNearestBlockAtLine(int lineNumber) #Finds the nearest block-like syntax node whose source span contains the given 1-based line number.
Parameters
- lineNumber int
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindNearestBlockAtPosition(int lineNumber, int columnNumber) #Finds the nearest block-like syntax node whose source span contains the given 1-based line and column.
Parameters
- lineNumber int
- columnNumber int
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindNearestBlockContainingSpan(MarkdownSourceSpan span) #Finds the nearest block-like syntax node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
MarkdownSyntaxNode?public MarkdownSyntaxNode? FindNearestBlockOverlappingSpan(MarkdownSourceSpan span) #Finds the nearest block-like syntax node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
MarkdownSyntaxNode?public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtLine(int lineNumber) #Finds the node path from this node to the deepest node whose source span contains the given 1-based line number.
Parameters
- lineNumber int
Returns
IReadOnlyList<MarkdownSyntaxNode>public IReadOnlyList<MarkdownSyntaxNode> FindNodePathAtPosition(int lineNumber, int columnNumber) #Finds the node path from this node to the deepest node whose source span contains the given 1-based line and column.
Parameters
- lineNumber int
- columnNumber int
Returns
IReadOnlyList<MarkdownSyntaxNode>public IReadOnlyList<MarkdownSyntaxNode> FindNodePathContainingSpan(MarkdownSourceSpan span) #Finds the node path from this node to the deepest node whose source span fully contains the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
IReadOnlyList<MarkdownSyntaxNode>public IReadOnlyList<MarkdownSyntaxNode> FindNodePathOverlappingSpan(MarkdownSourceSpan span) #Finds the node path from this node to the deepest node whose source span overlaps the given span.
Parameters
- span OfficeIMO.Markdown.MarkdownSourceSpan
Returns
IReadOnlyList<MarkdownSyntaxNode>Inherited Methods
Properties
public MarkdownSourceSpan? SourceSpan { get; } #Optional source span from the original markdown.
public string? Literal { get; } #Optional literal payload for leaf-like nodes.
public string? CustomKind { get; } #Optional custom extension kind for nodes emitted by syntax-aware extensions.
public object? AssociatedObject { get; } #Optional originating model object (document/block/inline) for AST-aware consumers.
public MarkdownAttributeSet Attributes { get; } #Generic Markdown attributes associated with this syntax node.
public bool IsGenerated { get; } #Gets a value indicating whether this node was generated while rebuilding syntax from the semantic AST rather than directly parsed from matching source text.
public MarkdownSyntaxNode? Parent { get; private set; } #Parent syntax node when this node belongs to a larger syntax tree.
public IReadOnlyList<MarkdownSyntaxNode> Children { get; } #Child syntax nodes.
public bool IsBlockLike { get; } #Whether this node behaves like a block/container boundary for navigation.
public int IndexInParent { get; } #Zero-based child index within MarkdownSyntaxNode.Parent when available.
public MarkdownSyntaxNode? PreviousSibling { get; } #Nearest previous sibling node when present.
public MarkdownSyntaxNode? NextSibling { get; } #Nearest next sibling node when present.