ホーム › UI.Controls.RichEdit › ITextHost2

ITextHost2

COM

📘 Microsoft Learn (日本語) · English

継承元ITextHost自前メソッド開始 vtbl42

公式ドキュメント

ITextHost2 インターフェイスは、ITextHost インターフェイスを拡張します。

メソッド 12

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

vtbl 42 BOOL TxIsDoubleClickPending()

テキストホストウィンドウ宛てに保留されている WM_LBUTTONDBLCLK メッセージがメッセージキューに含まれているかどうかを調べます。

戻り値

型: BOOL

WM_LBUTTONDBLCLK メッセージが保留されている場合は TRUE を、そうでない場合は FALSE を返します。

vtbl 43 HRESULT TxGetWindow(HWND* phwnd)

リッチエディットコントロールのテキストホストウィンドウのハンドルを取得します。

phwnd

HWND*

inout

テキストホストウィンドウのハンドル。

戻り値

型: HRESULT

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

vtbl 44 HRESULT TxSetForegroundWindow()

リッチエディットコントロールのホストウィンドウをフォアグラウンドウィンドウに設定します。

戻り値

型: HRESULT

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

vtbl 45 HPALETTE TxGetPalette()

リッチエディットコントロールのカラーパレットを取得します。

戻り値

型: HPALETTE

カラーパレットを返します。コントロールがシステムの既定のカラーパレットを使用している場合は NULL を返します。

vtbl 46 HRESULT TxGetEastAsianFlags(INT* pFlags)

Input Method Editor (IME) 入力が許可されているかどうか、および編集スタイルに ES_SELFIME が含まれているかどうかを取得します。

pFlags

INT*

inout

東アジア言語フラグ。

値	意味
ES_NOIME	IME 入力が抑制されます。
ES_SELFIME	リッチエディットクライアントが IME 入力を処理します。

戻り値

型: HRESULT

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

vtbl 47 HCURSOR TxSetCursor2(HCURSOR hcur, BOOL bText)

テキストホストウィンドウ内のカーソルの形状を設定します。

hcur	HCURSOR	in	新しいカーソルの形状。
bText	BOOL	in	カーソルがテキスト用に使用される場合は TRUE、そうでない場合は FALSE。

戻り値

型: HCURSOR

hcur が置き換えるカーソルを返します。

vtbl 48 void TxFreeTextServicesNotification()

テキストサービスが解放されたことをテキストホストに通知します。

解説(Remarks)

テキストホストがシャットダウンする際にこの通知を受け取っていない場合、テキストホストはテキストサービスに対してテキストホストの参照カウントを解放するように指示できます。

vtbl 49 HRESULT TxGetEditStyle(DWORD dwItem, DWORD* pdwData)

リッチエディットコントロールがダイアログボックス内にあるかどうかを取得します。

dwItem

DWORD

取得する編集スタイルフラグを示すマスク。次の値を指定できます。

TXES_ISDIALOG

pdwData

DWORD*

inout

値	意味
TXES_ISDIALOG	リッチエディットコントロールのホストがダイアログボックスであることを示します。

戻り値

型: HRESULT

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

vtbl 50 HRESULT TxGetWindowStyles(DWORD* pdwStyle, DWORD* pdwExStyle)

テキストホストウィンドウのウィンドウスタイルと拡張ウィンドウスタイルを取得します。

pdwStyle	DWORD*	inout	ウィンドウスタイル。指定可能な値の説明については、Window Styles を参照してください。
pdwExStyle	DWORD*	inout	拡張ウィンドウスタイル。指定可能な値の説明については、Extended Window Styles を参照してください。

戻り値

型: HRESULT

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

vtbl 51 HRESULT TxShowDropCaret(BOOL fShow, HDC hdc, RECT* prc)

ドラッグアンドドロップ操作のドロップ部分でキャレットを表示または非表示にします (Direct2D のみ)。

fShow	BOOL	in	表示または非表示のフラグ。TRUE はドロップキャレットを表示し、FALSE は非表示にします。
hdc	HDC	in	HDC。
prc	RECT*	inout	ドロップキャレットの矩形。

戻り値

型: HRESULT

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

vtbl 52 HRESULT TxDestroyCaret()

キャレットを破棄します (Direct2D のみ)。

戻り値

型: HRESULT

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

vtbl 53 HRESULT TxGetHorzExtent(INT* plHorzExtent)

テキストホストウィンドウの水平スクロール範囲を取得します。

plHorzExtent

INT*

inout

水平スクロール範囲。

戻り値

型: HRESULT

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

解説(Remarks)

リッチエディットコントロールはこの戻り値を使用しません。代わりに、最も幅の広い行からスクロール幅を取得します。

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

HSP用 COM定義

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

出力引数:

#define global IID_ITextHost2 "{}"
#usecom global ITextHost2 IID_ITextHost2 "{}"
#comfunc global ITextHost2_TxIsDoubleClickPending          42
#comfunc global ITextHost2_TxGetWindow                     43 sptr
#comfunc global ITextHost2_TxSetForegroundWindow           44
#comfunc global ITextHost2_TxGetPalette                    45
#comfunc global ITextHost2_TxGetEastAsianFlags             46 var
#comfunc global ITextHost2_TxSetCursor2                    47 sptr,int
#comfunc global ITextHost2_TxFreeTextServicesNotification  48
#comfunc global ITextHost2_TxGetEditStyle                  49 int,var
#comfunc global ITextHost2_TxGetWindowStyles               50 var,var
#comfunc global ITextHost2_TxShowDropCaret                 51 int,sptr,var
#comfunc global ITextHost2_TxDestroyCaret                  52
#comfunc global ITextHost2_TxGetHorzExtent                 53 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITextHost2 "{}"
#usecom global ITextHost2 IID_ITextHost2 "{}"
#comfunc global ITextHost2_TxIsDoubleClickPending          42
#comfunc global ITextHost2_TxGetWindow                     43 sptr
#comfunc global ITextHost2_TxSetForegroundWindow           44
#comfunc global ITextHost2_TxGetPalette                    45
#comfunc global ITextHost2_TxGetEastAsianFlags             46 sptr
#comfunc global ITextHost2_TxSetCursor2                    47 sptr,int
#comfunc global ITextHost2_TxFreeTextServicesNotification  48
#comfunc global ITextHost2_TxGetEditStyle                  49 int,sptr
#comfunc global ITextHost2_TxGetWindowStyles               50 sptr,sptr
#comfunc global ITextHost2_TxShowDropCaret                 51 int,sptr,sptr
#comfunc global ITextHost2_TxDestroyCaret                  52
#comfunc global ITextHost2_TxGetHorzExtent                 53 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。