TextSnapshotRange Struct

public readonly struct TextSnapshotRange : IComparable<TextRange>, IComparable<TextSnapshotRange>, IEquatable<TextSnapshotRange>, ITextPositionRangeProvider, ITextRangeProvider

public TextSnapshotRange(ITextSnapshot snapshot, TextRange textRange)

Parameter	Type	Description
snapshot	ITextSnapshot	The ITextSnapshot that contains the text range.
textRange	TextRange	The TextRange of the range.

public TextSnapshotRange(ITextSnapshot snapshot, int offset)

Parameter	Type	Description
snapshot	ITextSnapshot	The ITextSnapshot that contains the text range.
offset	int	The start and end offset in the range.

public TextSnapshotRange(ITextSnapshot snapshot, int startOffset, int endOffset)

Parameter	Type	Description
snapshot	ITextSnapshot	The ITextSnapshot that contains the text range.
startOffset	int	The start offset in the range.
endOffset	int	The end offset in the range.

public TextSnapshotRange(TextSnapshotOffset snapshotOffset)

Parameter	Type	Description
snapshotOffset	TextSnapshotOffset	The start and end offset in the range.

[Obsolete("This property will be removed in a future version. Use the Length property instead, as it already returns an absolute length due to snapshot ranges always being normalized.", false)]
public int AbsoluteLength { get; }

Property Value

int

public ITextSnapshotLine EndLine { get; }

Property Value

ITextSnapshotLine

public int EndOffset { get; }

Property Value

int

Remarks

Since snapshot ranges are normalized, this property returns the last offset in the range.

public TextPosition EndPosition { get; }

Property Value

TextPosition

Remarks

Since snapshot ranges are normalized, this property returns the last TextPosition in the range.

public bool IsZeroLength { get; }

Property Value

bool:

true if the range has a zero length; otherwise, false.

public int Length { get; }

Property Value

int

Remarks

This value will always return a non-negative length since snapshot ranges are normalized.

public LineTerminator? LineTerminator { get; }

Property Value

LineTerminator?

public TextPositionRange PositionRange { get; }

Property Value

TextPositionRange

public ITextSnapshot Snapshot { get; }

Property Value

ITextSnapshot

public ITextSnapshotLine StartLine { get; }

Property Value

ITextSnapshotLine

public int StartOffset { get; }

Property Value

int

Remarks

Since snapshot ranges are normalized, this property returns the first offset in the range.

public TextPosition StartPosition { get; }

Property Value

TextPosition

Remarks

Since snapshot ranges are normalized, this property returns the first TextPosition in the range.

public string Text { get; }

Property Value

string

public TextRange TextRange { get; }

Property Value

TextRange

public bool BordersOn(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

true if the TextSnapshotRange borders on, but does not overlap the specified TextRange; otherwise, false.

public bool BordersOn(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to examine.

Returns

bool:

true if the TextSnapshotRange borders on, but does not overlap the specified TextSnapshotRange; otherwise, false.

public bool BordersOn(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

true if the TextSnapshotRange borders on the specified offset; otherwise, false.

Remarks

This method checks to see if the specified offset is either the StartOffset or EndOffset.

public int CompareTo(TextRange range)

Parameter	Type	Description
range	TextRange

Returns

int:

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

public int CompareTo(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange

Returns

int:

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

public bool Contains(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

true if the TextSnapshotRange contains the specified TextRange; otherwise, false.

public bool Contains(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to examine.

Returns

bool:

true if the TextSnapshotRange contains the specified TextSnapshotRange; otherwise, false.

public bool Contains(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

true if the TextSnapshotRange contains the specified offset; otherwise, false.

Remarks

This method returns false if the offset falls on the EndOffset offset since this method indicates if the offset is encompassed by the TextSnapshotRange.

public bool Equals(TextSnapshotRange other)

Parameter	Type	Description
other	TextSnapshotRange	An object to compare with this object.

Returns

bool:

true if the current object is equal to the other parameter; otherwise, false.

public override bool Equals(object? obj)

Parameter	Type	Description
obj	object	The object to compare with the current instance.

Returns

bool:

true if obj and this instance are the same type and represent the same value; otherwise, false.

public static TextSnapshotRange FromSpan(ITextSnapshot snapshot, int offset, int length)

Parameter	Type	Description
snapshot	ITextSnapshot	The ITextSnapshot that contains the text range.
offset	int	The start offset.
length	int	The length of the range.

Returns

TextSnapshotRange

public override int GetHashCode()

Returns

int:

A 32-bit signed integer that is the hash code for this instance.

public string GetText(LineTerminator lineTerminator)

Parameter	Type	Description
lineTerminator	LineTerminator	A LineTerminator specifying the type of line terminators to use.

Returns

string

public bool IntersectsWith(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

true if the TextSnapshotRange intersects with the specified TextRange; otherwise, false.

Remarks

This method returns whether the specified TextRange borders on or overlaps the TextSnapshotRange.

public bool IntersectsWith(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to examine.

Returns

bool:

true if the TextSnapshotRange intersects with the specified TextSnapshotRange; otherwise, false.

Remarks

This method returns whether the specified TextSnapshotRange borders on or overlaps the TextSnapshotRange.

public bool IntersectsWith(TextSnapshotRange range, bool includeFirstEdge, bool includeLastEdge)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to examine.
includeFirstEdge	bool	Whether to return true if the specified TextSnapshotRange borders on the leading (first) edge of this TextSnapshotRange.
includeLastEdge	bool	Whether to return true if the specified TextSnapshotRange borders on the trailing (last) edge of this TextSnapshotRange.

Returns

bool:

true if the TextSnapshotRange intersects with the specified TextSnapshotRange; otherwise, false.

Remarks

This method returns whether the specified TextSnapshotRange borders on or overlaps the TextSnapshotRange.

public bool IntersectsWith(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

true if the TextSnapshotRange intersects with the specified offset; otherwise, false.

Remarks

This method returns whether the specified offset borders on or lies within the TextSnapshotRange.

public bool OverlapsWith(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

true if the TextSnapshotRange overlaps with, or crosses, the specified TextRange; otherwise, false.

public bool OverlapsWith(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to examine.

Returns

bool:

true if the TextSnapshotRange overlaps with, or crosses, the specified TextSnapshotRange; otherwise, false.

public override string ToString()

Returns

string:

The string representation of this object.

public ITextVersionRange ToVersionRange(TextRangeTrackingModes trackingModes)

Parameter	Type	Description
trackingModes	TextRangeTrackingModes	A TextRangeTrackingModes indicating the tracking modes to use.

Returns

ITextVersionRange

public ITextVersionRange ToVersionRange(Func<TextRangeTrackingModes> trackingModesFunc)

Parameter	Type	Description
trackingModesFunc	Func<TextRangeTrackingModes>	A function that dynamically returns a TextRangeTrackingModes indicating the tracking modes to use.

Returns

ITextVersionRange

public TextSnapshotRange? TranslateTo(ITextSnapshot toSnapshot, TextRangeTrackingModes trackingModes)

Parameter	Type	Description
toSnapshot	ITextSnapshot	The ITextSnapshot that is the target of the translation.
trackingModes	TextRangeTrackingModes	A TextRangeTrackingModes indicating the tracking modes to use.

Returns

TextSnapshotRange?:

The translated TextSnapshotRange, or null if deleted.

public static bool operator ==(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the StartOffset and EndOffset values of left and right are equal; otherwise, false.

public static bool operator >(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the TextSnapshotRange in left is greater than the TextSnapshotRange in right; otherwise, false.

public static bool operator >=(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the TextSnapshotRange in left is greater than or equal to the TextSnapshotRange in right; otherwise, false.

public static implicit operator TextRange(TextSnapshotRange range)

Parameter	Type	Description
range	TextSnapshotRange	The TextSnapshotRange to convert.

Returns

TextRange:

The TextRange result.

public static bool operator !=(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the StartOffset and EndOffset values of left and right are unequal; otherwise, false.

public static bool operator <(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the TextSnapshotRange in left is less than the TextSnapshotRange in right; otherwise, false.

public static bool operator <=(TextSnapshotRange left, TextSnapshotRange right)

Parameter	Type	Description
left	TextSnapshotRange	A TextSnapshotRange to compare.
right	TextSnapshotRange	A TextSnapshotRange to compare.

Returns

bool:

true if the TextSnapshotRange in left is less than or equal to the TextSnapshotRange in right; otherwise, false.