ITextProvider2

COM

IID0dc5e6ed-3e16-4bf1-8f9a-a979878bc195継承元ITextProvider自前メソッド開始 vtbl9

公式ドキュメント

ITextProvider インターフェイスを拡張し、Microsoft UI Automation プロバイダーが、注釈(annotation)の対象となるテキストコンテンツや、プロバイダーが所有するキャレットに関する情報を公開できるようにします。

メソッド 2

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

vtbl 9 HRESULT RangeFromAnnotation(IRawElementProviderSimple* annotationElement, ITextRangeProvider** pRetVal)

指定された注釈要素に関連付けられた注釈の対象となるテキストを含むテキスト範囲を公開します。

annotationElement	IRawElementProviderSimple*	in	IAnnotationProvider インターフェイスを実装する要素のプロバイダーです。この注釈要素は、ドキュメントに対して ITextProvider2 インターフェイスを実装する要素の兄弟(sibling)です。
pRetVal	ITextRangeProvider**	out	注釈の対象となるテキストを含むテキスト範囲を受け取ります。

戻り値

Type: HRESULT

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

vtbl 10 HRESULT GetCaretRange(BOOL* isActive, ITextRangeProvider** pRetVal)

テキストベースのコントロールが所有するキャレットの位置に、長さ 0 のテキスト範囲を提供します。

isActive	BOOL*	out	キャレットを含むテキストベースのコントロールがキーボードフォーカスを持つ場合は TRUE、それ以外の場合は FALSE です。
pRetVal	ITextRangeProvider**	out	テキストベースのコントロールが所有するキャレットの現在の位置を表すテキスト範囲です。

戻り値

Type: HRESULT

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

解説(Remarks)

isActive パラメーターが FALSE の場合、テキストベースのコントロールが所有するキャレットは、システムキャレットと同じ位置にあるとは限りません。

このメソッドは、クライアントがテキストベースのコントロールが所有するキャレットの外接矩形を求めたり、キャレット付近のテキストを見つけたりするために使用できるテキスト範囲を取得します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITextProvider2 "{0DC5E6ED-3E16-4BF1-8F9A-A979878BC195}"
#usecom global ITextProvider2 IID_ITextProvider2 "{}"
#comfunc global ITextProvider2_RangeFromAnnotation  9 sptr,sptr
#comfunc global ITextProvider2_GetCaretRange        10 var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITextProvider2 "{0DC5E6ED-3E16-4BF1-8F9A-A979878BC195}"
#usecom global ITextProvider2 IID_ITextProvider2 "{}"
#comfunc global ITextProvider2_RangeFromAnnotation  9 sptr,sptr
#comfunc global ITextProvider2_GetCaretRange        10 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。