ListModify (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / List Box functions

Multi-selection List Box control
Modified element
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ListModify (Function)

In french: ListeModifie

Modifies an element in a List Box, ListView or Combo Box control populated programmatically.

Note: The ListModify function can be used on both the List Box control and multiselection fields. .

Example

// Modification de l'élément situé à l'indice 4 dans le champ Liste "LISTE_ListeClient"
ListModify(LISTE_ListeClient, "Dupond", 4)

// Modification de l'image située à l'indice 4 dans le champ Liste "LSI_Plongée"
ListModify(LSI_Plongée, "Belles gorgones", "C:\MesImages\Gorgones.JPG", 4)

Syntax

ListModify(<List Box control> , <Element> [, <Image> [, <Element index>]])

<List Box control>: Control name

Name of control to use:
List Box control,
Combo Box control.If this parameter corresponds to an empty string (""), the element is modified in the List Box control (or Combo Box) to which the current event belongs.

<Element>: Character string

Element to modify in the specified List Box (or Combo Box) control.
For a ListView control, this parameter corresponds to the image caption.

<Image>: Optional character string

Name and path of image that will be added into a ListView control. 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..

<Element index>: Optional integer

Index of the element to be modified.
If this parameter:
is not specified or if it is set to -1, the current element is modified. ListModify has no effect if there is no current element.
is equal to 0, the first element is modified.
is greater than the number of items in the List Box control (or Combo Box control), a WLanguage error is generated.. The number of elements in a List Box (or Combo Box) control is returned by ListCount.

Remarks

Multi-selection List Box control

If one or more elements are selected in the List Box control, ListModify deselects no element.

Modified element

When modifying an element containing an invisible value (specified by gStoredValue), gStoredValue must be re-used. Otherwise, this invisible value will be lost during the modification.

For example:

adding "MyElement":

ListAdd(COMBO_MaCombo, "MonElément" + gStoredValue("1"))

modifying "MyElement":

ListModify(COMBO_MaCombo, "MonNouvelElément" + gStoredValue("1"))

Miscellaneous

To modify an element in a Table control, use TableModify.
ListModify can be used on a "Combo Box" table column.

Component: wd300obj.dll