ITextStoreACP2

ITextStoreACP2 インターフェイスはアプリケーション側で実装され、TSF マネージャーが TSF のテキストストリームまたはテキストストアを操作するために使用します。

ITextStoreACPSink インターフェイスによる新しいアドバイズシンクをインストールするか、既存のアドバイズシンクを変更します。シンクインターフェイスは punk パラメーターで指定します。

このメソッドは次のいずれかの値を返します。

TSF マネージャーからの通知がもはや不要であることを示すために、アプリケーションから呼び出されます。TSF マネージャーはシンクインターフェイスを解放し、通知を停止します。

このメソッドは次のいずれかの値を返します。

新しいシンクオブジェクトを登録する AdviseSink メソッドの呼び出しは、必ず本メソッドの呼び出しと対になっている必要があります。既に登録済みのシンクの dwMask パラメーターを更新するだけの AdviseSink メソッドの呼び出しについては、UnadviseSink メソッドを呼び出す必要はありません。

例えば、シンクオブジェクトを登録するには、アプリケーションは最初に AdviseSink メソッドを呼び出します。シンクオブジェクトの登録後は、同じシンクオブジェクトを指定して AdviseSink メソッドを再度呼び出すことで dwMask パラメーターを変更できます。シンクオブジェクトの登録を解除するには、アプリケーションは UnadviseSink メソッドを呼び出します。

punk パラメーターは、AdviseSink メソッドに元々渡したポインターと同一の COM アイデンティティを持つ必要があります。

ドキュメントを変更するためのドキュメントロックを提供する目的で、TSF マネージャーから呼び出されます。このメソッドは OnLockGranted メソッドを呼び出してドキュメントロックを作成します。

このメソッドは次のいずれかの値を返します。

このメソッドは OnLockGranted メソッドを使用してドキュメントをロックします。アプリケーションは、RequestLock メソッド内でドキュメントを変更したり、OnTextChange メソッドで変更通知を送信したりしてはなりません。報告すべき変更が保留中の場合、アプリケーションは非同期ロック要求にのみ応答できます。

アプリケーションは複数の RequestLock メソッド呼び出しをキューイングしようとすべきではありません。アプリケーションが必要とするコールバックは 1 つだけだからです。ただし、呼び出し元が複数の読み取り要求と 1 つ以上の書き込み要求を行った場合、コールバックは書き込みアクセスに対して行われるべきです。

同期ロック要求が成功した場合、その要求は非同期ロック要求に優先します。同期ロック要求が失敗した場合は、非同期ロック要求に優先しません。実装側は、未処理の非同期要求が存在する場合、その要求に引き続き応じる必要があります。

RequestLock メソッドが復帰する前にロックが許可された場合、phrSession パラメーターは OnLockGranted メソッドが返した HRESULT を受け取ります。呼び出しが成功したものの、ロックが後から許可される場合、phrSession パラメーターは TS_S_ASYNC フラグを受け取ります。RequestLock が S_OK 以外を返した場合、phrSession パラメーターは無視すべきです。

呼び出し元は、このメソッドを再入的に呼び出してはなりません。ただし、読み取り専用ロックを保持している場合は例外で、この場合は非同期の書き込みロックを要求するために再入的に呼び出すことができます。書き込みロックは、読み取り専用ロックの終了後に許可されます。

ドキュメントロックの詳細については、Document Locks を参照してください。

ドキュメントの状態を取得します。ドキュメントの状態は TS_STATUS 構造体を通じて返されます。

このメソッドは次のいずれかの値を返します。

指定された開始文字位置と終了文字位置が有効かどうかを判定します。ドキュメントへの編集を実行する前に、その編集内容を調整するために使用します。このメソッドはドキュメントの範囲外の値を返してはなりません。

このメソッドは次のいずれかの値を返します。

pacpResultStart と pacpResultEnd の値は、アプリケーションがドキュメントにテキストをどのように挿入するかによって異なります。pacpResultStart と pacpResultEnd が acpTextStart と同じ場合、挿入後のカーソルは挿入テキストの先頭に位置します。pacpResultStart と pacpResultEnd が acpTextEnd と同じ場合、挿入後のカーソルは挿入テキストの末尾に位置します。pacpResultStart と pacpResultEnd の差が挿入テキストの長さと等しい場合、挿入後に挿入テキストが選択状態(強調表示)になります。

ドキュメント内のテキスト選択範囲の文字位置を取得します。このメソッドは複数のテキスト選択範囲に対応します。呼び出し元は、このメソッドを呼び出す前にドキュメントの読み取り専用ロックを保持している必要があります。

このメソッドは次のいずれかの値を返します。

ドキュメント内のテキストを選択します。アプリケーションは、このメソッドを呼び出す前にドキュメントの読み取り/書き込みロックを保持している必要があります。

このメソッドは次のいずれかの値を返します。

指定した文字位置のテキストに関する情報を取得します。このメソッドは可視テキストと不可視テキストを返し、テキストに埋め込みデータが付随しているかどうかを示します。

このメソッドは次のいずれかの値を返します。

このメソッドを使用する呼び出し元は、RequestLock メソッドを呼び出してドキュメントの読み取り専用ロックを取得している必要があります。読み取り専用ロックがない場合、このメソッドは失敗し TF_E_NOLOCK を返します。

また、アプリケーションは内部的な理由からメソッドの戻り値を切り詰めることがあります。呼び出し元は、返された文字数とテキストランの数を注意深く確認し、必要な戻り値を取得してください。戻り値が不完全な場合は、完全になるまでメソッドを繰り返し呼び出してください。

呼び出し元は、cRunInfoReq パラメーターを 0、prgRunInfo パラメーターを NULL に設定することで、プレーンテキストのみを要求できます。また、cchPlainReq パラメーターを 0、pchPlain パラメーターを NULL に設定することで、テキストランのデータのみを要求できます。ただし、pcchPlainRet については、使用しない場合でも有効な非 NULL の値を指定する必要があります。

acpEnd が -1 の場合は、ストリームの末尾が指定されたものとして扱ってください。それ以外の場合、この値は 0 以上になります。

復帰時、pacpNext には、戻り値で参照されなかったストリーム内の次の文字の文字位置を設定してください。呼び出し元はこれを利用して、複数回の GetText 呼び出しによりテキストを高速に走査できます。

指定された文字位置にテキスト選択範囲を設定します。

このメソッドは次のいずれかの値を返します。

アプリケーションは、まず InsertTextAtSelection を使用してコンポジション(変換中の文字列)を開始すべきです。SetText は既存のコンポジション内でのみ使用してください。SetText の呼び出し時に有効なコンポジションが存在しない場合、TSF マネージャーは SetText の呼び出しを包む最小限の期間だけ存続するコンポジションを作成します。

acpStart および acpEnd の文字位置は、ドキュメントの範囲外にはできません。

アプリケーションは、このメソッドへの応答として OnTextChange メソッドを呼び出してはなりません。

このメソッドは、SetSelection メソッドを呼び出して変更対象のテキストを選択する必要があります。SetSelection メソッドが正常に実行された後、このメソッドは InsertTextAtSelection メソッドを呼び出して実際のテキスト変更を行います。

指定したテキスト文字列に関する書式付きテキストデータを取得します。呼び出し元は、このメソッドを呼び出す前にドキュメントの読み取り/書き込みロックを保持している必要があります。

このメソッドは次のいずれかの値を返します。

埋め込みドキュメントを取得します。(ITextStoreACP2.GetEmbedded)

このメソッドは次のいずれかの値を返します。

適切なインターフェイスを調べるには QueryInterface を使用します。対象となるインターフェイスには、埋め込みドキュメントやコントロールに関連する IOleObject、IDataObject、IViewObject、IPersistStorage、IOleCache、IDispatch などがあります。

指定されたオブジェクトをドキュメントに挿入できるかどうかを示す値を取得します。(ITextStoreACP2.QueryInsertEmbedded)

このメソッドは次のいずれかの値を返します。

ドキュメントがサポートするクリップボード形式は、アプリケーションによって異なります。

指定した文字位置に埋め込みオブジェクトを挿入します。(ITextStoreACP2.InsertEmbedded)

このメソッドは次のいずれかの値を返します。

挿入ポイントまたは選択範囲にテキストを挿入します。呼び出し元は、テキストを挿入する前にドキュメントの読み取り/書き込みロックを保持している必要があります。

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT のエラーコードを返します。

pacpStart および pacpEnd パラメーターの値は、クライアントアプリケーションがドキュメントにテキストをどのように挿入するかによって異なります。例えば、テキスト挿入後にアプリケーションがカーソルを挿入テキストの先頭に設定する場合、pacpStart と pacpEnd パラメーターの値は TS_TEXTCHANGE 構造体の acpStart メンバーと同じ値になります。

アプリケーションは、このメソッドへの応答として OnTextChange メソッドを呼び出してはなりません。

挿入ポイントまたは選択範囲に IDataObject を挿入します。このメソッドを呼び出すクライアントは、IDataObject オブジェクトをドキュメントに挿入する前に読み取り/書き込みロックを保持している必要があります。

このメソッドは次のいずれかの値を返します。

pacpStart および pacpEnd パラメーターの値は、クライアントアプリケーションがドキュメントにオブジェクトをどのように挿入するかによって異なります。例えば、オブジェクト挿入後にアプリケーションがカーソルをオブジェクトの先頭に設定する場合、pacpStart と pacpEnd パラメーターの値は TS_TEXTCHANGE 構造体の acpStart メンバーと同じ値になります。

ドキュメントでサポートされている属性を取得します。(ITextStoreACP2.RequestSupportedAttrs)

このメソッドは次のいずれかの値を返します。

指定した文字位置のテキスト属性を取得します。(ITextStoreACP2.RequestAttrsAtPosition)

このメソッドは次のいずれかの値を返します。

"This is italic text." という文では、italic 属性は italic という語の手前で始まり、text という語の後ろで終わります。

dwFlags に TS_ATTR_FIND_WANT_END フラグが設定されている場合、アンカーの位置に終了の遷移があるため、このメソッドはテキスト "italic <anchor>normal" に対して italic 属性を返します。

指定した文字位置で遷移するテキスト属性を取得します。(ITextStoreACP2.RequestAttrsTransitioningAtPosition)

このメソッドは次のいずれかの値を返します。

"This is italic text." という文では、italic 属性は italic という語の手前で始まり、text という語の後ろで終わります。

dwFlags に TS_ATTR_FIND_WANT_END フラグが設定されている場合、アンカーの位置に終了の遷移があるため、このメソッドはテキスト "italic <anchor>normal" に対して italic 属性を返します。

属性値の遷移が発生する文字位置を判定します。確認する属性はアプリケーションによって異なります。

このメソッドは次のいずれかの値を返します。

属性要求メソッドの呼び出しによって返された属性を取得します。(ITextStoreACP2.RetrieveRequestedAttrs)

このメソッドは次のいずれかの値を返します。

ドキュメント内の文字数を取得します。

このメソッドは次のいずれかの値を返します。

現在アクティブなビューを表す TsViewCookie を取得します。

このメソッドに戻り値はありません。

スクリーン座標上の点をアプリケーション文字位置に変換します。

このメソッドは次のいずれかの値を返します。

指定した文字位置のテキストの外接矩形をスクリーン座標で取得します。呼び出し元は、このメソッドを呼び出す前にドキュメントの読み取り専用ロックを保持している必要があります。

このメソッドは次のいずれかの値を返します。

ドキュメントウィンドウが最小化されている場合や、指定されたテキストが現在表示されていない場合、このメソッドは prc パラメーターを {0,0,0,0} に設定して S_OK を返します。

テキストストリームが描画される表示面の外接矩形をスクリーン座標で取得します。

このメソッドは次のいずれかの値を返します。

ドキュメントウィンドウが最小化されている場合など、テキストが現在表示されていない場合、prc パラメーターは { 0, 0, 0, 0 } に設定されます。