setData Method

Assigns data in a specified format to the dataTransfer or clipboardData object.

Syntax

bSuccess = object.setData( sDataFormat , sData )

Parameters

sDataFormat

Required. String that specifies the format of the data to be transferred, using one of the following values:

Text	Transfers data formatted as text.
URL	Transfers data formatted as a URL.

sData

Required. String that specifies the data supplied by the source object. This information can be descriptive text, a source path to an image, or a URL for an anchor. When you pass " URL " as the sDataFormat parameter, you must use the sData parameter to provide the location of the object being transferred.

Return Value

Boolean . Returns one of the following possible values:

true	The data was successfully added.
false	The data was not added.

Remarks

The value of the sDataFormat parameter is not case-sensitive.

Example

This example uses the setData and getData methods with the dataTransfer object to create a shortcut to an image.

<HEAD>
<SCRIPT>
var sImageURL; function InitiateDrag()
/* The setData parameters tell the source object to transfer data as a URL and provide the path. */
{ event.dataTransfer. setData ("URL", oImage.src); } function FinishDrag()
/* The parameter passed to getData tells the target object what data format to expect. */
{ sImageURL = event.dataTransfer.getData("URL") oTarget.innerText = sImageURL; }
</SCRIPT>
</HEAD>
<BODY>
<P>This example demonstrates how to use the setData and getData methods of the dataTransfer object to enable the source path of the image to be dragged.</P>
<IMAGE ID=oImage SRC="/workshop/graphics/black.gif" ondragstart="InitiateDrag()">
<SPAN ID=oTarget ondragenter="FinishDrag()"> Drop the image here </SPAN>
</BODY>

Standards Information

There is no public standard that applies to this method.

Applies To

Platform Version

Win16:
Win32:
Unix:
Mac:
Windows CE:

clipboardData , dataTransfer

Home | Top | Website design | JavaScript Editor

Get Advanced
JavaScript and Ajax Editor,
Validator and Debugger!
1st JavaScript Editor.

→