ITextSnapshotReader Interface

public interface ITextSnapshotReader

ITextBufferReader BufferReader { get; }

Property Value

ITextBufferReader:

The ITextBufferReader that can be used for performing fast low-level text scanning on the snapshot.

char Character { get; }

Property Value

System.Char:

The character at the Offset.

Remarks

This value is the same as the return value of the PeekCharacter() method.

bool IsAtSnapshotEnd { get; }

Property Value

System.Boolean:

true if the current Offset is at the end of the snapshot; otherwise, false.

bool IsAtSnapshotLineEnd { get; }

Property Value

System.Boolean:

true if the current Offset is at the end of an ITextSnapshotLine; otherwise, false.

bool IsAtSnapshotLineStart { get; }

Property Value

System.Boolean:

true if the current Offset is at the start of an ITextSnapshotLine; otherwise, false.

bool IsAtSnapshotStart { get; }

Property Value

System.Boolean:

true if the current Offset is at the start of the snapshot; otherwise, false.

bool IsAtTokenStart { get; }

Property Value

System.Boolean:

true if the current Offset is at the start of the Token; otherwise, false.

bool IsCharacterLineTerminator { get; }

Property Value

System.Boolean:

true if the Character is a newline character; otherwise, false.

bool IsCharacterWhitespace { get; }

Property Value

System.Boolean:

true if the Character is categorized as a whitespace character; otherwise, false.

ISyntaxLanguage Language { get; }

Property Value

ISyntaxLanguage:

The ISyntaxLanguage that contains the current offset within the snapshot.

int Length { get; }

Property Value

System.Int32:

The length of the snapshot.

int Offset { get; set; }

Property Value

System.Int32:

The current offset within the snapshot.

ITextSnapshotReaderOptions Options { get; }

Property Value

ITextSnapshotReaderOptions:

The ITextSnapshotReaderOptions that contains optimization options for the reader.

Remarks

Configure the options before accessing any members on this reader instance.

TextPosition Position { get; }

Property Value

TextPosition:

The current TextPosition within the snapshot.

ITextSnapshot Snapshot { get; }

Property Value

ITextSnapshot:

The core ITextSnapshot that is examined by this reader.

ITextSnapshotLine SnapshotLine { get; }

Property Value

ITextSnapshotLine:

The ITextSnapshotLine that contains the Offset.

IToken Token { get; }

Property Value

IToken:

The IToken that contains the offset indicated by Offset.

Remarks

This value is the same as the return value of the PeekToken() method.

string TokenText { get; }

Property Value

System.String:

The snapshot text contained by the Token.

void GoToCurrentSnapshotLineEnd()

void GoToCurrentSnapshotLineStart()

void GoToCurrentTokenStart()

bool GoToCurrentWordEnd()

Returns

System.Boolean:

true if the word end is found; otherwise, false.

Remarks

If a proper word end is not found, the reader's Offset will be the end of the snapshot.

bool GoToCurrentWordStart()

Returns

System.Boolean:

true if the word start is found; otherwise, false.

Remarks

If a proper word start is not found, the reader's Offset will be the beginning of the snapshot.

bool GoToNextMatchingTokenById(int startTokenId, int endTokenId)

Parameter	Type	Description
startTokenId	System.Int32	The ID of the start IToken.
endTokenId	System.Int32	The ID of the related end IToken for which to search.

Returns

System.Boolean:

true if the next matching token is found; otherwise, false.

Remarks

This method is useful for bracket matching.

void GoToNextSnapshotLineStart()

bool GoToNextToken()

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextToken(int count)

Parameter	Type	Description
count	System.Int32	The number of tokens to move.

Returns

System.Boolean:

true if a token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextToken(Predicate<IToken> predicate)

Parameter	Type	Description
predicate	System.Predicate<IToken>	The predicate to use. Return true to stop scanning; otherwise, false to continue scanning.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextTokenWithId(int id)

Parameter	Type	Description
id	System.Int32	The token ID to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextTokenWithId(params int[] ids)

Parameter	Type	Description
ids	System.Int32[]	An array of token IDs to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextTokenWithKey(string key)

Parameter	Type	Description
key	System.String	The token key to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextTokenWithKey(params string[] keys)

Parameter	Type	Description
keys	System.String[]	An array of token keys to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToNextWordStart()

Returns

System.Boolean:

true if the word start is found; otherwise, false.

Remarks

If a proper word start is not found, the reader's Offset will be the end of the snapshot.

bool GoToPreviousMatchingTokenById(int endTokenId, int startTokenId)

Parameter	Type	Description
endTokenId	System.Int32	The ID of the end IToken.
startTokenId	System.Int32	The ID of the related start IToken for which to search.

Returns

System.Boolean:

true if the previous matching token is found; otherwise, false.

Remarks

This method is useful for bracket matching.

void GoToPreviousSnapshotLineEnd()

bool GoToPreviousToken()

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousToken(int count)

Parameter	Type	Description
count	System.Int32	The number of tokens to move.

Returns

System.Boolean:

true if a token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousToken(Predicate<IToken> predicate)

Parameter	Type	Description
predicate	System.Predicate<IToken>	The predicate to use. Return true to stop scanning; otherwise, false to continue scanning.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the end of the snapshot.

bool GoToPreviousTokenWithId(int id)

Parameter	Type	Description
id	System.Int32	The token ID to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousTokenWithId(params int[] ids)

Parameter	Type	Description
ids	System.Int32[]	An array of token IDs to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousTokenWithKey(string key)

Parameter	Type	Description
key	System.String	The token key to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousTokenWithKey(params string[] keys)

Parameter	Type	Description
keys	System.String[]	An array of token keys to look for.

Returns

System.Boolean:

true if the token is found; otherwise, false.

Remarks

If a token is not found, the stream's Offset will be the beginning of the snapshot.

bool GoToPreviousWordStart()

Returns

System.Boolean:

true if the word start is found; otherwise, false.

Remarks

If a proper word start is not found, the reader's Offset will be the beginning of the snapshot.

void GoToSnapshotEnd()

void GoToSnapshotStart()

char PeekCharacter()

Returns

System.Char:

The character that was read.

char PeekCharacterReverse()

Returns

System.Char:

The character that was read.

string PeekText(int maxCharCount)

Parameter	Type	Description
maxCharCount	System.Int32	The maximum number of characters to read, if the end of the snapshot is not reached beforehand.

Returns

System.String:

The string that was read.

string PeekTextReverse(int maxCharCount)

Parameter	Type	Description
maxCharCount	System.Int32	The maximum number of characters to read, if the start of the snapshot is not reached beforehand.

Returns

System.String:

The string that was read.

IToken PeekToken()

Returns

IToken:

The IToken that was read.

IToken PeekTokenReverse()

Returns

IToken:

The IToken that was read.

char ReadCharacter()

Returns

System.Char:

The character that was read.

char ReadCharacterReverse()

Returns

System.Char:

The character that was read.

bool ReadCharacterReverseThrough(char ch)

Parameter	Type	Description
ch	System.Char	The desired character.

Returns

System.Boolean:

true if the desired character was read; otherwise, false if the start of the snapshot was reached.

bool ReadCharacterReverseThrough(char ch, int minOffset)

Parameter	Type	Description
ch	System.Char	The desired character.
minOffset	System.Int32	The minimum offset to check.

Returns

System.Boolean:

true if the desired character was read; otherwise, false if the specified offset was reached.

bool ReadCharacterThrough(char ch)

Parameter	Type	Description
ch	System.Char	The desired character.

Returns

System.Boolean:

true if the desired character was read; otherwise, false if the end of the snapshot was reached.

bool ReadCharacterThrough(char ch, int maxOffset)

Parameter	Type	Description
ch	System.Char	The desired character.
maxOffset	System.Int32	The maximum offset to check.

Returns

System.Boolean:

true if the desired character was read; otherwise, false if the specified offset was reached.

string ReadText(int maxCharCount)

Parameter	Type	Description
maxCharCount	System.Int32	The maximum number of characters to read, if the end of the snapshot is not reached beforehand.

Returns

System.String:

The string that was read.

string ReadTextReverse(int maxCharCount)

Parameter	Type	Description
maxCharCount	System.Int32	The maximum number of characters to read, if the start of the snapshot is not reached beforehand.

Returns

System.String:

The string that was read.

IToken ReadToken()

Returns

IToken:

The IToken that was read.

IToken ReadTokenReverse()

Returns

IToken:

The IToken that was read.

void SeekCharacter(int delta)

Parameter	Type	Description
delta	System.Int32	The amount of characters to move. This value may be negative.