GET LIST ITEM

version 2004 (Modified)

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

The GET LIST ITEM command returns information about the item specified by itemPos of the list whose reference number is passed in list.

The position must be expressed relatively, using the current expanded/collaped state of the list and its sublist. You pass a position value between 1 and the value returned by Count list items. If you pass a value outside this range, GET LIST ITEM returns empty values (0, "", etc.).

After the call, you retrieve:

• The item reference number of the item in itemRef.

• The text of the item in itemText.

If you passed the optional parameters sublist and expanded:

• subList returns the list reference number of the sublist attached to the item. If the item has no sublist, subList returns zero (0).

• If the item has a sublist, expanded returns TRUE if the sublist is currently expanded, and FALSE if it is collapsed.

1. hList is a list whose items have unique reference numbers. The following code programmatically toggles the expanded/collapsed state of the sublist, if any, attached to the current selected item:

   $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))
         REDRAW LIST(hList)
      End if 
   End if 

2. Refer to the example of the APPEND TO LIST command.

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