MarkdownList
Namespace: TagBites.Text.Markdown
Assembly: TagBites.Text.Markdown.dll
Product: TagBites.Text.Markdown v. 2.2.0
A list of items, written with the - marker.
public class MarkdownList : TagBites.Text.Markdown.MarkdownElementInheritance: object → MarkdownElement → MarkdownList
Constructors
Section titled “Constructors”MarkdownList()
Section titled “MarkdownList()”public MarkdownList()Properties
Section titled “Properties”IsOrdered
Section titled “IsOrdered”Gets or sets a value indicating whether the items are numbered.
public bool IsOrdered { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Default: false, which writes the - marker.
Gets the items of the list.
public IList<MarkdownListItem> Items { get; }Property Value
Section titled “Property Value”StartNumber
Section titled “StartNumber”Gets or sets the number the first item carries.
public int StartNumber { get; set; }Property Value
Section titled “Property Value”Exceptions
Section titled “Exceptions”- ArgumentOutOfRangeException - The value is negative.
Remarks
Section titled “Remarks”Applies only when IsOrdered is true, and continues a list that another block interrupted. Default: 1.
Methods
Section titled “Methods”AddCheckItem(bool, MarkdownText)
Section titled “AddCheckItem(bool, MarkdownText)”Adds an item with a check box and returns it.
public MarkdownListItem AddCheckItem(bool isChecked, MarkdownText text)Parameters
Section titled “Parameters”isCheckedbooltextMarkdownText
Returns
Section titled “Returns”Remarks
Section titled “Remarks”One list holds items with and without a check box, which is what the spec allows.
AddItem(MarkdownText)
Section titled “AddItem(MarkdownText)”Adds an item and returns it.
public MarkdownListItem AddItem(MarkdownText text)Parameters
Section titled “Parameters”textMarkdownText
Returns
Section titled “Returns”Resolve(MarkdownRenderer)
Section titled “Resolve(MarkdownRenderer)”Writes the element into renderer.
protected internal virtual void Resolve(MarkdownRenderer renderer)Parameters
Section titled “Parameters”rendererMarkdownRenderer