API Reference

Class

MarkdownAbbreviationDefinition

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers sealed

Markdig-style abbreviation definition collected while parsing, such as *[HTML]: Hyper Text Markup Language.

Inheritance

  • Object
  • MarkdownAbbreviationDefinition

Usage

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

Accepted by parameters

Constructors

public MarkdownAbbreviationDefinition(String label, String title, Nullable<MarkdownSourceSpan> sourceSpan = null, Nullable<MarkdownSourceSpan> labelSourceSpan = null, Nullable<MarkdownSourceSpan> titleSourceSpan = null, Nullable<MarkdownSourceSpan> openingMarkerSourceSpan = null, Nullable<MarkdownSourceSpan> separatorMarkerSourceSpan = null, Boolean isListItemDefinition = false) #

Creates an abbreviation definition descriptor.

Parameters

label System.String requiredposition: 0
title System.String requiredposition: 1
sourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 2
labelSourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 3
titleSourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 4
openingMarkerSourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 5
separatorMarkerSourceSpan System.Nullable{OfficeIMO.Markdown.MarkdownSourceSpan} = null optionalposition: 6
isListItemDefinition System.Boolean = false optionalposition: 7

Properties

public String Label { get; } #

Source spelling that should be expanded when it appears as a standalone inline token.

public String Title { get; } #

Title rendered on the resulting <abbr> element.

public Nullable<MarkdownSourceSpan> SourceSpan { get; } #

Source span for the entire abbreviation definition, when available.

public Nullable<MarkdownSourceSpan> LabelSourceSpan { get; } #

Source span for the abbreviation label token, when available.

public Nullable<MarkdownSourceSpan> OpeningMarkerSourceSpan { get; } #

Source span for the opening *[ marker, when available.

public Nullable<MarkdownSourceSpan> SeparatorMarkerSourceSpan { get; } #

Source span for the closing ]: marker, when available.

public Nullable<MarkdownSourceSpan> TitleSourceSpan { get; } #

Source span for the title token, when available.

public Boolean IsListItemDefinition { get; } #

Whether the definition was authored as leading content inside a list item.