onpaste Event

DHTML, HTML, & CSS

 
Click to return to the DHTML, HTML & CSS home page    
onmouseup Event     onpropertychange Event     DHTML Events    

onpaste Event


Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document.

Syntax

Inline HTML <ELEMENTonpaste = "handler" ... > All platforms
Event property object.onpaste = handler JScript (compatible with ECMA 262 language specification) only
Named script <SCRIPT FOR = object EVENT = onpaste> Internet Explorer only

Remarks

Bubbles Yes
Cancels Yes
To invoke After copying or cutting the text:
  • Right-click to display the shortcut menu and select Paste.
  • Or press CTRL+V.
Default action Inserts the data from the system clipboard into the specified location on the document.

Creating custom code to enable the Paste command requires several steps.

  1. Set event.returnValue=false in the onbeforepaste event to enable the Paste shortcut menu item.
  2. Cancel the default behavior of the browser by including event.returnValue=false in the onpaste event handler. This applies only to objects, such as the text box, that have a default behavior defined for them.
  3. Specify a data format in which to paste the selection through the getData method of the clipboardData object.
  4. Invoke the method in the onpaste event to execute custom paste code.

Event Object Properties

Although event handlers in the DHTML Object Model do not receive parameters directly, the handler can query the event object for data.

Event Object Properties

altKeyRetrieves the current state of the ALT key.
cancelBubbleSets or retrieves whether the current event should bubble up the hierarchy of event handlers.
clientXRetrieves the x-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
clientYRetrieves the y-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
ctrlKeyRetrieves the state of the CTRL key.
dataTransferProvides access to predefined clipboard formats for use in drag-and-drop operations.
offsetXRetrieves the horizontal coordinate of the mouse's position relative to the object firing the event.
offsetYRetrieves the vertical coordinate of the mouse's position relative to the object firing the event.
returnValueSets or retrieves the return value from the event.
screenXRetrieves the horizontal position of the mouse, in pixels, relative to the user's screen.
screenYRetrieves the vertical position of the mouse, in pixels, relative to the user's screen.
shiftKeyRetrieves the state of the SHIFT key.
srcElementRetrieves the object that fired the event.
typeRetrieves the event name from the event object.
xRetrieves the x-coordinate of the mouse cursor relative to the parent element.
yRetrieves the y-coordinate of the mouse cursor relative to the parent element.

Example

This example uses the clipboardData object to implement custom editing functionality.

Sample Code

<HEAD>
<SCRIPT>

var sNewString = "new content associated with this object";
var sSave = "";


// Selects the text that is to be cut.

function fnLoad() {
    var r = document.body.createTextRange();
    r.findText(oSource.innerText);
    r.select();
}


// Stores the text of the SPAN in a variable that is set 
// to an empty string in the variable declaration above.

function fnBeforeCut() {
    sSave = oSource.innerText;
    event.returnValue = false;
}


// Associates the variable sNewString with the text being cut.

function fnCut() {
    window.clipboardData.setData("Text", sNewString);
}

function fnBeforePaste() {
    event.returnValue = false;
}


// The second parameter set in getData causes sNewString 
// to be pasted into the text input. Passing no second
// parameter causes the SPAN text to be pasted instead.

function fnPaste() {
    event.returnValue = false;
    oTarget.value = window.clipboardData.getData("Text", sNewString);
}

</SCRIPT>
</HEAD>
<BODY onload="fnLoad()">

<SPAN ID="oSource" 
      onbeforecut="fnBeforeCut()" 
      oncut="fnCut()">Cut this Text</SPAN>

<INPUT ID="oTarget" TYPE="text" VALUE="Paste the Text Here"
      onbeforepaste="fnBeforePaste()" 
      onpaste="fnPaste()">
</BODY>

This feature requires Internet Explorer 5 or later. Click the icon below to install the latest version. Then reload this page to view the sample.
Microsoft Internet Explorer

Applies To

[ Object Name ]
PlatformVersion
Win16:
Win32:
Mac:
Unix:
WinCE:
Version data is listed when the mouse hovers over a link, or the link has focus.
A, ADDRESS, APPLET, AREA, B, BDO, BIG, BLOCKQUOTE, BODY, BUTTON, CAPTION, CENTER, CITE, CODE, custom, DD, DFN, DIR, DIV, DL, document, DT, EM, EMBED, FIELDSET, FONT, FORM, Hn, HR, I, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LEGEND, LI, LISTING, MAP, MARQUEE, MENU, NEXTID, NOBR, OL, P, PLAINTEXT, PRE, RT, RUBY, S, SAMP, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TR, TT, U, UL, VAR, XMP

See Also

dhtml data transfer overviewInternet Link, getData, onbeforecopy, onbeforecut, onbeforepaste, oncopy, oncut


Back to topBack to top

Did you find this topic useful? Suggestions for other topics? write us!Internet Link

© 1999 microsoft corporation. all rights reserved. terms of useInternet Link.