ホーム › UI.TextServices › ITfInsertAtSelection

ITfInsertAtSelection

COM

IID55ce16ba-3014-41c1-9ceb-fade1446ac6c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfInsertAtSelection インターフェイスはマネージャーによって実装され、テキストサービスがコンテキストにテキストまたは埋め込みオブジェクトを挿入するために使用します。テキストサービスは ITfContext::QueryInterface を呼び出してこのインターフェイスを取得します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT InsertTextAtSelection(DWORD ec, INSERT_TEXT_AT_SELECTION_FLAGS dwFlags, LPWSTR pchText, INT cch, ITfRange** ppRange)

ITfInsertAtSelection::InsertTextAtSelection メソッド

DWORD

編集コンテキストを識別します。これは ITfDocumentMgr::CreateContext または ITfEditSession::DoEditSession から取得します。

dwFlags

INSERT_TEXT_AT_SELECTION_FLAGS

次のいずれかの値を持つビットフィールドです。

値	意味
TF_IAS_NOQUERY	ppRange は NULL になります。このフラグは TF_IAS_QUERYONLY フラグと組み合わせることはできません。
TF_IAS_QUERYONLY	コンテキストは変更されませんが、挿入が行われた場合と同様に ppRange が設定されます。読み取り専用アクセスで十分です。このフラグが設定されていない場合、ec は読み取り/書き込みアクセスを持つ必要があります。このフラグは TF_IAS_NOQUERY フラグと組み合わせることはできません。
TF_IAS_NO_DEFAULT_COMPOSITION	コンポジションが必要な場合でも、マネージャーは既定のコンポジションを作成しません。呼び出し元は、コンテキストのロックを解放する前に、挿入されたテキストを覆うコンポジションオブジェクトを作成する必要があります。

pchText

LPWSTR

挿入するテキストを指定します。

cch

INT

pchText のテキストの文字数を指定します。

ppRange

ITfRange**

out

挿入されたオブジェクトの位置を受け取ります。

戻り値

このメソッドは次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
TF_E_NOLOCK	テキストサービスがドキュメントロックを保持していません。
TF_E_DISCONNECTED	コンテキストオブジェクトがドキュメントスタック上にありません。
TS_E_NOSELECTION	コンテキストに選択範囲がありません。
TS_E_READONLY	選択範囲が読み取り専用です。

解説(Remarks)

テキストではなく IDataObject オブジェクトを挿入するには、ITfInsertAtSelection::InsertEmbeddedAtSelection を使用します。

vtbl 4 HRESULT InsertEmbeddedAtSelection(DWORD ec, DWORD dwFlags, IDataObject* pDataObject, ITfRange** ppRange)

ITfInsertAtSelection::InsertEmbeddedAtSelection メソッドは、選択範囲または挿入位置に IDataObject オブジェクトを挿入します。

ec	DWORD	in	編集コンテキストを識別します。これは ITfDocumentMgr::CreateContext または ITfEditSession::DoEditSession から取得します。
dwFlags	DWORD	in	次のいずれかの値を持つビットフィールドです。 TF_IAS_NOQUERY 終了時に ppRange パラメーターは NULL になります。 TF_IAS_QUERYONLY コンテキストは変更されませんが、挿入が行われた場合と同様に ppRange パラメーターが設定されます。読み取り専用アクセスで十分です。このフラグが設定されていない場合、ec パラメーターは読み取り/書き込みアクセスを持つ必要があります。 TF_IAS_NO_DEFAULT_COMPOSITION コンポジションが必要な場合でも、TSF マネージャーは既定のコンポジションを作成しません。呼び出し元は、コンテキストのロックを解放する前に、挿入されたテキストを覆うコンポジションオブジェクトを作成する必要があります。
pDataObject	IDataObject*	in	挿入するオブジェクトへのポインターです。
ppRange	ITfRange**	out	挿入されたオブジェクトの位置です。省略可能です。

戻り値

このメソッドは次のいずれかの値を返すことがあります。

値	説明
S_OK	メソッドは成功しました。
TF_E_NOLOCK	ec パラメーターが無効な編集クッキーです。
TF_E_DISCONNECTED	コンテキストオブジェクトがドキュメントスタック上にありません。
TS_E_NOSELECTION	コンテキストに選択範囲がありません。
TS_E_READONLY	選択範囲が読み取り専用です。
TF_E_FORMAT	コンテキストの所有者が、pDataObject パラメーターで指定された型のオブジェクトを扱えません。

解説(Remarks)

呼び出し元は ITfQueryEmbedded::QueryInsertEmbedded メソッドを使用して、特定の型のオブジェクトがこのメソッドで受け入れられる可能性があるかどうかを判断できます。

IDataObject オブジェクトではなくテキストを挿入するには、ITfInsertAtSelection::InsertTextAtSelection メソッドを使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

#define global IID_ITfInsertAtSelection "{55CE16BA-3014-41C1-9CEB-FADE1446AC6C}"
#usecom global ITfInsertAtSelection IID_ITfInsertAtSelection "{}"
#comfunc global ITfInsertAtSelection_InsertTextAtSelection      3 int,int,wstr,int,sptr
#comfunc global ITfInsertAtSelection_InsertEmbeddedAtSelection  4 int,int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。