IGridProvider

COM

IIDb17d6187-0907-464b-a168-0ef17a1572b1継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

キーボードを使用して走査可能な(つまり Microsoft UI Automation クライアントが隣接するコントロールへ移動できる)、2 次元の論理座標系で編成された子要素のコレクションのコンテナーとして機能するコントロールへのアクセスを提供します。

解説(Remarks)

IGridProvider インターフェイスは、子要素のコレクションのコンテナーとして機能するコントロールに対する UI Automation クライアントのアクセスをサポートするためのメソッドとプロパティを公開します。この要素の子は IGridItemProvider を実装し、キーボードを使用して走査可能な(つまり UI Automation クライアントが隣接するコントロールへ移動できる)、2 次元の論理座標系で編成されている必要があります。

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

IGridProvider は、グリッドの能動的な操作を有効にするものではありません。そのためには ITransformProvider を実装する必要があります。

メソッド 3

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

vtbl 3 HRESULT GetItem(INT row, INT column, IRawElementProviderSimple** pRetVal)

指定したセルの Microsoft UI Automation プロバイダーを取得します。

row	INT	in	対象となる行の序数。
column	INT	in	対象となる列の序数。
pRetVal	IRawElementProviderSimple**	out	指定したセルの UI Automation プロバイダーへのポインターを受け取ります。セルが空の場合は null 参照(Microsoft Visual Basic .NET では Nothing)を受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

グリッド座標は 0 から始まり、左上(ロケールによっては右上)のセルの座標が (0,0) となります。

セルが空の場合でも、そのセルの ContainingGrid プロパティをサポートするために、UI Automation プロバイダーを返す必要があります。これは、グリッド内の子要素のレイアウトがジャグ配列(ragged array)に似ている場合に発生します。

非表示の行と列は、プロバイダーの実装によっては UI Automation ツリーに読み込まれることがあり、その場合は IGridProvider::RowCount プロパティおよび IGridProvider::ColumnCount プロパティに反映されます。非表示の行と列がまだ読み込まれていない場合は、カウントに含めるべきではありません。

vtbl 4 HRESULT get_RowCount(INT* pRetVal)

グリッド内の行の総数を指定します。

pRetVal

INT*

out

グリッドの行数を受け取る出力ポインタである。

解説(Remarks)

非表示の行と列は、プロバイダーの実装によっては論理ツリーに読み込まれることがあり、その場合は IGridProvider::RowCount プロパティおよび IGridProvider::ColumnCount プロパティに反映されます。非表示の行と列がまだ読み込まれていない場合は、カウントに含まれません。

vtbl 5 HRESULT get_ColumnCount(INT* pRetVal)

グリッド内の列の総数を指定します。

pRetVal

INT*

out

グリッドの列数を受け取る出力ポインタである。

解説(Remarks)

非表示の行と列は、プロバイダーの実装によっては論理ツリーに読み込まれることがあり、その場合は IGridProvider::RowCount プロパティおよび IGridProvider::ColumnCount プロパティに反映されます。非表示の行と列がまだ読み込まれていない場合は、カウントに含まれません。

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