Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

CalloutBlock

OfficeIMO.Markdown

Namespace
OfficeIMO.Markdown
Assembly
OfficeIMO.Markdown
Source revision
0eef6a5756b9 with working tree changes
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

Explore 1 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

Constructors

CalloutBlock 3 overloads
public CalloutBlock(string kind, string title, string body) #

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

Parameters

kind string required
title string required
body string required
public CalloutBlock(string kind, string title, IEnumerable<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 string required
title string required
children System.Collections.Generic.IEnumerable<OfficeIMO.Markdown.IMarkdownBlock> required
public CalloutBlock(string kind, InlineSequence titleInlines, IEnumerable<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 string required
titleInlines OfficeIMO.Markdown.InlineSequence required
children System.Collections.Generic.IEnumerable<OfficeIMO.Markdown.IMarkdownBlock> required

Properties

public string Kind { get; } #

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

public MarkdownSourceSpan? OpeningMarkerSourceSpan { get; internal set; } #

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

public MarkdownSourceSpan? KindSourceSpan { get; internal set; } #

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

public MarkdownSourceSpan? ClosingMarkerSourceSpan { get; internal set; } #

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

public MarkdownSourceSpan? TitleSourceSpan { get; internal 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 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.