Chapter 9: Methods for the DataWindow Control

ClearValues

Description

Deletes all the items from a value list or code table associated with a DataWindow column. (A value list is called a code table when it has both display and data values.) ClearValues does not affect the data stored in the column.

Syntax

integer dwcontrol.ClearValues ( string column )

integer dwcontrol.ClearValues ( integer column )

Argument	Description
dwcontrol	A reference to a DataWindow control, DataStore, or child DataWindow.
column	The column whose value list you want to delete. Column can be a column number (integer) or a column name (string).

Returns

Returns 1 if it succeeds and -1 if an error occurs. The return value is usually not used.

Usage

The edit style of the column can be DropDownListBox, Edit, or RadioButton. ClearValues has no effect when column has the EditMask or DropDownDataWindow edit style.

Examples

Example 1

This statement clears all values from the drop-down list of dw_Employee’s status column:

dw_Employee.ClearValues("status")