Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

DefinitionListBlock

OfficeIMO.Markdown

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

Explore 2 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.

Constructors

public DefinitionListBlock() #

Creates a definition list block.

Methods

AddEntry 2 overloads
public DefinitionListEntry AddEntry(DefinitionListEntry entry) #

Adds a definition and returns the entry bound to this list.

Parameters

entry OfficeIMO.Markdown.DefinitionListEntry required
public DefinitionListEntry AddEntry(string? term, string? definition) #

Adds parsed term and definition text and returns the entry bound to this list.

Parameters

term string? required
definition string? required
public DefinitionListGroup AddGroup(DefinitionListGroup group) #

Adds a semantic group and returns the group stored in this list.

Parameters

group OfficeIMO.Markdown.DefinitionListGroup required

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.