List item position
List item position ( {* ;} list ; itemRef ) : Integer
引数 | 型 | 説明 | |
---|---|---|---|
* | 演算子 | → | 指定時, listはオブジェクト名 (文字列) 省略時, listはリスト参照番号 |
list | Integer, Text | → | リスト参照番号 (* 省略時), または リストオブジェクト名 (* 指定時) |
itemRef | Integer | → | 項目参照番号 |
戻り値 | Integer | ← | 展開/折りたたまれたリストにおける項目位置 |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
List item position コマンドは、listに渡された項目参照番号またはオブジェクト名リスト中で、itemRefで指定した項目の位置を返します。
オプションの第一引数 * を渡すと、list 引数はフォーム上のリストオブジェクトに対応するオブジェクト名 (文字列) です。この引数を渡さない場合、list 引数は階層リスト参照 (ListRef) です。リストオブジェクトを一つしか使わない場合、両方のシンタックスを使用できます。他方フォーム上に同じ階層リストを参照する複数のオブジェクトがある場合、それぞれのオブジェクトが個別に展開/折りたたみ状態をもつので、オブジェクト名に基づくシンタックスを使用しなければなりません。
Note: オブジェクト名に @ 文字を使用することで、名前に対応するオブジェクトが複数検索された場合、List item position コマンドは最初に見つけたオブジェクトを処理の対象とします。
Note: このテーマの他のコマンドと異なり、このコマンドではitemRefに0を渡して最後に追加された項目を指定することはできません。
位置はリストやサブリストの展開/折りたたみ状態を使用し、メインリストの先頭項目からの相対位置であらわされます。
結果は1からCount list itemsで返される数値までの間となります。
項目が縮小されているリストにあるために表示されていない場合、List item positionが適切なリストを展開してその項目を表示します。
項目が存在しない場合、LList item positionは0を返します。