MarkdownTableSyntax Class

A table of GitHub Flavored Markdown, or a pipe table of Markdig: a header row, a delimiter row, and the other rows. A pipe table that MarkdownPipeTableOptions.RequireHeaderSeparator allows has only the other rows.

public sealed class MarkdownTableSyntax : MarkdownBlockSyntax
Inheritance
MarkdownBlockSyntax MarkdownTableSyntax

Properties

NameDescription
AlignmentsGets the alignment of each column of the delimiter row.
DelimiterRowGets the delimiter row, whose cells give the alignments of the columns, or null when the table has none.
HeaderRowGets the header row, or null when the table has no delimiter row.
IsPipeTableGets a value indicating whether this is a pipe table of Markdig, read with MarkdownExtensions.PipeTables, and not a table of GitHub Flavored Markdown.
RowsGets the rows after the delimiter row, or all the rows when the table has no delimiter row.

Gets the alignment of each column of the delimiter row.

public ImmutableArray<MarkdownTableAlignment> Alignments { get; }

Property value

ImmutableArray<MarkdownTableAlignment>

Remarks

A table of GitHub Flavored Markdown has as many columns as its delimiter row has cells. A pipe table has as many columns as its longest row has cells, and the columns after the last cell of the delimiter row have its alignment. A cell of the delimiter row of a pipe table can be empty, which is a column without alignment.

Gets the delimiter row, whose cells give the alignments of the columns, or null when the table has none.

public MarkdownTableRowSyntax? DelimiterRow { get; }

Gets the header row, or null when the table has no delimiter row.

public MarkdownTableRowSyntax? HeaderRow { get; }

Gets a value indicating whether this is a pipe table of Markdig, read with MarkdownExtensions.PipeTables, and not a table of GitHub Flavored Markdown.

public bool IsPipeTable { get; }

Property value

bool

Gets the rows after the delimiter row, or all the rows when the table has no delimiter row.

Methods

NameDescription
Accept(MarkdownSyntaxVisitor)
Accept<TResult>(MarkdownSyntaxVisitor<TResult>)

Accept overloads

Accept(MarkdownSyntaxVisitor)

MarkdownTableSyntax.cs
public override void Accept(MarkdownSyntaxVisitor visitor)
Parameters
visitor MarkdownSyntaxVisitor

No documentation is available.

Accept<TResult>(MarkdownSyntaxVisitor<TResult>)

MarkdownTableSyntax.cs
public override TResult? Accept<TResult>(MarkdownSyntaxVisitor<TResult> visitor)
Type parameters
TResult
Parameters
visitor MarkdownSyntaxVisitor<TResult>
Returns

TResult?

No documentation is available.