Win32 API 日本語リファレンス
ホームUI.Accessibility › IUIAutomationTextPattern2

IUIAutomationTextPattern2

COM
IID506a921a-fcc9-409f-b23b-37eb74106872継承元IUIAutomationTextPattern自前メソッド開始 vtbl9

公式ドキュメント

IUIAutomationTextPattern インターフェースを拡張します。

メソッド 2

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

vtbl 9 HRESULT RangeFromAnnotation(IUIAutomationElement* annotation, IUIAutomationTextRange** range)

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

annotationIUIAutomationElement*in対象テキストを取得する対象の注釈要素です。この要素は、ドキュメントに対して IUIAutomationTextPattern2 を実装する要素の兄弟要素です。
rangeIUIAutomationTextRange**out注釈の対象テキストを含むテキスト範囲を受け取ります。

戻り値

型: HRESULT

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

vtbl 10 HRESULT GetCaretRange(BOOL* isActive, IUIAutomationTextRange** range)

テキストベースのコントロールに属するキャレットの位置にある長さ 0 のテキスト範囲を取得します。

isActiveBOOL*outキャレットを含むテキストベースのコントロールがキーボードフォーカスを持つ場合は TRUE、そうでない場合は FALSE です。
rangeIUIAutomationTextRange**outテキストベースのコントロールに属するキャレットの現在の位置を表すテキスト範囲を受け取ります。

戻り値

型: 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_IUIAutomationTextPattern2 "{506A921A-FCC9-409F-B23B-37EB74106872}"
#usecom global IUIAutomationTextPattern2 IID_IUIAutomationTextPattern2 "{}"
#comfunc global IUIAutomationTextPattern2_RangeFromAnnotation  9 sptr,sptr
#comfunc global IUIAutomationTextPattern2_GetCaretRange        10 var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。