バージョン

TextDocumentSnapshotScanner の概要

トピックの概要

目的

このトピックでは、TextDocumentSnapshotScanner オブジェクトのプロパティおよびメソッドの概要を提供します。

このトピックの内容

このトピックは、以下のセクションで構成されます。

はじめに

TextDocumentSnapshotScanner の概要

スナップショットの CreateScanner メソッドを介して作成された TextDocumentSnapshotScanner クラスは TextDocumentSnaphot の特定のインスタンスをターゲットとして、スナップショットの線、トークンおよびワードを効率的にスキャンするために役に立ちます。

Note
注:

対象のスナップショットはスレッドセーフですが、スキャナーはスレッドセーフではありません。したがって、それを使用して同じスレッドでスキャナーを作成します (名目上、スキャナーにアクセスする各スレッドは固有に作成します)。別のスレッドで作成されたスキャナーのプロパティとメソッドにアクセスしようとすると、InvalidOperationException が起動します。
Note

TextDocumentSnapshotScanner クラスは IDisposable を実装し、‘using’ ブロック内で使用されるか明示的に破棄されるべきであることにも留意してください。

TextDocumentSnapshotScanner プロパティ

プロパティのリスト

プロパティ 説明

CurrentOffset

これはスキャナーの現在の位置を表します。スキャナーを最初に作成した時、初期プロパティはゼロに設定されます。明示的に設定する、または以下のメソッド リスト表の ‘SeekTo’ メソッドを呼び出すことによって操作されます。

CurrentCharacter

CurrentOffset の文字を返します。

CurrentLine

CurrentOffset を含む線を返します。

CurrentToken

CurrentOffset を含むトークンを返します。

Note
注:

CurrentOffset をスナップショットの Length に設定すると、特別な EOS (ストリームの最後) トークンが返されます。

CurrentWord

CurrentOffset`` を含むワードを返す、または CurrentOffset がワード内にない場合 null 値を返します。

Snapshot

関連付けられた TextDocumentSnapshot を返します。(読み取り専用)

TextDocumentSnapshotScanner メソッド

メソッド リスト

メソッド 説明

PeekNextToken

このメソッドは CurrentOffset を変更せずに次のトークンを返します。このメソッドのオプション フィルター (Func<Token, bool>) パラメーターを使用して、重要ではないトークン (たとえば空白、コメント、改行) をスキップします。

PeekPreviousToken

このメソッドは CurrentOffset を変更せずに前のトークンを返します。このメソッドのオプション フィルター (Func<Token, bool>) を使用して、重要ではないトークン (たとえば空白、コメント、改行) をスキップします。

PeekNextWord

このメソッドは CurrentOffset を変更せずに次のワードを返します。

PeekPreviousWord

このメソッドは CurrentOffset を変更せずに前のワードを返します。

SeekToEnd

このメソッドは CurrentOffset をドキュメントの最後に移動します。

SeekToLine

このメソッドは CurrentOffset をドキュメントの特定のラインに移動します。

SeekToStart

このメソッドは CurrentOffset をドキュメントの先頭に移動します。

SeekToToken

このメソッドは CurrentOffset をドキュメントの特定のトークンに移動します。

SeekToWord

このメソッドは CurrentOffset をドキュメントの特定のワードに移動します。

LineFromOffset

このメソッドは指定されたオフセットにある文字を含むテキストの行のための SnapshotLineInfo オブジェクトを取得します。

TokenFromOffset

このメソッドは指定されたオフセットにある文字を含む Token オブジェクトを取得します。

WordFromOffset

このメソッドは指定されたオフセットにある文字を含む Word オブジェクトを取得します。

関連コンテンツ

トピック

以下のトピックでは、このトピックに関連する追加情報を提供しています。

トピック 目的

このトピックでは、Infragistics Syntax Parsing Engine の主要なクラス、TextDocument について説明します。最も重要なメソッド、イベントおよびプロパティを概略するトピックへのリンクが含まれています。

このトピックでは、TextDocumentSnapshot オブジェクトのプロパティおよびメソッドの概要を提供します。