API Reference

Class

MarkdownNativeBlock

Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Modifiers abstract

Base type for an AST-backed native markdown block projection.

Inheritance

  • Object
  • MarkdownNativeBlock

Usage

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

Methods

public Boolean ContainsLine(Int32 lineNumber) #
Returns: Boolean

Returns true when this block's source span contains the supplied 1-based line.

Parameters

lineNumber System.Int32 requiredposition: 0
EnumerateSourceFields 2 overloads
public IEnumerable<MarkdownNativeBlockSourceField> EnumerateSourceFields() #
Returns: IEnumerable<MarkdownNativeBlockSourceField>

Enumerates source-backed fields owned by this block in source order.

public IEnumerable<MarkdownNativeBlockSourceField> EnumerateSourceFields(String name) #
Returns: IEnumerable<MarkdownNativeBlockSourceField>

Enumerates source-backed fields with the supplied field name owned by this block in source order.

Parameters

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

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

Parameters

name System.String requiredposition: 0
index System.Int32 = -1 optionalposition: 1
public MarkdownNativeBlockSnapshot ToSnapshot() #
Returns: MarkdownNativeBlockSnapshot

Creates a UI-safe snapshot of this block without parser object references.

Properties

public String Id { get; } #

Deterministic identity for this projection within stable markdown input.

public MarkdownNativeBlockKind Kind { get; } #

Native projection kind.

public Nullable<MarkdownSourceSpan> SourceSpan { get; } #

Source span in the normalized markdown text when available.

public MarkdownSyntaxNode SyntaxNode { get; } #

Syntax node that produced this native block.

public IMarkdownBlock SourceBlock { get; } #

Original OfficeIMO markdown block backing this projection.