list_box Tile (DCL)

A list box contains a list of text strings, arranged in rows.

Supported Platforms: Windows only

: list_box {
   action alignment allow_accept fixed_height 
   fixed_width height is_enabled is_tab_stop 
   key label list mnemonic multiple_select tabs
   value width 
}

Usually the list is of variable length, but list boxes can be used for fixed-length lists when a different kind of tile, such as a set of radio buttons, takes up too much space in the dialog box. When users select a row, it is highlighted. A list box can contain more rows than can fit in the box, so a scroll bar always appears to the right of the list box. (The scroll bar is enabled only if the list has more items than can appear at once.) By dragging the scroll bar cursor or clicking on its arrows, users can scroll through the list box items. Some applications may allow users to select multiple rows.

Note: The list_box tile is limited to 32,768 entries with the first element being an index of 0 and the last being 32,767. Once the limit is reached, the value of any entry that has an index greater than 32,767 is not accurately reported.

label

Text displayed above the list box.

value

A quoted string containing zero ("") or more integers, separated by spaces (no default). Each integer is a zero-based index that indicates a list item that is initially selected. If multiple_select is false, value cannot contain more than one integer.

If the value string is empty (""), then no items in the list are initially selected. In this case, you don't need to specify the value attribute at all.