TokenBase Class

public abstract class TokenBase : IToken

protected TokenBase(int startOffset, int length, TextPosition startPosition, TextPosition endPosition)

Parameter	Type	Description
startOffset	int	The start offset of the token.
length	int	The length of the token.
startPosition	TextPosition	The TextPosition of the first character in the token.
endPosition	TextPosition	The TextPosition after the last character in the token.

public int EndOffset { get; }

Property Value

int

public TextPosition EndPosition { get; }

Property Value

TextPosition

public abstract int Id { get; }

Property Value

int

public virtual string? Key { get; }

Property Value

string

public int Length { get; set; }

Property Value

int

Remarks

The setter for this property is for internal use only. Altering its value will corrupt the ITextDocumentIToken collection.

public virtual int LexicalStateId { get; }

Property Value

int

public TextPositionRange PositionRange { get; }

Property Value

TextPositionRange

public int StartOffset { get; set; }

Property Value

int

public TextPosition StartPosition { get; }

Property Value

TextPosition

public TextRange TextRange { get; }

Property Value

TextRange

public bool Contains(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition to examine.

Returns

bool:

true if the IToken contains the specified TextPosition; otherwise, false.

Remarks

This method returns false if the position falls on the EndPosition position since this method indicates if the position is encompassed by the IToken.

public bool Contains(int offset)

Parameter	Type	Description
offset	int	The offset to examine.

Returns

bool:

true if the IToken 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 IToken.

public override bool Equals(object? obj)

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

Returns

bool:

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

public override int GetHashCode()

Returns

int:

A hash code for the current object.

public override string ToString()

Returns

string:

The string representation of this object.

public string ToString(string tokenDescription)

Parameter	Type	Description
tokenDescription	string	The description of the IToken.

Returns

string