LIST

LIST N

CREATES A SYSTEM OBJECT LIST AND ALLOCATES IT NUMBER N AS REFERENCE

  • Type: Command
  • Parameter: 1
  • Group: System Objects Creation

ACTION

The command LIST N creates a system object LIST, and allocates it a number N. The number N will be used to designate this LIST.

The created LIST can then be used through the appropriated commands.

The LIST is created at position (0,0) : that is TOP = 0 pixel and LEFT = 0 pixel, with dimensions WIDTH = 121 pixels and HEIGHT = 97 pixels.

A LIST displays a list of choices and the user can select one item.

A LIST can generate the events : ON_CLICK, ON_DOUBLE_CLICK, ON_KEY_UP, ON_KEY_DOWN.

Remark 1: by default, the LIST is created on the FORM number 0, but another FORM can be used. For that, create a FORM by FORM N, and send it all the commands by COMMAND_TARGET_IS N before creating the LIST.

Remark 2: if the LIST is completely filled, adding a new item creates automatically a vertical scrollbar.

Remark 3: a LIST is filled with the commands ITEM_ADD, ITEM_INSERT, FILE_LOAD or FILE_ADD, and is read with the function ITEM_READ$().

SYNTAX: LIST N

  • N = system object number (integer or real). Must be greater than 0 and less than or equal to the allowed maximum number of system objects.

USE

  • A LIST is used to display a list of choices from which the user can select one item.

ERROR

  • If number N is not a correct expression.
  • If number N exceeds the allowed maximum number of system objects.
  • If number N is less than or equal to 0.
  • If number N is already used for a system object number.

EXAMPLE

rem create a LIST with default position and dimensions

list 1

rem fill it with an item

item_add 1,"Hello !"

SEE ALSO

TOP

LEFT

WIDTH

HEIGHT

HINT

HINT_HIDE

FULL_SPACE

COLOR

ITEM_ADD

ITEM_INSERT

ITEM_DELETE

ITEM_READ$()

FILE_ADD

FILE_LOAD

CLEAR

ON_CLICK