MarkdownSyntaxWalker Class

Visits a Markdown node and everything below it.

public class MarkdownSyntaxWalker : MarkdownSyntaxVisitor
Inheritance
MarkdownSyntaxVisitor MarkdownSyntaxWalker

Constructors

NameDescription
MarkdownSyntaxWalker(SyntaxWalkerDepth)
MarkdownSyntaxWalker(SyntaxWalkerDepth, bool)

MarkdownSyntaxWalker overloads

MarkdownSyntaxWalker(SyntaxWalkerDepth)

MarkdownSyntaxWalker.cs
public MarkdownSyntaxWalker(SyntaxWalkerDepth depth = (SyntaxWalkerDepth)0)
Parameters
depth SyntaxWalkerDepth

No documentation is available.

MarkdownSyntaxWalker(SyntaxWalkerDepth, bool)

MarkdownSyntaxWalker.cs
public MarkdownSyntaxWalker(SyntaxWalkerDepth depth, bool visitGridTableCells)
Parameters
depth SyntaxWalkerDepth
How far down the walker goes.
visitGridTableCells bool
Whether the walker visits the content of the cells of the grid tables, which is not part of the tree: after the children of a grid table, the document of each of its cells, row by row.
Example
var options = new MarkdownParseOptions { Extensions = MarkdownExtensions.GridTables };
var tree = MarkdownSyntaxTree.ParseText("[a](/u)\n\n+---------+---------+\n| [b](/v) | [c](/w) |\n+---------+---------+\n", options);

var collector = new LinkCollector();
collector.Visit(tree.GetRoot());

Assert.Equal(["/u", "/v", "/w"], collector.Links.Select(link => link.Destination));

Properties

NameDescription
DepthGets how far down this walker goes.
VisitsGridTableCellsGets a value indicating whether this walker visits the content of the cells of the grid tables: the document of each cell, whose positions are in the text of the cell (see MarkdownGridTableCell.MapSpan).

Gets how far down this walker goes.

protected SyntaxWalkerDepth Depth { get; }

Property value

SyntaxWalkerDepth

VisitsGridTableCells

MarkdownSyntaxWalker.cs

Gets a value indicating whether this walker visits the content of the cells of the grid tables: the document of each cell, whose positions are in the text of the cell (see MarkdownGridTableCell.MapSpan).

protected bool VisitsGridTableCells { get; }

Property value

bool

Methods

NameDescription
DefaultVisit(MarkdownSyntaxNode)
VisitToken(SyntaxToken)
VisitTrivia(SyntaxTrivia)

DefaultVisit(MarkdownSyntaxNode)

MarkdownSyntaxWalker.cs
public override void DefaultVisit(MarkdownSyntaxNode node)

Parameters

node MarkdownSyntaxNode

Exceptions

InsufficientExecutionStackException
The document is nested too deeply to walk.

VisitToken(SyntaxToken)

MarkdownSyntaxWalker.cs
public virtual void VisitToken(SyntaxToken token)

Parameters

token SyntaxToken

No documentation is available.

VisitTrivia(SyntaxTrivia)

MarkdownSyntaxWalker.cs
public virtual void VisitTrivia(SyntaxTrivia trivia)

Parameters

trivia SyntaxTrivia

No documentation is available.