HeadingBlock
OfficeIMO.Markdown
Markdown heading (ATX) block, levels 1–6.
Inheritance
- MarkdownObject
- MarkdownBlock
- HeadingBlock
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
- Method MarkdownDocument.AddHeading
- Method MarkdownDocument.DescendantHeadings
- Property HeadingInfo.Block
- Property MarkdownNativeHeadingBlock.Heading
Accepted by parameters 1
Constructors
public HeadingBlock(int level, string text) #Creates a new heading block.
Parameters
- level int
- Desired level; constrained to [1,6].
- text string
- Heading text.
public HeadingBlock(int level, InlineSequence inlines) #Creates a new heading block from parsed inline content.
Parameters
- level int
- Desired level; constrained to [1,6].
- inlines OfficeIMO.Markdown.InlineSequence
- Inline content.
Inherited Methods
public void Accept(MarkdownVisitor visitor) #Parameters
- visitor MarkdownVisitor
public IEnumerable<MarkdownObject> Ancestors() #Returns
IEnumerable<MarkdownObject>public IEnumerable<MarkdownObject> AncestorsAndSelf() #Returns
IEnumerable<MarkdownObject>public IEnumerable<TObject> DescendantObjectsOfType<TObject>() #Type Parameters
- TObject
Returns
IEnumerable<TObject>public IEnumerable<MarkdownObject> Descendants() #Returns
IEnumerable<MarkdownObject>Properties
public string Text { get; } #Plain-text heading text for compatibility, slugs, and TOC labels.
public MarkdownSourceSpan? LevelSourceSpan { get; private set; } #Source span for the heading marker or setext underline that determines the level.
public MarkdownSourceSpan? TextSourceSpan { get; private set; } #Source span for the heading text payload.
public MarkdownSourceSpan? OpeningMarkerSourceSpan { get; private set; } #Source span for the ATX opening marker token when parsed from markdown.
public string? OpeningMarkerText { get; private set; } #Exact ATX opening marker token when parsed from markdown.
public MarkdownSourceSpan? SetextUnderlineMarkerSourceSpan { get; private set; } #Source span for a Setext underline marker token when parsed from markdown.
public string? SetextUnderlineMarkerText { get; private set; } #Exact Setext underline marker token when parsed from markdown.
public MarkdownSourceSpan? ClosingMarkerSourceSpan { get; private set; } #Source span for an optional ATX closing marker token when parsed from markdown.
public string? ClosingMarkerText { get; private set; } #Exact optional ATX closing marker token when parsed from markdown.
Inherited Properties
public MarkdownSourceSpan? SourceSpan { get; internal set; } #public IReadOnlyList<MarkdownObject> ChildObjects { get; } #