ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Controls, pages and windows / List Box functions
  • 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
  • Miscellaneous
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Adds an element to:
  • a List Box control populated programmatically,
  • WINDEVJava a ListView control populated programmatically,
  • WINDEV a Carousel control,
  • 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.
Example
// Ajout de "Dubois" dans le champ "LISTE_ListeClient"
ListAdd(LISTE_ListeClient, "Dubois")
WINDEVJavaUser code (UMC)
// Ajout de "Dubois" et "Dupont" dans le champ Liste "LISTE_ListeClient"
ListAdd(LISTE_ListeClient, "Dubois" + CR + "Dupont")
WINDEVJavaUser 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"
ListAdd(LSI_PlongéeMer, "Très belles gorgones", "C:\MesImages\Gorgones.JPG")
WINDEVJavaUser code (UMC)
// La combo "COMBO_Civilité" affiche les titres de civilité:
// "Monsieur", "Madame" et "Mademoiselle".
// Un entier représentant une civilité sera retourné au langage.
ListAdd(COMBO_Civilité, "Monsieur" + gStoredValue("1"))
Syntax
<Result> = ListAdd(<Control to use> [, <Element> [, <Path of image to display>]])
<Result>: Boolean
  • True if the element was added,
  • False otherwise.
<Control to use>: Control name
Name of control to use:
  • 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.
<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.
WINDEV For a Carousel control, the content of this parameter is displayed in the upper-left corner of the 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.
Java The Carriage Return characters (CR) are supported while the tabulations (TAB) are not supported.
<Path of image to display>: Optional character string
Name and path of image that will be added into a ListView control. It is also possible to use an image memo field or a Image type variable..
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 "Detail" tab of the control description window) is used..
Remarks

List Boxes containing more than 10 000 elements

The maximum number of elements contained in a List Box control is limited only by available RAM (theoretical maximum: 2 billion lines).. 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).
WINDEVJavaUser code (UMC)

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.
WINDEVJavaUser code (UMC)

Equivalence

The two following syntaxes are equivalent:
ListeAjoute(<Nom du champ>, [<Élément>])
and
<Nom du champ>[Indice] = <Élément>
WINDEVJavaUser code (UMC)

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.
WINDEVUser code (UMC)

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

To customize the elements in a List Box or Combo Box control (background color, image, design), use Graphic string functions.
WINDEVUser 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:
ListAdd(LISTE_Client, 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 function ListAdd sets the tab position. 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 ListAdd, 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:
ListAdd(LISTE_Client, Complete(Nom, 10) + TAB + Complete(Prénom, 10))

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: wd300obj.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 09/14/2024

Send a report | Local help