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

IUIAutomationScrollPattern

COM
📘 Microsoft Learn (日本語) · English
IID88f4d42a-e881-459d-a77c-73bbbb7e02dc継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

子要素のコレクションに対するスクロール可能なコンテナーとして機能するコントロールへのアクセスを提供します。

メソッド 14

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

vtbl 3 HRESULT Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)

コンテンツ領域の可視領域を水平方向および垂直方向にスクロールします。(IUIAutomationScrollPattern.Scroll)

horizontalAmountScrollAmountin水平方向のスクロール増分の大きさを示す値。水平位置を設定しない場合は UIA_ScrollPatternNoScroll を指定します。
verticalAmountScrollAmountin垂直方向のスクロール増分の大きさを示す ScrollAmount 列挙型の値。垂直位置を設定しない場合は UIA_ScrollPatternNoScroll を指定します。

戻り値

型: HRESULT

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

vtbl 4 HRESULT SetScrollPercent(DOUBLE horizontalPercent, DOUBLE verticalPercent)

UI Automation 要素内のコンテンツ領域全体に対する割合(パーセント)として、水平方向および垂直方向のスクロール位置を設定します。

horizontalPercentDOUBLEin水平方向のコンテンツ領域全体に対する割合(パーセント)。水平位置を設定しない場合は UIA_ScrollPatternNoScroll を指定します。
verticalPercentDOUBLEin垂直方向のコンテンツ領域全体に対する割合(パーセント)。垂直位置を設定しない場合は UIA_ScrollPatternNoScroll を指定します。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、コントロールのコンテンツ領域が可視領域よりも大きい場合にのみ有用です。

vtbl 5 HRESULT get_CurrentHorizontalScrollPercent(DOUBLE* retVal)

水平方向のスクロール位置を取得します。

retValDOUBLE*out現在の水平スクロール位置を割合(%)で受け取るポインタである。
vtbl 6 HRESULT get_CurrentVerticalScrollPercent(DOUBLE* retVal)

垂直方向のスクロール位置を取得します。

retValDOUBLE*out現在の垂直スクロール位置を割合(%)で受け取るポインタである。
vtbl 7 HRESULT get_CurrentHorizontalViewSize(DOUBLE* retVal)

スクロール可能な要素の可視領域の水平方向のサイズを取得します。

retValDOUBLE*outコンテンツ全体に対して水平方向に表示されている割合(%)を受け取るポインタである。
vtbl 8 HRESULT get_CurrentVerticalViewSize(DOUBLE* retVal)

スクロール可能な要素の可視領域の垂直方向のサイズを取得します。

retValDOUBLE*outコンテンツ全体に対して垂直方向に表示されている割合(%)を受け取るポインタである。
vtbl 9 HRESULT get_CurrentHorizontallyScrollable(BOOL* retVal)

要素が水平方向にスクロールできるかどうかを示します。

retValBOOL*out水平方向にスクロール可能かどうかを示す論理値を受け取るポインタである。

解説(Remarks)

このプロパティは動的に変化する場合があります。たとえば、要素のコンテンツ領域が現在の可視領域より大きくない場合、このプロパティは FALSE になります。しかし、要素のサイズを変更したり子項目を追加したりすると、コンテンツ領域の範囲が可視領域を超えて広がり、このプロパティが TRUE になることがあります。

vtbl 10 HRESULT get_CurrentVerticallyScrollable(BOOL* retVal)

要素が垂直方向にスクロールできるかどうかを示します。

retValBOOL*out垂直方向にスクロール可能かどうかを示す論理値を受け取るポインタである。

解説(Remarks)

このプロパティは動的に変化する場合があります。たとえば、要素のコンテンツ領域が現在の可視領域より大きくない場合、このプロパティは FALSE になります。しかし、要素のサイズを変更したり子項目を追加したりすると、コンテンツ領域の範囲が可視領域を超えて広がり、このプロパティが TRUE になることがあります。

vtbl 11 HRESULT get_CachedHorizontalScrollPercent(DOUBLE* retVal)

キャッシュされた水平方向のスクロール位置を取得します。

retValDOUBLE*outキャッシュされた水平スクロール位置を割合(%)で受け取るポインタである。
vtbl 12 HRESULT get_CachedVerticalScrollPercent(DOUBLE* retVal)

キャッシュされた垂直方向のスクロール位置を取得します。

retValDOUBLE*outキャッシュされた垂直スクロール位置を割合(%)で受け取るポインタである。
vtbl 13 HRESULT get_CachedHorizontalViewSize(DOUBLE* retVal)

スクロール可能な要素の可視領域の、キャッシュされた水平方向のサイズを取得します。

retValDOUBLE*outキャッシュされた水平方向の表示割合(%)を受け取るポインタである。
vtbl 14 HRESULT get_CachedVerticalViewSize(DOUBLE* retVal)

スクロール可能な要素の可視領域の、キャッシュされた垂直方向のサイズを取得します。

retValDOUBLE*outキャッシュされた垂直方向の表示割合(%)を受け取るポインタである。
vtbl 15 HRESULT get_CachedHorizontallyScrollable(BOOL* retVal)

要素が水平方向にスクロールできるかどうかを示す、キャッシュされた値を取得します。

retValBOOL*outキャッシュされた、水平方向にスクロール可能かどうかを示す論理値を受け取るポインタである。

解説(Remarks)

このプロパティは動的に変化する場合があります。たとえば、要素のコンテンツ領域が現在の可視領域より大きくない場合、このプロパティは FALSE になります。しかし、要素のサイズを変更したり子項目を追加したりすると、コンテンツ領域の範囲が可視領域を超えて広がり、このプロパティが TRUE になることがあります。

vtbl 16 HRESULT get_CachedVerticallyScrollable(BOOL* retVal)

要素が垂直方向にスクロールできるかどうかを示す、キャッシュされた値を取得します。

retValBOOL*outキャッシュされた、垂直方向にスクロール可能かどうかを示す論理値を受け取るポインタである。

解説(Remarks)

このプロパティは動的に変化する場合があります。たとえば、要素のコンテンツ領域が現在の可視領域より大きくない場合、このプロパティは FALSE になります。しかし、要素のサイズを変更したり子項目を追加したりすると、コンテンツ領域の範囲が可視領域を超えて広がり、このプロパティが TRUE になることがあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationScrollPattern "{88F4D42A-E881-459D-A77C-73BBBB7E02DC}"
#usecom global IUIAutomationScrollPattern IID_IUIAutomationScrollPattern "{}"
#comfunc global IUIAutomationScrollPattern_Scroll                              3 int,int
#comfunc global IUIAutomationScrollPattern_SetScrollPercent                    4 double,double
#comfunc global IUIAutomationScrollPattern_get_CurrentHorizontalScrollPercent  5 var
#comfunc global IUIAutomationScrollPattern_get_CurrentVerticalScrollPercent    6 var
#comfunc global IUIAutomationScrollPattern_get_CurrentHorizontalViewSize       7 var
#comfunc global IUIAutomationScrollPattern_get_CurrentVerticalViewSize         8 var
#comfunc global IUIAutomationScrollPattern_get_CurrentHorizontallyScrollable   9 var
#comfunc global IUIAutomationScrollPattern_get_CurrentVerticallyScrollable     10 var
#comfunc global IUIAutomationScrollPattern_get_CachedHorizontalScrollPercent   11 var
#comfunc global IUIAutomationScrollPattern_get_CachedVerticalScrollPercent     12 var
#comfunc global IUIAutomationScrollPattern_get_CachedHorizontalViewSize        13 var
#comfunc global IUIAutomationScrollPattern_get_CachedVerticalViewSize          14 var
#comfunc global IUIAutomationScrollPattern_get_CachedHorizontallyScrollable    15 var
#comfunc global IUIAutomationScrollPattern_get_CachedVerticallyScrollable      16 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。