ListAdd (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

List functions

Prefix syntax

ListAdd

Presentation

Example

List Boxes containing more than 10 000 elements

Visibility/Invisibility of elements in a List Box or Combo Box control

Equivalence

Sorted/Unsorted List Box control

Adding an element to the browser

Miscellaneous

See also

ListAdd (Function)

In french: ListeAjoute

Adds an element to:

a List Box control populated programmatically,
a Combo Box control populated programmatically.

Remarks:

To add an element at a specific position, use ListInsert.
ListAdd can be used on the single-selection and multi-selection List Box controls.
To add an image to a standard List Box control, use gImage.
To add elements to a Combo Box control found in a container column of a Table control, use Content.

Caution: The element will only be added to the page displayed in the browser. For more details, see Remarks.

Example

// Add the customer named "Moore" into "LIST_CustomerList"
ListAdd(LIST_CustomerList, "Moore")

// Add the customers named "Clark" and "Smith" into "LIST_CustomerList"
ListAdd(LIST_CustomerList, "Clark" + CR + "Smith")

// The "COMBO_Title" Combo Box displays personal titles:
// "Mister", "Madam" and "Miss".
// An integer representing a gender will be returned to the language.
ListeAdd(COMBO_Title, "Mister" + gStoredValue("1"))

Syntax

ListAdd(<Control to use> [, <Element>])

<Control to use>: Control name

Name of the control to be used:
List Box control populated programmatically,
ListView control populated programmatically,
Combo Box control populated programmatically.
If this parameter corresponds to an empty string (""), the element is added to the List Box control (or Combo Box) to which the current event belongs.
The name of the List Box (or Combo Box) control to use must be specified.

<Element>: Optional character string

Element that will be added into the specified control. If this parameter is not specified, an empty row is added into the List Box or Combo Box control.
This parameter can contain:
Carriage Return characters (CR) to add several elements.
tabs (TAB) to obtain a multi-element List Box control (see Notes).
gStoredValue to indicate the value that will be returned when the element is selected.
The Carriage Return characters (CR) are supported while the tabulations (TAB) are not supported.
To add several consecutive spaces, non-breakable space characters must be used: Charact(160).

Remarks

List Boxes containing more than 10 000 elements

The maximum number of elements in a List Box control is only limited by the available memory (theoretical maximum: 2 billion rows). Nevertheless, filling a List Box control with an important number of elements (more than 10 000) affects performance

To add many elements to a List Box control, it is recommended to use a List Box control based on a data file (i.e., a list directly linked to an HFSQL data file).

Visibility/Invisibility of elements in a List Box or Combo Box control

To make an element invisible in a List Box or Combo Box control, use gStoredValue.

Equivalence

The two following syntaxes are equivalent:

ListAdd(<Control name> [<Element>])

and

<Control name>[Index] = <Element>

Sorted/Unsorted List Box control

If the List Box control is sorted, the new element is inserted according to the sort order.
If the List Box control is not sorted, the new element is added at the end of the list.

The control type (sorted or not) is chosen during the control description ("Details" tab).

Use ListAdd rather than ListInsert to add an element to a sorted List Box control.

The element is added at the end of control, no matter whether the List Box control is sorted or not.

Adding an element to the browser

When adding an element in browser code, this element is added to the page displayed in the browser only. In order for this element to be added onto the server, ListAdd must be run on the server.

Calling ListAdd in browser code is useful when using AJAX technology, in "Programmed AJAX" mode (via AJAXExecute or AJAXExecuteAsynchronous).

Reminder: In "Automatic and immediate AJAX" mode, all you have to do is switch the server process containing ListAdd to automatic AJAX mode. That's it! No additional programming is required. For more details, see AJAX.

Miscellaneous

To add elements into a Table control, use TableAdd.
ListAdd can be used on:
- a column of type "Combo Box" in a Table control.
- a "Table" Combo Box control.

Component: wd280obj.dll