<List Box>.Modify (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Multi-selection List Box control
Modified element
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<List Box>.Modify (Function)

In french: <Liste>.Modifie

Modifies an element in a memory List Box control (standard List Box or ListView) or in a memory Combo Box control.

Remark: <List Box>.Modify can be used on the single-selection and multi-selection List Box controls.

Example

// Modify the element found at subscript 4 in "LIST_CustomerList"
LIST_CustomerList.Modify("Smith", 4)

// Modify the image found at subscript 4 in "LSV_Diving"
LSV_Diving.Modify("Coral Reef", "C:\MyImages\CoralReef.JPG", 4)

Syntax

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

<List Box control>: Control name

<Element>: Character string

Element to modify in the specified List Box (or Combo Box) control.

<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 "Details" tab in the description window of control) will be 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. <List Box>.Modify has no effect if there is no current element.
is equal to 0, the first element is modified.
is greater than the number of elements found in the List Box (or Combo Box) control, a WLanguage error occurs. The number of elements found in a List Box (or Combo Box) control is returned by <List Box>.Count.

Remarks

Multi-selection List Box control

If one or more elements are selected in the List Box control, <List Box>.Modify 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":

COMBO_MyCombo.Add("MyElement" + gStoredValue("1"))
modifying "MyElement":

COMBO_MyCombo.Modify("MyNewElement" + gStoredValue("1"))

Miscellaneous

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

Component: wd270obj.dll