API Reference

Class

FootnoteDefinitionBlock

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Implements
IMarkdownBlock IChildMarkdownBlockContainer ISyntaxChildrenMarkdownBlock IOwnedSyntaxChildrenMarkdownBlock ISyntaxMarkdownBlock IFootnoteSectionMarkdownBlock
Modifiers sealed

Footnote definition block, e.g., [^id]: content.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

FootnoteDefinitionBlock 3 overloads
public FootnoteDefinitionBlock(String label, IEnumerable<IMarkdownBlock> childBlocks) #

Create a new footnote definition.

Parameters

label System.String requiredposition: 0
Identifier used by references.
text System.String requiredposition: 1
Definition text.
FootnoteDefinitionBlock(System.String label, System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} childBlocks) #

Creates a footnote definition with structured body blocks. Prefer this overload when the footnote body contains lists, code blocks, or other nested markdown structure.

Parameters

label System.String required
childBlocks System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} required
public FootnoteDefinitionBlock(String label, String text, IEnumerable<IMarkdownBlock> childBlocks) #

Creates a footnote definition with structured body blocks and fallback text for empty-block scenarios.

Parameters

label System.String requiredposition: 0
text System.String requiredposition: 1
childBlocks System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} requiredposition: 2

Properties

public String Label { get; } #

Footnote label (identifier without the leading ^).

public Nullable<MarkdownSourceSpan> OpeningMarkerSourceSpan { get; set; } #

Source span for the opening [^ marker when parsed from markdown.

public Nullable<MarkdownSourceSpan> LabelSourceSpan { get; set; } #

Source span for the footnote label token when parsed from markdown.

public Nullable<MarkdownSourceSpan> SeparatorMarkerSourceSpan { get; set; } #

Source span for the ]: separator marker when parsed from markdown.

public String Text { get; } #

Footnote text content. When parsed child blocks are available, this is derived from them.

public IReadOnlyList<IMarkdownBlock> ChildBlocks { get; } #

Structured child blocks that form the canonical footnote body. Paragraph-only footnotes keep this aligned with ParagraphBlocks, while richer producers can preserve headings, code blocks, and other block types here.

public IReadOnlyList<InlineSequence> Paragraphs { get; } #

Parsed paragraphs of the footnote definition, derived from ChildBlocks. When empty, renderers may fall back to parsing Text as a single inline sequence.

public IReadOnlyList<ParagraphBlock> ParagraphBlocks { get; } #

Parsed paragraph blocks of the footnote definition, derived from ChildBlocks. This exposes footnote content as owned block children for AST-style consumers.