Frame Class: _getDragData

Frame Class: _getDragData

Exports the data from a drag site object to a drop site object

Syntax
Details

Syntax

objectName._getDragData( representation, operation,dataList,x, y );

objectName._getDragData( 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

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

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

objectID SASHELP.CLASSES.DRAGANDDROP.CLASS Update 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
x	Numeric	Input	specifies the x location of the drag in pixels
y	Numeric	Input	specifies the y location of the drag in pixels
objectID	SASHELP.CLASSES.DRAGANDDROP.CLASS	Update	specifies the identifier of an object containing drag and drop data

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

Details

The _getDragData method is called automatically after a drag site object is dropped and before the _validateDropData method runs on the drop site object. This method runs only on drag site objects. This method provides a way to export the data to the drop site object. The data are passed as a global list. The format of the data depends on the representation passed in. _dndTEXT, _dndFILE, and _dndDATASET representations require a list of character items. All three representations return one or more character strings. When you use the _getDragData method, each item in the returned list must be a character item.

The list passed into this method is a global list to facilitate passing data between tasks. Any lists added to data should also be global lists.

Chapter Contents
Previous
Next
Top of Page