TextRange Struct

public readonly struct TextRange : IComparable, IComparable<TextRange>, IEquatable<TextRange>

public TextRange(int offset)

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

public TextRange(int startOffset, int endOffset)

Parameter	Type	Description
startOffset	int	The start offset in the range.
endOffset	int	The end offset in the range.

public int AbsoluteLength { get; }

Property Value

int

Remarks

This value will always return a positive length, even if the range is not normalized.

public int EndOffset { get; }

Property Value

int

Remarks

The end offset may occur before the start offset if the range is not normalized. The IsNormalized property indicates if the range is normalized. To get the normalized first offset in the range, use the FirstOffset property. To get the normalized last offset in the range, use the LastOffset property.

public int FirstOffset { get; }

Property Value

int

Remarks

This property returns either the StartOffset or EndOffset property, whichever comes first.

public bool IsNormalized { get; }

Property Value

bool:

true if the range is normalized; otherwise, false.

public bool IsZeroLength { get; }

Property Value

bool:

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

public int LastOffset { get; }

Property Value

int

Remarks

This property returns either the StartOffset or EndOffset property, whichever comes last.

public int Length { get; }

Property Value

int

Remarks

This value will return a negative length if the range is not normalized.

public TextRange Normalized { get; }

Property Value

TextRange

public int StartOffset { get; }

Property Value

int

Remarks

The start offset may occur after the end offset if the range is not normalized. The IsNormalized property indicates if the range is normalized. To get the normalized first offset in the range, use the FirstOffset property. To get the normalized last offset in the range, use the LastOffset property.

public bool BordersOn(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

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

public bool BordersOn(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

true if the TextRange 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 textRange)

Parameter	Type	Description
textRange	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 bool Contains(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

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

public bool Contains(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

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

Remarks

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

public bool Equals(TextRange other)

Parameter	Type	Description
other	TextRange	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 TextRange FromSpan(int offset, int length)

Parameter	Type	Description
offset	int	The start offset.
length	int	The length of the range.

Returns

TextRange

public override int GetHashCode()

Returns

int:

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

public static TextRange? Intersect(TextRange range1, TextRange range2)

Parameter	Type	Description
range1	TextRange	The first TextRange to examine.
range2	TextRange	The second TextRange to examine.

Returns

TextRange?:

The intersection of two TextRange objects.

public bool IntersectsWith(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

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

Remarks

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

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

Parameter	Type	Description
range	TextRange	The TextRange 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 TextRange intersects with the specified TextRange; otherwise, false.

Remarks

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

public bool IntersectsWith(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

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

Remarks

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

public bool OverlapsWith(TextRange range)

Parameter	Type	Description
range	TextRange	The TextRange to examine.

Returns

bool:

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

public override string ToString()

Returns

string:

The string representation of this object.

public TextRange? Translate(ITextSnapshot fromSnapshot, ITextSnapshot toSnapshot, TextRangeTrackingModes trackingModes)

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

Returns

TextRange?:

The translated TextRange, or null if deleted.

public TextRange? Translate(ITextVersion fromVersion, ITextVersion toVersion, TextRangeTrackingModes trackingModes)

Parameter	Type	Description
fromVersion	ITextVersion	The ITextVersion to which to text range belongs.
toVersion	ITextVersion	The ITextVersion that is the target of the translation.
trackingModes	TextRangeTrackingModes	A TextRangeTrackingModes indicating the tracking modes to use.

Returns

TextRange?:

The translated TextRange, or null if deleted.

public static TextRange Union(TextRange range1, TextRange range2)

Parameter	Type	Description
range1	TextRange	The first TextRange to examine.
range2	TextRange	The second TextRange to examine.

Returns

TextRange

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

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

Returns

bool:

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

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

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

Returns

bool:

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

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

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

Returns

bool:

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

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

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

Returns

bool:

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

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

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

Returns

bool:

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

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

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

Returns

bool:

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