<List Box>.Insert (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

List Box controls containing more than 10 000 elements
Visibility/Invisibility of elements in a List Box or Combo Box control
Sorted/Unsorted List Box control
Adding an element onto the browser
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<List Box>.Insert (Function)

In french: <Liste>.Insère

Inserts an element into a memory List Box control, a memory ListView control or a memory Combo Box control.

Remarks:

To add an element at the end of List Box (or Combo Box) control, use <List Box>.Add.
<List Box>.Insert can be used on single-selection and multiselection List Box controls
To manage the content of a Combo Box control found in a container table column, use Content.

Caution: The element will only be added to the page displayed in the browser. See Remarks for more details.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Example

// Add "Clark" in 4th position to "LIST_CustomerList"
LIST_CustomerList.Insert("Clark", 4)

Syntax

<List Box control>.Insert(<Element> [, <Element subscript>])

<List Box control>: Control name

Name of memory List Box or memory Combo Box control to use.

<Element>: Character string (with quotes)

Element that must be inserted into the specified memory List Box (or Combo Box) control.
This parameter can contain:
Carriage Return characters (CR) to add several rows. In this case:
if <Element index> is not specified, the elements are added.
If <Element index> is specified, only the first element will be added.
tabs (TAB) to obtain a multi-element List Box control (see Notes).
The Carriage Return characters (CR) and the tabulations (TAB) are not supported.
To add several consecutive spaces, non-breakable space characters must be used: Charact(160).

<Element subscript>: Optional integer

Index of the element to be inserted.
If this parameter:
is not specified, the element is inserted:
before the current element in a single-selection List Box control. If there is no current element, the element is inserted at the end of the memory List Box (or Combo Box) control.
at the end of the List Box (or Combo Box) control in a multiselection List Box control.
is greater than the number of elements found in the List Box (or Combo Box) control, the element is inserted at the end of the memory List Box (or Combo Box) control. The number of elements found in a List Box (or Combo Box) control is returned by <List Box>.Count.
is equal to 0, the element is added at the beginning of memory List Box (or Combo Box) control.

Remarks

List Box controls containing more than 10 000 elements

The maximum number of elements found in a List Box control is 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 the performances.
To add a large number of elements to a List Box control, we recommend you use a browsing List Box control (that is a List Box control directly linked to a 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 gLink.

Sorted/Unsorted List Box control

If the List Box control is sorted, the new element is inserted at the current position without sorting the list box.
If the List Box control is not sorted, the new element is added:
- at <Element index> if <Element index> is specified.
- before the current element in a single-selection List Box control if the <Element index> parameter is not specified. If there is no current element, the element is inserted at the end of the memory List Box (or Combo Box) control.
- at the end of the List Box (or Combo Box) control in a multiselection List Box control if the <Element index> parameter is not specified.

The type of the List Box control (sorted or not) is selected during the control description ("Details" tab).

Use <List Box>.Add rather than <List Box>.Insert 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 onto 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, <List Box>.Insert must be run on the server.

Calling <List Box>.Insert 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 <List Box>.Insert to automatic AJAX mode. That's it! No additional programming is required. For more details, see AJAX.

Miscellaneous

To insert an element into a Table control, use <Table>.Insert.
<List Box>.Insert can be used on a "Combo Box" column found in a Table control .

Component: wd260obj.dll