<List Box>.Modify (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<List Box>.Modify (Function)

In french: <Liste>.Modifie

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

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

Caution: The element will be modified on the page displayed in the browser only. For more details, see Remarks.

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.
For a ListView control, this parameter corresponds to the image caption.
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).

<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.
This parameter is not available.

<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 in a List Box (or Combo Box) control is returned by <List Box>.Count.
<List Box>.Modify has no effect if this parameter is equal to 0 or if it is greater than the number of elements found in the List Box (or Combo Box) control.

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"))

Modifying an element in the browser

When modifying an element in browser code, this element is modified only for the page displayed in the browser. To make changes to this element on the server as well, <List Box>.Modify must be executed on the server.

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

Miscellaneous

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

Component: wd280obj.dll