PipeTableOptions Class

Options for the extension PipeTableExtension

public class PipeTableOptions

Constructors

NameDescription
PipeTableOptions()Initializes a new instance of the PipeTableOptions class.

PipeTableOptions()

PipeTableOptions.cs

Initializes a new instance of the PipeTableOptions class.

public PipeTableOptions()

Properties

NameDescription
InferColumnWidthsFromSeparatorGets or sets a value indicating whether column widths should be inferred based on the number of dashes in the header separator row. Each column's width will be proportional to the dash count in its respective column.
RequireHeaderSeparatorGets or sets a value indicating whether to require header separator. true by default (Kramdown is using false)
UseGfmRulesGets or sets a value indicating whether to use GitHub Flavored Markdown table parsing rules. false by default, preserving the permissive pipe-table syntax.
UseHeaderForColumnCountDefines whether table should be normalized to the amount of columns as defined in the table header. false by default If true, this will insert empty cells in rows with fewer tables than the header row and remove cells that are exceeding the header column count. If false, this will use the row with the most columns to determine how many cells should be inserted in all other rows (default behavior).

InferColumnWidthsFromSeparator

PipeTableOptions.cs

Gets or sets a value indicating whether column widths should be inferred based on the number of dashes in the header separator row. Each column's width will be proportional to the dash count in its respective column.

public bool InferColumnWidthsFromSeparator { get; set; }

Property value

bool

RequireHeaderSeparator

PipeTableOptions.cs

Gets or sets a value indicating whether to require header separator. true by default (Kramdown is using false)

public bool RequireHeaderSeparator { get; set; }

Property value

bool

Gets or sets a value indicating whether to use GitHub Flavored Markdown table parsing rules. false by default, preserving the permissive pipe-table syntax.

public bool UseGfmRules { get; set; }

Property value

bool

Remarks

Requires a nonempty delimiter for every header cell and matching header/delimiter cell counts. Splits cells before parsing inlines, supports escaped pipes in code spans, and pads or truncates body rows to the header width. Overrides PipeTableOptions.RequireHeaderSeparator and PipeTableOptions.UseHeaderForColumnCount. PipeTableOptions.InferColumnWidthsFromSeparator remains available.

UseHeaderForColumnCount

PipeTableOptions.cs

Defines whether table should be normalized to the amount of columns as defined in the table header. false by default If true, this will insert empty cells in rows with fewer tables than the header row and remove cells that are exceeding the header column count. If false, this will use the row with the most columns to determine how many cells should be inserted in all other rows (default behavior).

public bool UseHeaderForColumnCount { get; set; }

Property value

bool