Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

Entry (FrontMatterBlock)

OfficeIMO.Markdown.FrontMatterBlock

Namespace
OfficeIMO.Markdown.FrontMatterBlock
Assembly
OfficeIMO.Markdown
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

One top-level entry of the front matter, with its Markdown source spans when parsed.

Inheritance

  • object
  • Entry (FrontMatterBlock)

Properties

public string Key { get; } #

Entry key text.

public YamlNode Value { get; } #

Entry value as a YAML node: read scalars with YamlNode.GetValue or YamlNode.AsString, and nested values with YamlNode.AsMapping, YamlNode.AsSequence or YamlNode.Select. TOML values are read through the same node types: tables are mappings, arrays and arrays of tables are sequences, and dates keep their TOML spelling. Edit TOML front matter through FrontMatterBlock.Toml.

public MarkdownSourceSpan? SourceSpan { get; } #

Source span from the key to the end of the value when parsed from Markdown.

public MarkdownSourceSpan? KeySourceSpan { get; } #

Source span of the key when parsed from Markdown.

public MarkdownSourceSpan? ValueSourceSpan { get; } #

Source span of the value node, including a YAML block scalar's header, when parsed from Markdown. TOML tables and dotted keys have no single value span.