Removes one or more data formats from the clipboard through the dataTransfer object or the clipboardData object.
Syntax
pret = object.clearData( [sDataFormat])
Parameters
| sDataFormat |
Optional.
A String that specifies one or more of the following data format values. Text | Removes the text format. | URL | Removes the URL format. | File | Removes the file format. | HTML | Removes the HTML format. | Image | Removes the image format. |
|
Return Value
No return value.
Remarks
If no sDataFormat
parameter is passed, the data formats are cleared.
For drag-and-drop operations, the clearData method of the dataTransfer object is used generally in source events, such as ondragstart. When you override the default behavior of the target, use clearData in the ondrop event. It is particularly useful for selectively removing data formats when multiple formats are specified.
Example
This example uses the clearData method to remove the Text data format from the clipboard through the dataTransfer object.
<HEAD>
<STYLE>
DIV {background-color:magenta; width: 300;}
SPAN {color:lightgreen;}
</STYLE>
<SCRIPT>
function Source_DragStart(){
event.dataTransfer.setData("Text", "This text will be cleared");
}
function Target_Enter(){
window.event.returnValue = false;
event.dataTransfer.clearData("Text");
oTarget.innerText = event.dataTransfer.getData("Text");
}
</SCRIPT>
</HEAD>
<BODY>
<P>Drag the green text and drop it over the magenta DIV.</P>
<SPAN ID="oSource" >
Drag this text.
</SPAN>
<P>Drop the text below. The word "null" will appear in the DIV.</P>
<DIV
ID="oTarget" >
</DIV>
</BODY>
This feature requires Microsoft® Internet Explorer 5 or later. Click the following icon to install the latest version. Then reload this page to view the sample.
Standards Information
There is no public standard that applies to this method.
Applies To
See Also
About DHTML Data Transfer, getData, setData