Control Descriptions: List

Using the List control, you can add an item selection interface to customized forms. In your list box's properties, you can add items to the selectable list, and define data associated with each item, and use this data in your application. Also, double clicking List controls initiates an event (called the On Double Click event) that you define by adding actions. For information about building events for List controls, see Adding Events to Controls.

Presentation Designer list boxes also offer configurable tooltips and a default selection (see Selected Index below).

List Properties

Property Description
Data The items that will appear in the list, and the data associated with each item.

When the end user selects an item, that item's data will be the data associated with this control. For example, if you add three items to a list box, then map that list box to a host field, when the end user chooses an item, the data associated with the chosen item gets sent to that host field when the form is processed.

On Double Click An event which will occur when an end user double-clicks the control.
Return Index If set to True, instead of returning the assigned selection value, the control will instead send the numeric index value.

The first item counts as 0, so if the third item in the list is selected, regardless of its selection value, the control will send a value of 2.

Setting this property to True prevents the Prefix or Suffix properties from working.

Selected Index The number of the item which will appear as the default.

A setting of -1 means there will be no default. The first item counts as 0, so if you want the third item in the list to the default, type 2 for this property.

Use Scroll Pane If set to False, large content which would normally enable scroll bars will be inaccessible.

Common Properties

The following properties are also available:

Background, Border, Enabled, Font, Foreground, Name, Opaque, Prefix, Screen Binding, Suffix, Tooltip, Width and Height, X and Y.

Related Topics
Bullet Control Descriptions
Bullet Adding Controls
Bullet Adding Events to Controls
  Attachmate