Widget Class: _validateDropData

Widget Class: _validateDropData

Allows a drop site to validate a drag operation's data

Syntax
Details

Syntax

objectName._validateDropData( representation, operation,dataList,dragStart, x, y, cancel );

objectName._validateDropData( objectID );

Argument Type Use Description

representation Character Input specifies the representation selected for the drop

operation Character Input specifies the operation selected for the drop

dataList Numeric Update specifies the identifier of the SCL list that contains the data defined by the representation

dragStart Character Input specifies where the drag started: INSIDE (inside the window containing the drop site) or OUTSIDE

x Numeric Input specifies the x location of the drop in pixels

y Numeric Input specifies the y location of the drop in pixels

cancel Character Output returns a flag indicating whether to complete or cancel the drop: 'C' indicates cancel otherwise a blank indicates to continue

objectID SASHELP.CLASSES.DRAGANDDROP.CLASS Input specifies the identifier of an object containing drag and drop data

Argument	Type	Use	Description
representation	Character	Input	specifies the representation selected for the drop
operation	Character	Input	specifies the operation selected for the drop
dataList	Numeric	Update	specifies the identifier of the SCL list that contains the data defined by the representation
dragStart	Character	Input	specifies where the drag started: INSIDE (inside the window containing the drop site) or OUTSIDE
x	Numeric	Input	specifies the x location of the drop in pixels
y	Numeric	Input	specifies the y location of the drop in pixels
cancel	Character	Output	returns a flag indicating whether to complete or cancel the drop: 'C' indicates cancel otherwise a blank indicates to continue
objectID	SASHELP.CLASSES.DRAGANDDROP.CLASS	Input	specifies the identifier of an object containing drag and drop data

(1) objectID is sashelp.classes.draganddrop.class

Details

The _validateDropData method is called when a drag site object has been dropped on a drop site object. The drop site is passed the data returned from the _getDragData method. This method is called to give the drop site a chance to validate the data and allows the drag operation to be canceled.

No new Frame entries or applications can be started from this method. The SCL code for this method also cannot be debugged.

Note: The _validateDropData method is followed by the _drop method, so it is advisable to test the representation and the action before responding to the drop operation. x and y are the pixel offsets of the drop within the drop zone. These values are valid only for nonwidget drop zones. [cautionend]

Chapter Contents
Previous
Next
Top of Page