LISTBOX Get information

4D v15.4


LISTBOX Get information ( {* ;} object ; info ) -> 戻り値

引数	型	説明
*	演算子	指定時, objectはオブジェクト名 (文字列) 省略時, objectは変数
object	フォームオブジェクト	オブジェクト名 (* 指定時) または変数 (* 省略時)
info	倍長整数	取得する情報
戻り値	倍長整数	現在値

LISTBOX Get informationコマンドは、引数objectおよび * で指定されたリストボックスオブジェクトの、現在の表示状態やヘッダサイズ、スクロールバーに関する各種情報を返します。

オプションの引数 * を渡すことにより、object引数がオブジェクト名（文字列）であることを示します。この引数を渡さない場合、object引数が変数であることを示します。この場合、文字列ではなく変数参照を指定します。オブジェクト名についての詳細はオブジェクトプロパティを参照してください。

引数infoには、取得しようとする情報のタイプを示す値を渡します。この引数には値またはList Boxテーマの次の定数のいずれかを使用することができます:

定数	型	値	コメント
Listbox display footer	倍長整数	8	0 = 非表示 1 = 表示
Listbox display header	倍長整数	0	0=非表示, 1=表示
Listbox display hor scrollbar	倍長整数	2	0=非表示, 1=表示
Listbox display ver scrollbar	倍長整数	4	0=非表示, 1=表示
Listbox footer height	倍長整数	9	高さ (ピクセル)
Listbox header height	倍長整数	1	高さ (ピクセル)
Listbox hor scrollbar height	倍長整数	3	高さ (ピクセル)
Listbox hor scrollbar position	倍長整数	6	カーソルの位置 (ピクセル)
Listbox ver scrollbar position	倍長整数	7	カーソルの位置 (ピクセル)
Listbox ver scrollbar width	倍長整数	5	幅 (ピクセル)

最初の6つの定数を使用すると、リストボックスのサイズ計算に役立ちます。
定数Position listbox hor scrollbarとPosition listbox ver scrollbarを使用すると、LISTBOX Get informationコマンドは、例えばウィンドウの隠された部分のサイズなど、元の位置からの相対で、スクロールカーソルの位置をピクセル単位で返します。デフォルトの位置では、0となります。例えば、行の高さの情報と組み合わせることで、リストボックスに表示されたコンテンツを見つけることができます。
フッターが表示されている場合、ステートメント LISTBOX Get information(vLB;Listbox footer height) はLISTBOX Get footers heightコマンドと同じ値を返します。しかしフッターが表示されていなければLISTBOX Get informationは0を返し、LISTBOX Get footers heightは、この場合仮想的な、フッターの高さを返します。

行の高さが20ピクセルのリストボックスがある時、以下のコードを実行します:

$scroll:=LISTBOX Get information(*;"Listbox";Position listbox ver scrollbar)

$scrollの値が200の場合、リストボックスの最初から11番目の行が表示されていることがわかります。（200/20=10、10行がスクロールにより隠されている）

参照