PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • 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
  • Customizing the elements found in a List Box or Combo Box control
  • Tabulations: Multi-element List Box control
  • Adding an element onto the browser
  • Miscellaneous
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Adds an element into:
  • a memory List Box control,
  • WINDEVJava a memory ListView control,
  • WINDEV a Carousel control,
  • a memory Combo Box control.
Remarks:
  • To add an element at a specific position, use <List Box>.Insert.
  • <List Box>.Add can be used on the single-selection and multi-selection List Box controls.
  • To add an image into a standard List Box control, use gImage.
  • To add elements into a Combo Box control found in a container column of a Table control, use Content.
WEBDEV - Browser code Caution: The element will only be added to the page displayed in the browser. For more details, see Remarks.
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 16 and later
WINDEVLinux This function is now available for WINDEV applications in Linux.
New in version 16
WINDEVLinux This function is now available for WINDEV applications in Linux.
WINDEVLinux This function is now available for WINDEV applications in Linux.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
// Ajout de "Dubois" dans le champ "LISTE_ListeClient"
LISTE_ListeClient.Ajoute("Dubois")
WINDEVWEBDEV - Server codeWEBDEV - Browser codeReports and QueriesUniversal Windows 10 AppAndroidJavaUser code (UMC)Ajax
// Ajout de "Dubois" et "Dupont" dans le champ Liste "LISTE_ListeClient"
LISTE_ListeClient.Ajoute("Dubois" + RC + "Dupont")
WINDEVReports and QueriesJavaUser code (UMC)
// Ajout de l'image "C:\MesImages\Gorgones.JPG" dans le champ Liste image "LSI_PlongéeMer"
// Cette image aura comme libellé "Très belles gorgones"
LSI_PlongéeMer.Ajoute("Très belles gorgones", "C:\MesImages\Gorgones.JPG")
WINDEVWEBDEV - Server codeWEBDEV - Browser codeReports and QueriesUniversal Windows 10 AppAndroidJavaUser code (UMC)Ajax
// La combo "COMBO_Civilité" affiche les titres de civilité:
// "Monsieur", "Madame" et "Mademoiselle".
// Un entier représentant une civilité sera retourné au langage.
COMBO_Civilité.Ajoute("Monsieur" + gValeurMémorisée("1"))
Syntax
<Result> = <Control to use>.Add([<Element> [, <Path of image to display>]])
<Result>: Boolean
  • True if the element was added,
  • False otherwise.
WEBDEV - Browser codePHP <List Box>.Add returns no result.
<Control to use>: Control name
Name of the control to be used.
<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).
  • the gStoredValue function to indicate the value to be returned when the element is selected.
WINDEV For a Carousel control, the content of this parameter is displayed in the top left corner of Carousel control.
WINDEVJava For a ListView control, this parameter corresponds to the image caption. This parameter can contain Carriage Return characters (CR) to add several elements. In this case:
  • if <Path of image to display> is not specified, the added elements will be associated with the default image (defined in the "Details" tab of the description window of control).
  • if <Path of image to display> is specified, only the first element will be added. This element will be associated with the specified image.
WEBDEV - Server codeWEBDEV - Browser codeAndroidJavaPHP The Carriage Return characters (CR) are supported while the tabulations (TAB) are not supported.
WEBDEV - Server code To add several consecutive spaces, non-breakable space characters must be used: Charact(160).
<Path of image to display>: Optional character string
Name and path of image that will be added into a ListView control. You also have the ability to use an image memo item.
This parameter is taken into account for ListView controls displayed in ListView mode only.
If this parameter is not specified, the default image (defined in the "Details" tab in the description window of control) will be used.
WEBDEV - Server codeWEBDEV - Browser codeUniversal Windows 10 AppAndroidiPhone/iPadPHP This parameter is not available.
Remarks

List Boxes 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 performance
To add many elements to a List Box control, it is recommended to use a browsing List Box control (i.e., a list directly linked to an HFSQL data file).
WINDEVWEBDEV - Server codeReports and QueriesAndroidiPhone/iPadJavaUser code (UMC)Ajax

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.
WINDEVWEBDEV - Server codeWEBDEV - Browser codeReports and QueriesUniversal Windows 10 AppAndroidiPhone/iPadJavaUser code (UMC)Ajax

Equivalence

The two following syntaxes are equivalent:
<Nom du champ>.Ajoute([<Élément>])
and
<Nom du champ>[Indice] = <Élément>
WINDEVWEBDEV - Server codeWEBDEV - Browser codeReports and QueriesUniversal Windows 10 AppAndroidiPhone/iPadJavaUser code (UMC)Ajax

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 <List Box>.Add rather than <List Box>.Insert to add an element to a sorted List Box control.
WEBDEV - Browser code The element is added at the end of control, no matter whether the List Box control is sorted or not.
WINDEVReports and QueriesUser code (UMC)

Customizing the elements found in a List Box or Combo Box control

To customize the elements found in a List Box or Combo Box control (background color, image, drawing, ...), use the Graphic strings management functions.
WINDEVReports and QueriesUser code (UMC)

Tabulations: Multi-element List Box control

To manage the tabulations in a List Box control (for aligning columns), use the TAB constant. For example:
LISTE_Client.Ajoute(Nom + TAB + Prénom)
In this example, all the first names start at the same position and are aligned one under the other.
Remark: The first call to <List Box>.Add defines the position of tabulations. These positions will be taken as reference for all values added thereafter. Similarly, if values have been typed entered in the editor, the positions of these values are taken as reference. During the first call to <List Box>.Add, we advise you to define the width of columns with Complete. For example, to fix the width of columns found in "CUSTOMERS" to 10 characters:
LISTE_Client.Ajoute(Complete(Nom, 10) + TAB + Complete(Prénom, 10))
WEBDEV - Browser code

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>.Add must be run on the server.
Calling <List Box>.Add 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>.Add 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.
  • <List Box>.Add can be used on:
    • a column of type"Combo Box" in a Table control.
    • a "Table" Combo Box control.
Component: wd270obj.dll
Minimum version required
  • Version 23
This page is also available for…
Comments
Click [Add] to post a comment