TokenBase Class

public abstract class TokenBase : IToken

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

Parameter	Type	Description
startOffset	Int32	The start offset of the token.
length	Int32	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

Int32:

The offset after the last character in the token.

public TextPosition EndPosition { get; }

Property Value

TextPosition:

The TextPosition after the last character in the token.

public abstract int Id { get; }

Property Value

Int32:

The ID assigned to the token.

public virtual string Key { get; }

Property Value

String:

The key assigned to the token.

public int Length { get; set; }

Property Value

Int32:

The absolute length of the token.

public virtual int LexicalStateId { get; }

Property Value

Int32:

The ID assigned to the lexical state that contains the token.

public TextPositionRange PositionRange { get; }

Property Value

TextPositionRange:

A TextPositionRange that specifies the text position range of the token.

public int StartOffset { get; set; }

Property Value

Int32:

The offset of the first character in the token.

public TextPosition StartPosition { get; }

Property Value

TextPosition:

The TextPosition of the first character in the token.

public TextRange TextRange { get; }

Property Value

TextRange:

A TextRange that specifies the text range of the token.

public bool Contains(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition to examine.

Returns

Boolean:

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	Int32	The offset to examine.

Returns

Boolean:

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 to the current Object.

Returns

Boolean:

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

public override int GetHashCode()

Returns

Int32:

An integer value that specifies a hash value for this object.

public override string ToString()

Returns

String:

A string representation of the current object.

public string ToString(string tokenDescription)

Parameter	Type	Description
tokenDescription	String	The description of the IToken.

Returns

String:

A string representation of the current object.