LISTBOX GET ARRAYS

4D v18

LISTBOX GET ARRAYS


LISTBOX GET ARRAYS ( {* ;} object ; arrColNames ; arrHeaderNames ; arrColVars ; arrHeaderVars ; arrColsVisible ; arrStyles {; arrFooterNames ; arrFooterVars} )

引数	型	説明
*	演算子	指定時, objectはオブジェクト名 (文字列) 省略時, objectは変数
object	フォームオブジェクト	オブジェクト名 (* 指定時) または変数 (* 省略時)
arrColNames	文字配列	列オブジェクト名
arrHeaderNames	文字配列	ヘッダーオブジェクト名
arrColVars	ポインター配列	列変数へのポインターまたは列フィールドへのポインターまたはNil
arrHeaderVars	ポインター配列	ヘッダー変数へのポインター
arrColsVisible	ブール配列	列毎の表示状態
arrStyles	ポインター配列	配列へのポインターまたはスタイル、カラー、および行管理変数またはNil
arrFooterNames	文字配列	列フッターオブジェクト名
arrFooterVars	ポインター配列	列フッター変数へのポインター

説明

LISTBOX GET ARRAYSコマンドは一連の同期化された配列を返し、object引数および * で指定されたリストボックスの各列（表示または非表示）に関する情報を提供します。

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

コマンドを実行すると:

arrColNames配列には、リストボックス内の各列のオブジェクト名一覧が代入されます。
arrHeaderNames配列には、リストボックス内の各列ヘッダのオブジェクト名一覧が代入されます。
arrColVars配列には、リストボックス内の各列に関連付けられた変数（配列）へのポインタが代入されます。セレクションタイプのリストボックスの場合、arrColVars には:
- フィールドが関連付けられた列の場合、フィールドへのポインタ
- 変数が関連付けられた列の場合、変数へのポインタ
- 式が関連付けられた列の場合、Is nil pointerポインタが格納されます。
arrHeaderVars配列には、リストボックス内の各列ヘッダに関連付けられた変数へのポインタが代入されます。
arrColsVisible配列には各列に関するブール値が代入され、リストボックス内の列が表示（True）または非表示（False）のいずれであるかを示します。
arrStyles配列には、4つの配列をそれぞれ指す4つのポインタが代入されます。これら4つの配列は、リストボックス内の各行に対してスタイルやフォントカラー、背景色、各行のカスタムの表示管理を適用するために使用されます。これらの配列はデザインモードでリストボックスのプロパティリストで指定、あるいはLISTBOX SET ARRAY コマンドを使用して指定されたものです。リストボックスに対する配列が指定されていない場合、arrStyles内の対応する項目にはIs nil pointerポインタが代入されます。
4つめのポインターはブール型配列(非表示配列)、あるいは倍長整数配列(非表示、無効化、選択不可行を設定するのに使用する配列)に対応します。これは行管理配列に使用されている実装に基づきます(リストボックス特有のプロパティを参照して下さい)。
レコードセレクション型およびコレクション/エンティティセレクション型のリストボックスでは、arrStyles には:
- 変数により設定された設定ごとに、変数へのポインタが、
- 式により設定された設定ごとに、Is nil pointerポインタが格納されます。

参照

LISTBOX Get array
LISTBOX Get property
LISTBOX SET ARRAY