List Box Control

#### Search Results

Search

# List Box Control

This document covers the following topics:

- Description

- Attributes for List Box Control

- Events

## Description

A list box control contains a number of list box items from which the end user can select one or more. You can insert items into a list box control by:

- defining them in the dialog editor at design time, and by

- creating them dynamically at runtime using the PROCESS GUI statement actions ADD, ADD-ITEMS and ADD-ITEMS-EX.

The Fill Event enables you to implement dynamically growing list box controls.

The MULTI-SELECTION attribute specifies for a list box control whether the end user may select one or several items at a time.

Note
A list box control must have MULTI-SELECTION = TRUE to be able to use SELECTED-SUCCESSOR with the children list box items.

To sort list box item STRINGs alphabetically, you use the SORTED attribute for the list box control. When the STRING of a list box item is changed, the items are automatically sorted again. You can then go through the list of items with the SUCCESSOR attribute and the new sort sequence is reflected.

When a Click Event or a Double-Click Event occurs for a list box item, the list box control receives the event and the list- box control's event handler can determine the clicked item by querying the attribute SELECTED-SUCCESSOR for the list box control. When several list box items are selected at the same time, the second selected item can be determined by querying the attribute SELECTED-SUCCESSOR of the first item, and so on.

If you specify event handlers for the click and the double-click events, the click-event handler will be executed prior to the double-click-event handler.

This may imply that the click-event handler suppresses the execution of the double-click-event handler (SUPPRESS-DBL-CLICK-EVENT attribute).

## Attributes for List Box Control

Attribute Name | Query | Set/Modify | In Attr. Window
--- | --- | --- | ---
AUTOSELECT | X | X/X |
ACCELERATOR | X | X/X | X
BACKGROUND-COLOUR-NAME | X | X/X | X
BACKGROUND-COLOUR-VALUE | X | X/X | X
CLIENT-DATA | X | X/X |
CLIENT-HANDLE | X | X/X |
CLIENT-KEY | X | X/X |
CLIENT-VALUE | X | X/X |
CONTEXT-MENU | X | X/X | X
DIL-TEXT | X | X/X | X
DRAG-MODE | X | X/X | X
DROP-MODE | X | X/X | X
ENABLED | X | X/X | X
FIRST-CHILD | X | -/- |
FIRST-VISIBLE-ITEM | X | X/X |
FOLLOWS | X | X/X |
FONT-HANDLE | X | X/X | X
FOREGROUND-COLOUR-NAME | X | X/X | X
FOREGROUND-COLOUR-VALUE | X | X/X | X
HELP-ID | X | X/X | X
LAST-CHILD | X | -/- |
MODIFIED | X | -/X |
MODIFIED-SUCCESSOR | X | -/- |
MULTI-SELECTION | X | X/- | X
OWNER | X | X/- |
PARENT | X | X/- |
PREDECESSOR | X | -/- |
RECTANGLE-H | X | X/X | X
RECTANGLE-W | X | X/X | X
RECTANGLE-X | X | X/X | X
RECTANGLE-Y | X | X/X | X
ROW-COUNT | X | -/- |
RTL | X | -/- | X
SELECTED-SUCCESSOR | X | -/- |
SORTED | X | X/- | X
STYLE | X | -/- | X
SUCCESSOR | X | -/- |
SUPPRESS-BEGIN-DRAG-EVENT | X | X/X |
SUPPRESS-CLICK-EVENT | X | X/X |
SUPPRESS-CLIPBOARD-STATUS-EVENT | X | X/X |
SUPPRESS-COPY-EVENT | X | X/X |
SUPPRESS-CUT-EVENT | X | X/X |
SUPPRESS-DBL-CLICK-EVENT | X | X/X |
SUPPRESS-DELETE-EVENT | X | X/X |
SUPPRESS-DRAG-DROP-EVENT | X | X/X |
SUPPRESS-DRAG-ENTER-EVENT | X | X/X |
SUPPRESS-DRAG-LEAVE-EVENT | X | X/X |
SUPPRESS-DRAG-OVER-EVENT | X | X/X |
SUPPRESS-END-DRAG-EVENT | X | X/X |
SUPPRESS-FILL-EVENT | X | X/X |
SUPPRESS-PASTE-EVENT | X | X/X |
SUPPRESS-UNDO-EVENT | X | X/X |
TOOLTIP | X | X/X |
TYPE | X | X/- |
VISIBLE | X | X/X | X

## Events

Begin-Drag Event, Click Event, Clipboard-Status Event, Copy Event, Cut Event, Delete Event, Double-Click Event, Drag-Drop Event, Drag-Enter Event, Drag-Leave Event, Drag-Over Event, End-Drag Event, Fill Event, Paste Event, Undo Event (all events may be suppressed).

### On this page

- Description
- Attributes for List Box Control
- Events