FootnoteDefinitionBlock
OfficeIMO.Markdown
Footnote definition block, e.g., [^id]: content.
Inheritance
- MarkdownObject
- MarkdownBlock
- FootnoteDefinitionBlock
Usage
Explore 3 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Accepted by parameters 2
Constructors
public FootnoteDefinitionBlock(string label, string text) #Create a new footnote definition.
Parameters
- label string
- Identifier used by references.
- text string
- Definition text.
public FootnoteDefinitionBlock(string label, IEnumerable<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 string
- childBlocks System.Collections.Generic.IEnumerable<OfficeIMO.Markdown.IMarkdownBlock>?
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 string
- text string
- childBlocks System.Collections.Generic.IEnumerable<OfficeIMO.Markdown.IMarkdownBlock>?
Inherited Methods
public void Accept(MarkdownVisitor visitor) #Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns
IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns
IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Type Parameters
- TObject
Returns
IEnumerable<TObject>public IEnumerable<MarkdownObject> Descendants() #Returns
IEnumerable<MarkdownObject>Properties
public string Label { get; } #Footnote label (identifier without the leading ^).
public MarkdownSourceSpan? OpeningMarkerSourceSpan { get; internal set; } #Source span for the opening [^ marker when parsed from markdown.
public MarkdownSourceSpan? LabelSourceSpan { get; internal set; } #Source span for the footnote label token when parsed from markdown.
public MarkdownSourceSpan? SeparatorMarkerSourceSpan { get; internal 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. MarkdownParagraph-only footnotes keep this aligned with FootnoteDefinitionBlock.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 FootnoteDefinitionBlock.ChildBlocks. When empty, renderers may fall back to parsing FootnoteDefinitionBlock.Text as a single inline sequence.
public IReadOnlyList<ParagraphBlock> ParagraphBlocks { get; } #Parsed paragraph blocks of the footnote definition, derived from FootnoteDefinitionBlock.ChildBlocks. This exposes footnote content as owned block children for AST-style consumers.
Inherited Properties
public MarkdownSourceSpan? SourceSpan { get; internal set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #