ITextStoreACP2

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

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

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

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

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

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

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

punk パラメーターは、AdviseSink メソッドで最初に渡されたポインターと同じ COM アイデンティティを持つ必要があります。

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

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

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

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

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

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

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

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

ドキュメントの状態を取得します。ドキュメントの状態は 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 という単語の前から始まり、text という単語の後で終わります。

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

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

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

「This is italic text.」という文では、イタリック属性は italic という単語の前から始まり、text という単語の後で終わります。

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

属性値の遷移が発生する文字位置を特定します。確認対象として指定する属性はアプリケーションに依存します。

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

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

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

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

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

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

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

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

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

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

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

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

テキストストリームが描画される表示面の境界ボックスのスクリーン座標を取得します。

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

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