CLEARDRAGDATA message
Description
This message removes all data from the drag source data object. This can be used during a DRAGSTART event to cancel the drag.
Syntax
retVal = Send_Message(ctrlEntId,"CLEARDRAGDATA",format)
Parameters
The function has the following parameters:
| Parameter | Description |
|---|---|
| ctrlEntID | Must be a current drag source control. |
| format | Name of the format you want to clear. This can be a custom format or one of the following standard OpenInsight data formats. Format - Description TEXT - Sets textual data in both ANSI and Unicode format. FILENAME - Sets a filename data format. BITMAP - Sets BITMAP, a bit dta format. The data should be a bitmap path. |
Returns
A boolean value. TRUE for successful, FALSE if unsuccessful.
Remarks
The message can only be used during the DRAGSTART event for drag source control. This effectively cancels all current drag activity.
See Also
DRAGSOURCE property, DROPTARGET property, SETDRAGDATA message, REMOVEDRAGDATA message, GETDRAGDATA message
Example
* Change the "TEXT" data being dragged
dragSource = Get_Property("SYSTEM","DRAGSOURCE")
data = Send_Message(dragSource,"GETDRAGDATA","TEXT","","")
if data _eqc 'Zachary Taylor' then
data = Send_Message(dragSource,"CLEARDRAGDATA","TEXT")
end