API Reference

Class

CalloutBlock

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

Docs/Markdown-style callout (admonition) block. Renders using "> [!KIND] Title" followed by indented content lines.

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

Constructors

CalloutBlock 3 overloads
public CalloutBlock(String kind, InlineSequence titleInlines, IEnumerable<IMarkdownBlock> children) #

Creates a callout with the specified kind, title and body.

Parameters

kind System.String requiredposition: 0
title System.String requiredposition: 1
body System.String requiredposition: 2
CalloutBlock(System.String kind, System.String title, System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} children) #

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

Parameters

kind System.String required
title System.String required
children System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} required
CalloutBlock(System.String kind, OfficeIMO.Markdown.InlineSequence titleInlines, System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} children) #

Creates a callout with structured title inlines and structured body blocks. This is the canonical semantic shape used by parsed callouts.

Parameters

kind System.String required
titleInlines OfficeIMO.Markdown.InlineSequence required
children System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.IMarkdownBlock} required

Methods

OfficeIMO#Markdown#IMarkdownBlock#RenderHtml() #
OfficeIMO#Markdown#IMarkdownBlock#RenderMarkdown() #

Properties

public String Kind { get; } #

Admonition kind, e.g., info, warning, success.

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

Source span for the opening callout marker ([!) when parsed from markdown.

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

Source span for the callout kind token when parsed from markdown.

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

Source span for the closing callout marker (]) when parsed from markdown.

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

Source span for the explicit callout title when parsed from markdown.

public String Title { get; } #

Callout title displayed inline with the marker.

public InlineSequence TitleInlines { get; } #

Parsed inline title content when available.

public String Body { get; } #

Callout body text (can include multiple lines). Structured callouts derive this from child blocks; legacy plain-text bodies preserve the original text.

public virtual IReadOnlyList<IMarkdownBlock> ChildBlocks { get; } #

Parsed body blocks when the callout is created by the reader. This exposes callout content as owned child blocks for AST-style consumers.

SyntaxChildren #

Optional parsed body blocks. When present (produced by MarkdownReader), HTML/Markdown rendering uses these blocks instead of the raw Body string.