TextPosition Struct

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

public TextPosition(TextPosition position, bool hasFarAffinity = false)

Parameter	Type	Description
position	TextPosition	The TextPosition specifying line and character values.
hasFarAffinity	bool	Whether the position has affinity for the far side, which is used when the position specifies the place where a view line is wrapped to a second view line. The default value is false.

public TextPosition(int line, int character, bool hasFarAffinity = false)

Parameter	Type	Description
line	int	The line of the position.
character	int	The character of the position.
hasFarAffinity	bool	Whether the position has affinity for the far side, which is used when the position specifies the place where a view line is wrapped to a second view line. The default value is false.

public int Character { get; }

Property Value

int

Remarks

This property is zero-based. When displaying the value in UI, use the DisplayCharacter property instead, which adds 1 to this value to make it one-based.

public int DisplayCharacter { get; }

Property Value

int

public int DisplayLine { get; }

Property Value

int

public bool HasFarAffinity { get; }

Property Value

bool:

true if the position has affinity for the far side; otherwise, false. The default value is false.

Remarks

This property is used in word wrap scenarios where the position is the last position in a view line that gets wrapped to another view line. In that scenario, the position could refer to both the end of the first line and the beginning of the second line. When this property is true, the position will refer to the beginning of the second line.

public int Line { get; }

Property Value

int

Remarks

This property is zero-based. When displaying the value in UI, use the DisplayCharacter property instead, which adds 1 to this value to make it one-based.

public int CompareTo(TextPosition position)

Parameter	Type	Description
position	TextPosition

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 CompareToWithoutAffinity(TextPosition position)

Parameter	Type	Description
position	TextPosition

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 Equals(TextPosition other)

Parameter	Type	Description
other	TextPosition	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 TextPosition First(TextPosition position1, TextPosition position2)

Parameter	Type	Description
position1	TextPosition	The first TextPosition to compare.
position2	TextPosition	The second TextPosition to compare.

Returns

TextPosition

public override int GetHashCode()

Returns

int:

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

public static TextPosition Last(TextPosition position1, TextPosition position2)

Parameter	Type	Description
position1	TextPosition	The first TextPosition to compare.
position2	TextPosition	The second TextPosition to compare.

Returns

TextPosition

public override string ToString()

Returns

string:

The string representation of this object.

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

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

Returns

bool:

true if the Line, Character, and HasFarAffinity values of left and right are equal; otherwise, false.

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

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

Returns

bool:

true if the Line and Character values of left and right are greater than the other; otherwise, false.

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

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

Returns

bool:

true if the Line and Character values of left and right are greater than or equal to the other; otherwise, false.

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

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

Returns

bool:

true if the Line, Character, and HasFarAffinity values of left and right are unequal; otherwise, false.

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

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

Returns

bool:

true if the Line and Character values of left and right are less than the other; otherwise, false.

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

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

Returns

bool:

true if the Line and Character values of left and right are less than or equal to the other; otherwise, false.

public const int MaxCharacter = 2147483647

public const int MaxLine = 2147483647

public static readonly TextPosition Zero