IToken Interface

public interface IToken

int EndOffset { get; }

Property Value

int:

The offset after the last character in the token.

TextPosition EndPosition { get; }

Property Value

TextPosition:

The TextPosition after the last character in the token.

int Id { get; }

Property Value

int:

The ID assigned to the token.

string Key { get; }

Property Value

string:

The key assigned to the token.

int Length { get; set; }

Property Value

int:

The absolute length of the token.

Remarks

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

int LexicalStateId { get; }

Property Value

int:

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

TextPositionRange PositionRange { get; }

Property Value

TextPositionRange:

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

int StartOffset { get; set; }

Property Value

int:

The offset of the first character in the token.

TextPosition StartPosition { get; }

Property Value

TextPosition:

The TextPosition of the first character in the token.

TextRange TextRange { get; }

Property Value

TextRange:

A TextRange that specifies the text range of the token.

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.

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.