OfficeIMO

API Reference

Class

ListItem

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers sealed

List item content; supports plain and task (checklist) items.

Inheritance

Constructors

public ListItem(InlineSequence content) #

Creates a plain list item.

Parameters

content OfficeIMO.Markdown.InlineSequence requiredposition: 0

Methods

public static ListItem Task(String text, Boolean done = false) #
Returns: ListItem

Creates a task (checklist) item.

Parameters

text System.String requiredposition: 0
done System.Boolean = false optionalposition: 1
public static ListItem TaskInlines(InlineSequence content, Boolean done = false) #
Returns: ListItem

Creates a task (checklist) item using inline content.

Parameters

content OfficeIMO.Markdown.InlineSequence requiredposition: 0
Inline content for the list item. When null, an empty sequence is used.
done System.Boolean = false optionalposition: 1
Whether the task should be marked as completed.
public static ListItem Text(String text) #
Returns: ListItem

Creates a plain text item.

Parameters

text System.String requiredposition: 0

Properties

public InlineSequence Content { get; } #

Inlines representing item content.

public List<InlineSequence> AdditionalParagraphs { get; } #

Additional paragraphs inside the list item (multi-paragraph list items).

public IReadOnlyList<ParagraphBlock> ParagraphBlocks { get; } #

Paragraph blocks owned by this list item. This exposes list-item paragraph content as blocks for AST-style consumers.

public List<IMarkdownBlock> Children { get; } #

Nested block content inside the list item (e.g., nested ordered/unordered lists, code blocks).

public IReadOnlyList<IMarkdownBlock> ChildBlocks { get; } #

Read-only AST-style view of nested child blocks inside the list item.

public IReadOnlyList<IMarkdownBlock> BlockChildren { get; } #

Ordered AST-style view of all list-item child blocks, including lead paragraphs.

public Boolean IsTask { get; } #

True when rendered as a task item (- [ ] or - [x]).

public Boolean Checked { get; } #

Whether the task is checked.

public Int32 Level { get; set; } #

Indentation level (0 = top-level). Used for nested lists.

public Boolean ForceLoose { get; set; } #

Forces paragraph-wrapped loose rendering even when only the first paragraph and child blocks exist.