API Reference
HeadingBlock
Markdown heading (ATX) block, levels 1–6.
Inheritance
- MarkdownBlock
- HeadingBlock
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
- Method MarkdownDoc.DescendantHeadings
- Property HeadingInfo.Block
- Property MarkdownNativeHeadingBlock.Heading
Accepted by parameters
- Method MarkdownDoc.GetHeadingAnchor
Constructors
public HeadingBlock(Int32 level, InlineSequence inlines) #Creates a new heading block.
Parameters
- level System.Int32
- Desired level; constrained to [1,6].
- text System.String
- Heading text.
HeadingBlock(System.Int32 level, OfficeIMO.Markdown.InlineSequence inlines) #Creates a new heading block from parsed inline content.
Parameters
- level System.Int32
- Desired level; constrained to [1,6].
- inlines OfficeIMO.Markdown.InlineSequence
- Inline content.
Methods
Inherited Methods
public Void Accept(MarkdownVisitor visitor) #VoidParameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #IEnumerable<TObject>Type Parameters
- TObject
public IEnumerable<MarkdownObject> Descendants() #IEnumerable<MarkdownObject>public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public virtual Int32 Level { get; } #Heading level constrained to [1,6].
public InlineSequence Inlines { get; } #Inline content owned by this heading.
public virtual String Text { get; } #Plain-text heading text for compatibility, slugs, and TOC labels.
public Nullable<MarkdownSourceSpan> LevelSourceSpan { get; set; } #Source span for the heading marker or setext underline that determines the level.
public Nullable<MarkdownSourceSpan> TextSourceSpan { get; set; } #Source span for the heading text payload.
public Nullable<MarkdownSourceSpan> OpeningMarkerSourceSpan { get; set; } #Source span for the ATX opening marker token when parsed from markdown.
public String OpeningMarkerText { get; set; } #Exact ATX opening marker token when parsed from markdown.
public Nullable<MarkdownSourceSpan> SetextUnderlineMarkerSourceSpan { get; set; } #Source span for a Setext underline marker token when parsed from markdown.
public String SetextUnderlineMarkerText { get; set; } #Exact Setext underline marker token when parsed from markdown.
public Nullable<MarkdownSourceSpan> ClosingMarkerSourceSpan { get; set; } #Source span for an optional ATX closing marker token when parsed from markdown.
public String ClosingMarkerText { get; set; } #Exact optional ATX closing marker token when parsed from markdown.
Inherited Properties
public MarkdownObject Parent { get; } #public MarkdownDoc Document { get; } #public MarkdownObject Root { get; } #public Nullable<Int32> IndexInParent { get; } #public MarkdownObject PreviousSibling { get; } #public MarkdownObject NextSibling { get; } #public Nullable<MarkdownSourceSpan> SourceSpan { get; set; } #public MarkdownAttributeSet Attributes { get; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #