Get Started

API Reference

Class

MarkdownObject

Edit on GitHub
Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Source OfficeIMO.Markdown/Core/MarkdownObject.cs:33
Modifiers abstract

Base type for the navigable OfficeIMO.Markdown object tree.

Inheritance

  • Object
  • MarkdownObject

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 Void Accept(MarkdownVisitor visitor) #
OfficeIMO.Markdown/Core/MarkdownObject.cs:33
Returns: Void

Dispatches this node to a visitor.

Parameters

visitor OfficeIMO.Markdown.MarkdownVisitor requiredposition: 0
public IEnumerable<MarkdownObject> Ancestors() #
Returns: IEnumerable<MarkdownObject>

Enumerates ancestor nodes starting from the parent.

public IEnumerable<MarkdownObject> AncestorsAndSelf() #
Returns: IEnumerable<MarkdownObject>

Enumerates this node followed by its ancestors.

public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #
Returns: IEnumerable<TObject>

Type Parameters

TObject
DescendantObjectsOfType``1() #

Enumerates descendants of the requested node type.

public IEnumerable<MarkdownObject> Descendants() #
Returns: IEnumerable<MarkdownObject>

Enumerates descendant nodes in depth-first order.

Properties

public MarkdownObject Parent { get; set; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:8

Parent node in the markdown object tree, or null for the document root.

public MarkdownDoc Document { get; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:11

Containing document for this node when attached to a tree.

public MarkdownObject Root { get; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:14

Root node for this object's tree.

public Nullable<Int32> IndexInParent { get; set; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:17

Zero-based index within the parent when this node is attached to a tree.

public MarkdownObject PreviousSibling { get; set; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:20

Previous sibling in the parent container when available.

public MarkdownObject NextSibling { get; set; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:23

Next sibling in the parent container when available.

public Nullable<MarkdownSourceSpan> SourceSpan { get; set; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:26

Source span mapped from the syntax tree when available.

public IReadOnlyList<MarkdownObject> ChildObjects { get; } #
OfficeIMO.Markdown/Core/MarkdownObject.cs:29

Immediate child objects in document order.