List

A component that allows the user to select one or more values from a list.

This is what a list looks like:

Common Properties

Width, Height, Bindings, Enabled, Visible, Foreground, Background, Opaque, Border, Font, Cursor, Tooltip, Focusable, Popup Menu

Custom Properties

Selection Mode

Selection mode for list items. One of Single Selection, Single Interval Selection or Multiple Intervals Selection.

Property name: selectionMode

Property type: Integer

Layout Orientation

Defines how list cells are laid out. A list with four cells can be laid out in one of the following ways:    

Vertical:

0

1

2

3

Vertical Wrap:

0  1

2  3

Horizontal Wrap:

0  2

1  3

Property name: layoutOrientation

Property type: Integer

List Items

A table that defines all items in the list.

Property name: listItems

Property type: Data Table

It is possible to fill a List with selection values of a certain Data Table field using a binding. For example, binding that will fill a List with the countries available in the Country field of User Information variable defined in the User context of user admin will look as follows:

Target: form/list1:listItems

Expression: {users.admin:childInfo$country#options}

This binding is created automatically when dragging a variable field to a List in GUI Builder. Check details here.

Selected Items

(Default Property)

List of items that are initially selected.

Property name: selectedItems

Property type: Data Table

Selected Item

List of item that are initially selected (convenient method to set/get just one selected item in Selected Items property).

Property name: selectedItem

Property type: dynamic

Visible Row Count

Sets the preferred number of rows in the list that can be displayed without a scrollbar if there is enough space in the layout of the parent container.

This property may be set to Auto. In this case, the list will occupy all available space in the layout grid of the parent container.

Property name: visibleRowCount

Property type: Integer

Common Events

Hidden, Shown, Moved, Resized, Mouse Clicked, Mouse Pressed, Mouse Released, Mouse Entered, Mouse Exited, Mouse Moved, Mouse Wheel Moved, Key Typed, Key Pressed, Key Released, Focus Gained, Focus Lost

Custom Events

List Selection

This event fires when a user selects or de-selects some list items.

Event name: listSelection

Was this page helpful?