メインコンテンツまでスキップ
バージョン: 次へ

LISTBOX Get property

LISTBOX Get property ( {* ;} object ; property ) : any

引数説明
*演算子指定時、object はオブジェクト名(文字列)。 省略時、object は変数。
objectanyオブジェクト名 (* 指定時) または変数 (* 省略時)
propertyInteger値を取得したいプロパティ
戻り値Integer, Textカレントの値

説明

LISTBOX Get property コマンドは、object 引数および * 引数を使用して指定したリストボックスまたはリストボックスカラムの、 property で指定したプロパティの値を返します。

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

注: object および * で指定されたリストボックスまたはカラムが存在しない場合には、LISTBOX Get property コマンドはプロパティの種類により -1 (数値の場合) または空文字列 (文字列の場合) を返します。

property 引数には、取得しようとするプロパティを表す定数を渡します。 この引数には“List Box” テーマの次の定数のいずれかを使用することができます:

定数説明
lk allow wordwrap14ワードラップ プロパティ
適用対象: カラム *
取り得る値:
lk no (0)
lk yes (1)
lk auto row height31配列型リストボックスの 自動行高 プロパティ
適用対象: リストボックスあるいはカラム
取りうる値:
lk no (0)
lk yes (1)
lk background color expression22セレクション型、コレクションまたはエンティティセレクション型リストボックスの 背景色式 プロパティ
適用対象: リストボックスあるいはカラム
lk cell horizontal padding36横方向パディング プロパティ
セル内の横方向パディング(ピクセル単位、左右のパディングで同じ値)
敵意用対象: リストボックス、カラム、ヘッダー、フッター
lk cell vertical padding37縦方向パディング プロパティ
セルの縦方向パディング(ピクセル単位、上下のパディングで同じ値)
適用対象: リストボックス、カラム、ヘッダー、フッター
lk column max width26最大幅 プロパティ
適用先: カラム *
lk column min width25最小幅 プロパティ
適用対象: カラム *
lk column resizable15リサイズ可 プロパティ
適用対象: カラム *
取り得る値:
lk no (0)
lk yes (1)
lk detail form name19セレクション型リストボックスの 詳細フォーム名 プロパティ
適用対象: リストボックス
lk display footer8フッターを表示 プロパティ
適用対象: リストボックス
取り得る値:
lk no (0): 非表示
lk yes (1): 表示
lk display header0ヘッダーを表示 プロパティ
適用対象: リストボックス
取り得る値:
lk no (0): 非表示
lk yes (1): 表示
lk display type21数値カラムに対しての 表示タイプ プロパティ
適用対象: カラム *
取り得る値:
lk numeric format (0): 値を数値フォーマットで表示
lk three states checkbox (1): 値を3ステートチェックボックスとして表示
lk double click on row18セレクション型リストボックスの 行をダブルクリック プロパティ
適用対象: リストボックス
取り得る値:
lk do nothing (0): どの自動アクションもトリガーしない
lk edit record (1): 対応するレコードを読み書き可能モードで表示
lk display record (2): 対応するレコードを読み込みのみモードで表示
lk extra rows13余分な空白行を隠す プロパティ
適用対象: リストボックス
取り得る値:
lk display (0)
lk hide (1)
lk font color expression23セレクション型、コレクションまたはエンティティセレクション型リストボックスの フォントカラー式 プロパティ
適用対象: リストボックスあるいはカラム
lk font style expression24セレクション型、コレクションまたはエンティティセレクション型リストボックスの スタイル式 プロパティ
適用対象: リストボックスあるいはカラム
lk hide selection highlight16セレクションハイライトを非表示 プロパティ
適用対象: リストボックス
取り得る値:
lk no (0)
lk yes (1)
lk highlight set27セレクション型リストボックスの セットをハイライト プロパティ
適用対象: リストボックス
lk hor scrollbar height3高さ(ピクセル単位)
lk meta expression34コレクションまたはエンティティセレクション型リストボックスの メタ情報式 プロパティ
適用対象: リストボックス
lk movable rows35配列型リストボックスの 行の移動可 プロパティ
適用対象: リストボックス(ただし階層モードを除く)
取り得る値:
lk no (0): 行はランタイムに移動させられない
lk yes (1): 行はランタイムに移動させられる(デフォルト)
lk multi style30マルチスタイル のプロパティ
適用対象: カラム*
取り得る値:
lk no (0)
lk yes (1)
lk named selection28セレクション型リストボックスの 命名セレクション プロパティ
適用対象: リストボックス
lk resizing mode11カラムの自動リサイズ プロパティ
適用対象: リストボックス
取り得る値:
lk manual (0)
lk automatic (2)
lk row height unit17行の高さ プロパティの単位
適用対象: リストボックス
取り得る値:
lk lines (1)
lk pixels (0)
lk selection mode10選択モード プロパティ
適用対象: リストボックス
取り得る値:
lk none (0)
lk single (1)
lk multiple (2)
lk single click edit29シングルクリック編集 プロパティ
適用対象: リストボックス
取り得る値:
lk no (0)
lk yes (1)
lk sortable20ソート可 プロパティ
適用対象: リストボックス
取り得る値:
lk no (0)
lk yes (1)
lk truncate12エリプシスで省略 プロパティ
適用対象: リストボックスあるいはカラム
取り得る値:
lk without ellipsis (0)
lk with ellipsis (1)
lk ver scrollbar width5幅(ピクセル単位)
lk current item expression38カレントの項目 プロパティ
適用対象: リストボックス(コレクション / エンティティセレクション)
lk current item pos expression39カレントの項目の位置 プロパティ
適用対象: リストボックス(コレクション / エンティティセレクション)
lk selected items expression40選択された項目 プロパティ
適用対象: リストボックス(コレクション / エンティティセレクション)

*印が付いているプロパティはリストボックスカラム専用のものです。このプロパティ群の定数をリストボックスとともに引数として受け渡すと、LISTBOX Get propertyproperty に指定したプロパティの種類に応じて -1、あるいは空文字列を返します。

通常、無効な結果を表すためには LISTBOX Get property は、数値型の値を持つプロパティに対しては-1 を、または空の文字列を返します。ただしこのときエラーは生成されません。 具体的には次の場合が該当します:

  • 存在しない property を渡した場合
  • property に受け渡した定数が指定のリストボックスおよびカラムにおいて利用できないプロパティである。例: lk font color expression を配列型リストボックスと一緒に指定した場合
  • カラムを引数として渡したが指定した property の適用対象がリストボックスである、あるいは逆にリストボックスを引数として渡したが指定した property の適用対象がカラムである(上記の * 印の注記参照)

また、複数のカラムからの値を同時に返すことはできません。例えば、"@" 記号を利用して複数の類似した名称を持つカラムを一括で指定しようとしても、 LISTBOX Get property は最初に条件に合致したカラムについてのみ、値を返します。そのため、この戻り値は信頼できるものではありません。

Note:

  • 定数 lk display footer および lk display header はフォーム上のリストボックスエリアの実サイズを計算するのに便利です。

例題 1

"MyListbox"というリストボックスがあったとき、以下のステートメントを実行すると:

 $Value:=LISTBOX Get property(*;"MyListbox";lk selection mode) // 返された値は選択モードを表します

この場合、返される値は複数行が選択可能かどうかを表します。

例題 2

"MyListbox"というリストボックスがある場合、以下のステートメントを実行すると:

 $resizable:=LISTBOX Get property(*;"MyListbox";lk column resizable)

LISTBOX Get property は-1を返します。なぜならlk column resizable プロパティはカラムに適用される一方で、引数として渡されたのはリストボックスだからです。

参照

LISTBOX SET GRID
LISTBOX SET PROPERTY
OBJECT SET SCROLLBAR

プロパティ

コマンド番号917
スレッドセーフ