ITextStoreACP2::InsertEmbeddedAtSelection メソッド (textstor.h)

  • [アーティクル]

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

構文

HRESULT InsertEmbeddedAtSelection(
  [in]  DWORD         dwFlags,
  [in]  IDataObject   *pDataObject,
  [out] LONG          *pacpStart,
  [out] LONG          *pacpEnd,
  [out] TS_TEXTCHANGE *pChange
);

パラメーター

[in] dwFlags

pacpStart パラメーターと pacpEnd パラメーターと TS_TEXTCHANGE 構造体にオブジェクト挿入の結果を含めるかどうかを指定します。

TF_IAS_NOQUERYフラグとTF_IAS_QUERYONLY フラグを組み合わせることはできません。

値 意味
0
 テキストの挿入が行われ、 pacpStart パラメーターと pacpEnd パラメーターにはテキスト挿入の結果が含まれます。 TS_TEXTCHANGE構造体には、このフラグを入力する必要があります。
TF_IAS_NOQUERY
 テキストが挿入され、 pacpStart パラメーターと pacpEnd パラメーターの値は NULL にすることができ、 TS_TEXTCHANGE 構造体を入力する必要があります。 テキストの挿入結果が不要な場合は、このフラグを使用します。
TF_IAS_QUERYONLY
 テキストは挿入されず、 pacpStart パラメーターと pacpEnd パラメーターの値にはテキスト挿入の結果が含まれます。 これらのパラメーターの値は、アプリケーションがドキュメントへのテキスト挿入をどのように実装するかによって異なります。 詳細については、「解説」を参照してください。

このフラグを使用して、テキストを実際に挿入せずにテキスト挿入の結果を表示します。たとえば、折りたたみの結果を予測したり、選択範囲を調整したりします。 TS_TEXTCHANGE構造体にこのフラグを設定する必要はありません。

[in] pDataObject

挿入する IDataObject オブジェクトへのポインター。

[out] pacpStart

オブジェクトの挿入が行われる開始アプリケーション文字位置へのポインター。

[out] pacpEnd

オブジェクトの挿入が行われる終了アプリケーション文字位置へのポインター。 このパラメーター値は、挿入ポイントの pacpStart パラメーターの値と同じになります。

[out] pChange

次のメンバーを 持つTS_TEXTCHANGE 構造体へのポインター。

値 意味
acpStart
 オブジェクトがドキュメントに挿入される前の開始アプリケーション文字位置。
acpOldEnd
 オブジェクトがドキュメントに挿入される前の終了アプリケーションの文字位置。 この値は、挿入ポイントの acpStart と同じです。 この値が acpStart と異なる場合は、オブジェクトの挿入前にテキストが選択されています。
acpNewEnd
 オブジェクトの挿入が行われた後の終了アプリケーション文字の位置。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

値 説明
S_OK
 メソッドは正常に実行されました。
E_INVALIDARG
 pchText パラメーターが無効です。
TS_E_NOLOCK
 呼び出し元は、ドキュメントに対するロックを持っていません。

注釈

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

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー textstor.h
[DLL] Msctf.dll

こちらもご覧ください

Idataobject

ITextStoreACP2

TF_IAS_* 定数

TS_TEXTCHANGE