API Reference

Struct

MarkdownSourceSpan

Edit on GitHub

Namespace OfficeIMO.Markdown

Assembly OfficeIMO.Markdown

Source OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:22

Base ValueType

Implements

IEquatable<MarkdownSourceSpan>

Modifiers sealed

Source span for markdown syntax nodes.

Inheritance

ValueType
MarkdownSourceSpan

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

Property BoldInline.SourceSpan
Property BoldItalicInline.SourceSpan
Property BoldItalicSequenceInline.SourceSpan
Property BoldSequenceInline.SourceSpan
Property CalloutBlock.SourceSpan
Property CodeBlock.SourceSpan
Property CodeSpanInline.SourceSpan
Property DefinitionListBlock.SourceSpan
Property DefinitionListDefinition.SourceSpan
Property DefinitionListEntry.SourceSpan
Property DefinitionListGroup.SourceSpan
Property DetailsBlock.SourceSpan
Property FootnoteDefinitionBlock.SourceSpan
Property FootnoteRefInline.SourceSpan
Property FrontMatterBlock.SourceSpan
Property HardBreakInline.SourceSpan
Property HeadingBlock.SourceSpan
Property HighlightInline.SourceSpan
Property HighlightSequenceInline.SourceSpan
Property HorizontalRuleBlock.SourceSpan
Property HtmlCommentBlock.SourceSpan
Property HtmlRawBlock.SourceSpan
Property HtmlRawInline.SourceSpan
Property HtmlTagSequenceInline.SourceSpan
Property ImageBlock.SourceSpan
Property ImageInline.SourceSpan
Property ImageLinkInline.SourceSpan
Property InlineSequence.SourceSpan
Property ItalicInline.SourceSpan
Property ItalicSequenceInline.SourceSpan
Property LinkInline.SourceSpan
Property ListItem.SourceSpan
Property MarkdownBlock.SourceSpan
Method MarkdownBlockSyntaxBuilderContext.GetAggregateSpan
Property MarkdownDoc.SourceSpan
Property MarkdownDocumentTransformContext.TopLevelBlockSourceSpans
Property MarkdownDocumentTransformDiagnostic.AffectedFinalBlockSpan
Property MarkdownDocumentTransformDiagnostic.AffectedOriginalBlockSpan
Property MarkdownDocumentTransformDiagnostic.AffectedSourceSpan
Property MarkdownInline.SourceSpan
Method MarkdownInlineParserContext.GetSourceSpan
Method MarkdownInlineSyntaxBuilderContext.GetAggregateSpan
Property MarkdownObject.SourceSpan
Property MarkdownSyntaxNode.SourceSpan
Property OrderedListBlock.SourceSpan
Property ParagraphBlock.SourceSpan
Property QuoteBlock.SourceSpan
Property SemanticFencedBlock.SourceSpan
Property StrikethroughInline.SourceSpan
Property StrikethroughSequenceInline.SourceSpan
Property SummaryBlock.SourceSpan
Property TableBlock.SourceSpan
Property TableCell.SourceSpan
Property TextRun.SourceSpan
Property TocBlock.SourceSpan
Property UnderlineInline.SourceSpan
Property UnorderedListBlock.SourceSpan

Accepted by parameters

Method ISyntaxMarkdownBlock.BuildSyntaxNode parameter span
Method ISyntaxMarkdownBlockWithContext.BuildSyntaxNode parameter span
Method ISyntaxMarkdownInline.BuildSyntaxNode parameter span
Method MarkdownBlockSyntaxBuilderContext.BuildBlock parameter span
Method MarkdownBlockSyntaxBuilderContext.BuildInlineContainerNode parameter span
Constructor MarkdownDocumentTransformContext.MarkdownDocumentTransformContext parameter topLevelBlockSourceSpans
Method MarkdownParseResult.FindDeepestFinalNodeContainingSpan parameter span
Method MarkdownParseResult.FindDeepestFinalNodeOverlappingSpan parameter span
Method MarkdownParseResult.FindDeepestNodeContainingSpan parameter span
Method MarkdownParseResult.FindDeepestNodeOverlappingSpan parameter span
Method MarkdownParseResult.FindFinalNodePathContainingSpan parameter span
Method MarkdownParseResult.FindFinalNodePathOverlappingSpan parameter span
Method MarkdownParseResult.FindNearestBlockContainingSpan parameter span
Method MarkdownParseResult.FindNearestBlockOverlappingSpan parameter span
Method MarkdownParseResult.FindNearestFinalBlockContainingSpan parameter span
Method MarkdownParseResult.FindNearestFinalBlockOverlappingSpan parameter span
Method MarkdownParseResult.FindNodePathContainingSpan parameter span
Method MarkdownParseResult.FindNodePathOverlappingSpan parameter span
Method MarkdownSourceSpan.Contains parameter other
Method MarkdownSourceSpan.Equals parameter other
Method MarkdownSourceSpan.Overlaps parameter other
Constructor MarkdownSyntaxNode.MarkdownSyntaxNode parameter sourceSpan
Method MarkdownSyntaxNode.FindDeepestNodeContainingSpan parameter span
Method MarkdownSyntaxNode.FindDeepestNodeOverlappingSpan parameter span
Method MarkdownSyntaxNode.FindNearestBlockContainingSpan parameter span
Method MarkdownSyntaxNode.FindNearestBlockOverlappingSpan parameter span
Method MarkdownSyntaxNode.FindNodePathContainingSpan parameter span
Method MarkdownSyntaxNode.FindNodePathOverlappingSpan parameter span

Constructors

MarkdownSourceSpan 2 overloads

public MarkdownSourceSpan(Int32 startLine, Int32 endLine) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:22

Create a line-based source span.

Parameters

startLine System.Int32 requiredposition: 0
endLine System.Int32 requiredposition: 1

public MarkdownSourceSpan(Int32 startLine, Int32 startColumn, Int32 endLine, Int32 endColumn, Nullable<Int32> startOffset = null, Nullable<Int32> endOffset = null)

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:39

Create a source span with line, column, and optional normalized-text offsets.

Parameters

startLine System.Int32 requiredposition: 0
startColumn System.Int32 requiredposition: 1
endLine System.Int32 requiredposition: 2
endColumn System.Int32 requiredposition: 3
startOffset System.Nullable{System.Int32} = null optionalposition: 4
endOffset System.Nullable{System.Int32} = null optionalposition: 5

Methods

public Boolean Contains(MarkdownSourceSpan other) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:71

Returns: Boolean

Returns true when this span fully contains the given span.

Parameters

other OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0

public Boolean ContainsLine(Int32 lineNumber) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:65

Returns: Boolean

Returns true when the span contains the given 1-based line number.

Parameters

lineNumber System.Int32 requiredposition: 0

public Boolean ContainsPosition(Int32 lineNumber, Int32 columnNumber) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:97

Returns: Boolean

Returns true when the span contains the given 1-based line and column.

Parameters

lineNumber System.Int32 requiredposition: 0
columnNumber System.Int32 requiredposition: 1

Equals 2 overloads

public virtual Boolean Equals(MarkdownSourceSpan other) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:145

Returns: Boolean

Parameters

obj System.Object requiredposition: 0

Equals(OfficeIMO.Markdown.MarkdownSourceSpan other) #

Parameters

other OfficeIMO.Markdown.MarkdownSourceSpan required

public override Int32 GetHashCode() #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:135

Returns: Int32

public Boolean Overlaps(MarkdownSourceSpan other) #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:84

Returns: Boolean

Returns true when this span overlaps the given span.

Parameters

other OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0

public override String ToString() #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:118

Returns: String

Inherited Methods

Properties

public Int32 StartLine { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:8

1-based start line.

public Nullable<Int32> StartColumn { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:10

1-based start column.

public Int32 EndLine { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:12

1-based end line.

public Nullable<Int32> EndColumn { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:14

1-based end column.

public Nullable<Int32> StartOffset { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:16

0-based start offset in the normalized markdown text.

public Nullable<Int32> EndOffset { get; } #

OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:18

0-based end offset in the normalized markdown text.