Export (0) Print
Expand All

clipboardData object

Provides access to predefined clipboard formats for use in editing operations.

Members

The clipboardData object has these types of members:

Methods

The clipboardData object has these methods.

MethodDescription
clearData

Removes one or more data formats from the clipboard through the dataTransfer object. For the clipboardData object, this method clears all formats.

getData

Gets the data in the specified format from the clipboard through the dataTransfer object or the clipboardData object.

setData

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

 

Properties

The clipboardData object has these properties.

PropertyDescription

files

Retrieves the local image files associated with a HTML paste operation (into an editable region of a web page).

 

Standards information

There are no standards that apply here.

Remarks

The clipboardData object is reserved for editing actions performed through the Edit menu, shortcut menus, and shortcut keys. It transfers information using the system clipboard, and retains it until data from the next editing operation replaces it. This form of data transfer is particularly suited to multiple pastes of the same data.

This object is available in script as of Microsoft Internet Explorer 5.

Examples

This example uses the setData and getData methods with the clipboardData object to perform a cut-and-paste operation through the shortcut menu.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/clipboardDataEX.htm


<html>
<head>
<script>
var bResult;
// Select the text to be cut. Trailing spaces in a text
// selection in cut events cause the Cut shortcut menu item to
// remain disabled.
function fnLoad() {
    var r = document.body.createTextRange();
    r.findText(oSource.innerText);
    r.select();
}
// Enable the Cut shortcut menu item over the div. Cut is disabled by default.
// Once Cut is enabled, Internet Explorer automatically copies the data to the
// clipboard and removes the selected text from the document.
function fnBeforeCut() {
    event.returnValue = false;
}
//Assign data in text format to the window.clipboardData object.
//Display the result (Boolean) from the setData method in the input box below.
function fnCut(){
	event.returnValue = false;
	bResult = window.clipboardData.setData("Text",oSource.innerText);
	oSource.innerText = "";
	tText.innerText += bResult;
}
// Enable the Paste shortcut menu item over the div. Paste is disabled by default.
function fnBeforePaste() {
    event.returnValue = false;
}
// Cancel the returnValue in onpaste for the text input, which
// has a default behavior.
function fnPaste() {
    event.returnValue = false;
	oTarget.innerText = window.clipboardData.getData("Text");
}
</script>
</head>
<body onload="fnLoad()" TOPMARGIN=0 LEFTMARGIN=0 BGPROPERTIES="fixed" BGCOLOR="#FFFFFF"
	LINK="#000000" VLINK="#808080" ALINK="#000000">
<div class="clsSource" ID="oSource" onbeforecut="fnBeforeCut()" oncut="fnCut()">
	Select and cut this text
</div>
<div class="clsTarget" ID="oTarget" onbeforepaste="fnBeforePaste()" onpaste="fnPaste()">
	Paste the Text Here
</div><br/>
<span class="clsData">setData Result: </span>
<input class="clsText" ID="tText" TYPE="text" READONLY VALUE="" SIZE="6" TABINDEX="-1">
</body>
</html>


See also

Data Transfer Overview

 

 

Show:
© 2014 Microsoft