API Reference

Class

DefinitionListBlock

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

Definition list rendered as term/definition pairs. Markdown output uses a simple "Term: Definition" fallback; HTML uses <dl>.

Inheritance

Usage

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

Constructors

public DefinitionListBlock() #

Creates a definition list block.

Methods

AddEntry 2 overloads
public Void AddEntry(DefinitionListEntry entry) #
Returns: Void

Adds a typed definition list entry.

Parameters

entry OfficeIMO.Markdown.DefinitionListEntry requiredposition: 0
public Void AddEntry(String term, String definition) #
Returns: Void

Adds a definition-list entry parsed from Markdown term and definition text.

Parameters

term System.String requiredposition: 0
definition System.String requiredposition: 1
public Void AddGroup(DefinitionListGroup group) #
Returns: Void

Adds a semantic definition-list group.

Parameters

group OfficeIMO.Markdown.DefinitionListGroup requiredposition: 0
OfficeIMO#Markdown#IMarkdownBlock#RenderHtml() #
OfficeIMO#Markdown#IMarkdownBlock#RenderMarkdown() #

Properties

public IReadOnlyList<DefinitionListGroup> Groups { get; } #

Semantic definition-list groups with shared terms and definition bodies.

public IReadOnlyList<DefinitionListEntry> Entries { get; } #

Typed definition list entries.

public IReadOnlyList<DefinitionListInlineItem> InlineItems { get; } #

Parsed inline representation of the current definition list items.

public IReadOnlyList<IMarkdownBlock> ChildBlocks { get; } #

Structured definition body blocks flattened across all groups and definitions.