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

IUIAutomationExpandCollapsePattern

COM
📘 Microsoft Learn (日本語) · English
IID619be086-1f4e-4ee4-bafa-210128738730継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

内容を表示するために視覚的に展開したり、内容を隠すために折りたたんだりできるコントロールへのアクセスを提供します。

メソッド 4

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

vtbl 3 HRESULT Expand()

要素のすべての子ノード、コントロール、またはコンテンツを表示します。

戻り値

型: HRESULT

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

解説(Remarks)

これはブロッキングメソッドであり、要素が展開された後に戻ります。

リーフノードとしてマークされている要素が、IUIAutomationExpandCollapsePattern::Collapse メソッドまたは IUIAutomationExpandCollapsePattern::Expand メソッドが呼び出されるまで、子を持つかどうかを認識できない場合があります。この動作は、子項目の遅延読み込みを行うツリービューコントロールで発生する可能性があります。たとえば、Microsoft Windows Explorer は、現在子項目が存在しない場合でもノードに展開アイコンを表示することがあります。アイコンがクリックされると、コントロールは子項目をポーリングし、見つからなければ展開アイコンを削除します。このような場合、クライアントは IUIAutomationExpandCollapsePattern::CurrentExpandCollapseState プロパティのプロパティ変更イベントをリッスンする必要があります。

vtbl 4 HRESULT Collapse()

要素のすべての子ノード、コントロール、またはコンテンツを非表示にします。

戻り値

型: HRESULT

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

解説(Remarks)

これはブロッキングメソッドであり、要素が折りたたまれた後に戻ります。

リーフノードとしてマークされている要素が、IUIAutomationExpandCollapsePattern::Collapse メソッドまたは IUIAutomationExpandCollapsePattern::Expand メソッドが呼び出されるまで、子を持つかどうかを認識できない場合があります。この動作は、子項目の遅延読み込みを行うツリービューコントロールで発生する可能性があります。たとえば、Microsoft Windows Explorer は、現在子項目が存在しない場合でもノードに展開アイコンを表示することがあります。アイコンがクリックされると、コントロールは子項目をポーリングし、見つからなければ展開アイコンを削除します。このような場合、クライアントは IUIAutomationExpandCollapsePattern::CurrentExpandCollapseState プロパティのプロパティ変更イベントをリッスンする必要があります。

vtbl 5 HRESULT get_CurrentExpandCollapseState(ExpandCollapseState* retVal)

要素の状態(展開または折りたたみ)を示す値を取得します。

retValExpandCollapseState*out要素の現在の展開・折りたたみ状態を示す ExpandCollapseState 値を受け取るポインタである。
vtbl 6 HRESULT get_CachedExpandCollapseState(ExpandCollapseState* retVal)

要素の状態(展開または折りたたみ)を示すキャッシュされた値を取得します。

retValExpandCollapseState*outキャッシュされた展開・折りたたみ状態を示す ExpandCollapseState 値を受け取るポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationExpandCollapsePattern "{619BE086-1F4E-4EE4-BAFA-210128738730}"
#usecom global IUIAutomationExpandCollapsePattern IID_IUIAutomationExpandCollapsePattern "{}"
#comfunc global IUIAutomationExpandCollapsePattern_Expand                          3
#comfunc global IUIAutomationExpandCollapsePattern_Collapse                        4
#comfunc global IUIAutomationExpandCollapsePattern_get_CurrentExpandCollapseState  5 var
#comfunc global IUIAutomationExpandCollapsePattern_get_CachedExpandCollapseState   6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。