API Reference

Class

MarkdownNativeInlineSnapshot

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers sealed

UI-safe snapshot of a native inline.

Inheritance

  • Object
  • MarkdownNativeInlineSnapshot

Usage

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

Methods

public IEnumerable<MarkdownNativeInlineMetadataSnapshot> EnumerateMetadataFields(String name) #
Returns: IEnumerable<MarkdownNativeInlineMetadataSnapshot>

Enumerates source-backed metadata fields with the supplied field name in source order.

Parameters

name System.String requiredposition: 0
public MarkdownNativeInlineMetadataSnapshot FindMetadataField(String name, Int32 index = -1) #
Returns: MarkdownNativeInlineMetadataSnapshot

Finds the first source-backed metadata field with the supplied name, optionally constrained to an occurrence index.

Parameters

name System.String requiredposition: 0
index System.Int32 = -1 optionalposition: 1

Properties

public String Id { get; } #

Stable inline id.

public MarkdownNativeInlineKind Kind { get; } #

Native inline kind.

public MarkdownSyntaxKind SyntaxKind { get; } #

Syntax kind that produced this inline.

public String Text { get; } #

Plain text represented by this inline.

public String Markdown { get; } #

Markdown represented by this inline.

public String Literal { get; } #

Literal syntax payload.

public MarkdownNativeSourceSpanSnapshot SourceSpan { get; } #

Source span snapshot when available.

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

Metadata values such as target/title/source/alt.

public IReadOnlyDictionary<String, MarkdownNativeSourceSpanSnapshot> MetadataSourceSpans { get; } #

Source spans for metadata values such as target/title/source/alt.

public IReadOnlyList<MarkdownNativeInlineMetadataSnapshot> MetadataFields { get; } #

Source-backed metadata fields in source order, including repeated metadata names.

public IReadOnlyList<MarkdownNativeInlineSnapshot> Children { get; } #

Nested inline snapshots.