メインコンテンツまでスキップ
バージョン: 開発中

GET LIST ITEM

GET LIST ITEM ( {* ;} list ; itemPos | * ; itemRef ; itemText {; sublist ; expanded} )

引数説明
*演算子指定時, listはオブジェクト名 (文字列) 省略時, listはリスト参照番号
listInteger, Textリスト参照番号 (* 省略時), または リストオブジェクト名 (* 指定時)
itemPos | *演算子, 倍長整数展開/折りたたまれたリスト中の項目位置 * の場合、リスト中のカレント項目
itemRefInteger項目参照番号
itemTextTextリスト項目テキスト
sublistIntegerサブリストリスト参照番号 (サブリストがある場合)
expandedBooleanサブリストが添付されている場合: TRUE = サブリストは現在展開されている FALSE = サブリストは折りたたまれている

このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。

説明

GET LIST ITEM コマンドは、リスト参照番号またはオブジェクト名がlistであるリスト中、itemPosで指定した項目に関する情報を返します。

1番目の * 引数を渡した場合、list 引数はフォーム中のリストオブジェクトのオブジェクト名 (文字列) です。この引数を渡さない場合、list 引数はリスト参照番号 (ListRef) です。1つしかフォーム上でリストオブジェクトを使用しない場合、いずれのシンタックスも使用できます。同じリストの複数のリストオブジェクトがフォーム上にある場合は、リストオブジェクトごとに展開/折りたたみが異なるため、オブジェクト名に基づくシンタックスを使用しなければなりません。

Note: オブジェクト名に@文字を使用し、フォーム上にこれに合致するリストオブジェクトが複数ある場合、GET LIST ITEM コマンドは最初に見つけたリストオブジェクトを検索の対象とします。

項目位置は、リストの現在の展開/折りたたみ状況に基づき、相対的に示されなければなりません。1 から Count list itemsで返される値までの数値を渡します。この範囲外の数値を渡すと、GET LIST ITEMは空の値 (0, "", など) を返します。

コマンドの呼出し後、以下の情報が返されます:

  • itemRefに項目参照番号。
  • itemTextに項目テキスト。

オプションの引数 sublistexpanded を渡した場合:

  • subListに、その項目に添付されたサブリストのリスト参照番号。項目にサブリストが添付されていない場合、subListには0が返されます。
  • 項目にサブリストが添付されているとき、expandedにはサブリストが展開されていればTRUEが、折りたたまれていればFALSEが返されます。

例題 1

hList は項目にユニークな参照番号が与えられたリストです。以下のコードはプログラムで、現在選択されている項目のサブリストの展開/折りたたみを切り替えます:

 $vlItemPos:=Selected list items(hList)
 If($vlItemPos>0)
    GET LIST ITEM(hList;$vlItemPos;$vlItemRef;$vsItemText;$hSublist;$vbExpanded)
    If(Is a list($hSublist))
       SET LIST ITEM(hList;$vlItemRef;$vsItemText;$vlItemRef;$hSublist;Not($vbExpanded))
    End if
 End if

例題 2

APPEND TO LIST コマンドの例題を参照

参照

GET LIST ITEM PROPERTIES
List item parent
List item position
Selected list items
SET LIST ITEM
SET LIST ITEM PROPERTIES