API Reference

Class

MarkdownAttributeSet

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers sealed

Generic Markdown attributes attached to semantic objects and syntax nodes.

Inheritance

  • Object
  • MarkdownAttributeSet

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

Accepted by parameters

Methods

public static MarkdownAttributeSet Create(String elementId = null, IEnumerable<String> classes = null, IEnumerable<KeyValuePair<String, String>> attributes = null) #
Returns: MarkdownAttributeSet

Create a generic Markdown attribute set.

Parameters

elementId System.String = null optionalposition: 0
classes System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 1
attributes System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}} = null optionalposition: 2
public String GetAttribute(params String[] aliases) #
Returns: String

Reads the first matching attribute value by alias.

Parameters

aliases System.String[] requiredposition: 0
public Boolean HasClass(String className) #
Returns: Boolean

Checks whether a class is present using ordinal comparison.

Parameters

className System.String requiredposition: 0
public Boolean TryGetAttribute(String name, out String value) #
Returns: Boolean

Reads an attribute value by key.

Parameters

name System.String requiredposition: 0
value System.String@ requiredposition: 1

Properties

public static MarkdownAttributeSet Empty { get; } #

Empty attribute set used by nodes without generic attributes.

public String ElementId { get; } #

Optional element id associated with the Markdown node.

public IReadOnlyList<String> Classes { get; } #

CSS-like classes associated with the Markdown node.

public IReadOnlyDictionary<String, String> Attributes { get; } #

Additional key/value attributes associated with the Markdown node.

public Boolean IsEmpty { get; } #

Whether the set has no id, classes, or key/value attributes.