<List Box>.Delete (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

List Box functions

Prefix syntax

Delete

Presentation

Example

Cascading deletions

Deleting an element on the browser

Miscellaneous

See also

<List Box>.Delete (Function)

In french: <Liste>.Supprime

Deletes an element from a List Box, ListView or Combo Box control populated programmatically.

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

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

Example

// Delete the selected element from "LIST_CustomerList"
LIST_CustomerList.Delete()

Syntax

<List Box control>.Delete([<Element index>])

<List Box control>: Control name

Name of List Box (or Combo Box) control to use.

<Element index>: Optional integer

Index of the element to delete from the List Box or Combo Box control. If this parameter is not specified:
in a single-selection List Box control, the current element is deleted.
in a multi-selection List Box control, the selected elements are deleted.
in a Combo Box control, the current element is deleted. If this control is an editable Combo Box control, the edit control is cleared.
The editable Combo Box controls are not available.

Remarks

Cascading deletions

When deleting a set of elements, the elements found after each deleted element are moved. To perform cascading deletions, we advise you to start from the last element.

For example:

Index is int
FOR Index = LIST_CustomerList.Count() TO 1 STEP -1
LIST_CustomerList.Delete(Index)
END

Deleting an element on the browser

When deleting an element in browser code, this element is only deleted from the page displayed in the browser. In order for this element to be deleted from the server, <List Box>.Delete must be run on the server.

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

Miscellaneous

To delete an element from a Table control, use <Table>.Delete.
<List Box>.Delete can be used on a "Combo Box" table column.

Component: wd280obj.dll