Get Started

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

Accepted by parameters

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 override Boolean Equals(Object obj) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:130
Returns: Boolean

Parameters

obj System.Object requiredposition: 0
public virtual Boolean Equals(MarkdownSourceSpan other) #
OfficeIMO.Markdown/Reader/Syntax/MarkdownSourceSpan.cs:145
Returns: Boolean

Parameters

other OfficeIMO.Markdown.MarkdownSourceSpan requiredposition: 0
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

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.