|
Retrieves the data from the drag and drop operation using the defined format.
|
|
Syntax:
|
DropGetData(data format, user-defined format)
|
|
Parameters:
|
data format – A numeric value for the data format stored in the operating system. The following data formats are:
0 – User-defined
1 – Text
2 - OEM Text
3 – Rich Text
4 – HTML
5 – Hyperlink
6 – File name and path
7 – Unicode
user-defined format – An optional string parameter that specifies a user-defined format by its name. This parameter is required when the data format parameter is set to 0 but is not relevant for other data formats.
|
|
Returns:
|
A string value of the retrieved data. If the format is not supported, the function returns Null.
|
|
Examples:
|
DropGetData(0, 'My format') returns the string value of the user-defined format data.
DropGetData(1) returns the string value of the Text format data.
DropGetData(4) returns the string value of the HTML format data.
|
|
Note:
|
To handle the drop data of user-defined formats, you must first set the names of the expected user-defined formats in the Drop Data supported user formats environment setting.
|
|
Exceptions:
|
This function is not supported in Web Client tasks.
|
|
Platform specific:
|
This function is not supported for mobile devices.
|
|
See also:
|
How Do I Retrieve a Full Path Name from a Dragged File?
How Do I Drag Data from External Applications to Magic xpa?
The Online and Rich Client Samples projects (program HG05 and RHG05)
|
