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

ISelectionItemProvider

COM
📘 Microsoft Learn (日本語) · English
IID2acad808-b2d4-452d-a407-91ff1ad167b2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ISelectionProvider を実装するコンテナの、個別に選択可能な子コントロールへのアクセスを提供します。

解説(Remarks)

SelectionItem コントロールパターンをサポートする必要がある Microsoft UI Automation プロバイダーに実装されます。

メソッド 5

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

vtbl 3 HRESULT Select()

選択されているすべての項目の選択を解除し、現在の要素を選択します。

戻り値

型: HRESULT

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

解説(Remarks)

現在の要素が選択されていない場合、このメソッドは選択されているすべての項目の選択を解除してから、現在の要素を選択します。現在の要素が既に選択されている場合、このメソッドは何も行いません。

vtbl 4 HRESULT AddToSelection()

現在の要素を、選択されている項目のコレクションに追加します。(ISelectionItemProvider.AddToSelection)

戻り値

型: HRESULT

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

解説(Remarks)

ISelectionItemProvider::AddToSelection の呼び出しの結果として単一の項目が選択される場合は、 その要素に対して UIA_SelectionItem_ElementSelectedEventId イベントを送信します。それ以外の場合は、状況に応じて UIA_SelectionItem_ElementAddedToSelectionEventId または UIA_SelectionItem_ElementRemovedFromSelectionEventId イベントを送信します。

Note このルールは、コンテナが単一選択と複数選択のどちらを許可するか、 または選択の変更にどのメソッドが使用されたかには依存しません。結果のみが重要です。
vtbl 5 HRESULT RemoveFromSelection()

現在の要素を、選択されている項目のコレクションから削除します。

戻り値

型: HRESULT

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

解説(Remarks)

状況に応じて UIA_SelectionItem_ElementRemovedFromSelectionEventId イベントを送信します。

Note このルールは、コンテナが単一選択と複数選択のどちらを許可するか、 または選択の変更にどのメソッドが使用されたかには依存しません。結果のみが重要です。
vtbl 6 HRESULT get_IsSelected(BOOL* pRetVal)

項目が選択されているかどうかを示します。

pRetValBOOL*outこの項目が現在選択されているかどうかを受け取る BOOL へのポインタである。
vtbl 7 HRESULT get_SelectionContainer(IRawElementProviderSimple** pRetVal)

ISelectionProvider を実装し、呼び出し元オブジェクトのコンテナとして機能するプロバイダーを指定します。

pRetValIRawElementProviderSimple**outこの項目を含む選択コンテナーを表すプロバイダーを受け取る IRawElementProviderSimple へのポインタのポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISelectionItemProvider "{2ACAD808-B2D4-452D-A407-91FF1AD167B2}"
#usecom global ISelectionItemProvider IID_ISelectionItemProvider "{}"
#comfunc global ISelectionItemProvider_Select                  3
#comfunc global ISelectionItemProvider_AddToSelection          4
#comfunc global ISelectionItemProvider_RemoveFromSelection     5
#comfunc global ISelectionItemProvider_get_IsSelected          6 var
#comfunc global ISelectionItemProvider_get_SelectionContainer  7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。