MarkdownPipeTableOptions Class

How MarkdownExtensions.PipeTables reads and renders the pipe tables, as the options of the pipe tables of Markdig.

public sealed class MarkdownPipeTableOptions : IEquatable<MarkdownPipeTableOptions>
Implements

Constructors

NameDescription
MarkdownPipeTableOptions()

MarkdownPipeTableOptions()

MarkdownPipeTableOptions.cs
public MarkdownPipeTableOptions()

No documentation is available.

Properties

NameDescription
DefaultGets the options of Markdig.
InferColumnWidthsFromSeparatorGets a value indicating whether the renderer writes the width of each column of the delimiter row, a <col> whose width is proportional to the number of dashes of the column.
RequireHeaderSeparatorGets a value indicating whether a table needs a delimiter row, true by default. When it does not, the lines of a paragraph that have a pipe, up to its end, are a table without a header row, as in Kramdown.
UseHeaderForColumnCountGets a value indicating whether a table has as many columns as its first row has cells: the renderer adds empty cells to the shorter rows and does not write the cells of the longer ones. By default, a table has as many columns as its longest row has cells.

Gets the options of Markdig.

public static MarkdownPipeTableOptions Default { get; }

InferColumnWidthsFromSeparator

MarkdownPipeTableOptions.cs

Gets a value indicating whether the renderer writes the width of each column of the delimiter row, a <col> whose width is proportional to the number of dashes of the column.

public bool InferColumnWidthsFromSeparator { get; init; }

Property value

bool

RequireHeaderSeparator

MarkdownPipeTableOptions.cs

Gets a value indicating whether a table needs a delimiter row, true by default. When it does not, the lines of a paragraph that have a pipe, up to its end, are a table without a header row, as in Kramdown.

public bool RequireHeaderSeparator { get; init; }

Property value

bool

UseHeaderForColumnCount

MarkdownPipeTableOptions.cs

Gets a value indicating whether a table has as many columns as its first row has cells: the renderer adds empty cells to the shorter rows and does not write the cells of the longer ones. By default, a table has as many columns as its longest row has cells.

public bool UseHeaderForColumnCount { get; init; }

Property value

bool

Methods

NameDescription
Equals(MarkdownPipeTableOptions?)
Equals(object?)
GetHashCode()
ToString()

Equals overloads

Equals(MarkdownPipeTableOptions?)

public bool Equals(MarkdownPipeTableOptions? other)
Parameters
other MarkdownPipeTableOptions?
Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(MarkdownPipeTableOptions?, MarkdownPipeTableOptions?)
operator !=(MarkdownPipeTableOptions?, MarkdownPipeTableOptions?)

operator ==(MarkdownPipeTableOptions?, MarkdownPipeTableOptions?)

public static bool operator ==(MarkdownPipeTableOptions? left, MarkdownPipeTableOptions? right)

No documentation is available.

operator !=(MarkdownPipeTableOptions?, MarkdownPipeTableOptions?)

public static bool operator !=(MarkdownPipeTableOptions? left, MarkdownPipeTableOptions? right)

No documentation is available.