Clear

Description

Deletes selected text in the edit control over the current row and column, but does not store it in the clipboard.

Applies to

DataWindow type	Method applies to
PowerBuilder	DataWindow control
Web ActiveX	DataWindow control

Syntax

PowerBuilder

long dwcontrol.Clear ( )

Web ActiveX

number dwcontrol.Clear ( )

Argument	Description
dwcontrol	A reference to a DataWindow control

Returns

Returns the number of characters that Clear removed from dwcontrol. If no text is selected, no characters are removed and Clear returns 0. If an error occurs, Clear returns –1.

Usage

To select text for deleting, the user can use the mouse or keyboard. You can also call the SelectText method in a script.

To delete selected text and store it in the clipboard, use the Cut method.

PowerBuilder environment For use with other PowerBuilder controls, see Clear in the PowerScript Reference.

Examples

Example 1

If the user is editing the emp_name column in dw_emp and selects the text Wilson, this statement clears Wilson from the edit control and returns 6:

long chars_returned

chars_returned = dw_emp.Clear( )

Example 2

If the text in the edit control in dw_emp is Wilson, the first statement selects the W and the second clears W from the edit control. The return value would be 1:

dw_emp.SelectText(1,1)

dw_emp.Clear( )