onbeforecopy Event

Fires on the source object before the selection is copied to the system clipboard.

Syntax

Inline HTML <ELEMENT onbeforecopy = "handler" ... > All platforms

Event property object.onbeforecopy = handler JScript (compatible with ECMA 262 language specification) only

Named script <SCRIPT FOR = object EVENT = onbeforecopy> Internet Explorer only

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

Remarks

Bubbles Yes

Cancels Yes

To invoke After selecting the text:

Right-click to display the shortcut menu and select Copy.
Or press CTRL+C.

Default action None.

The onbeforecopy event fires on the source element. Use the setData method to specify a data format for the selection.

Bubbles	Yes
Cancels	Yes
To invoke	After selecting the text: Right-click to display the shortcut menu and select Copy. Or press CTRL+C.
Default action	None.

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

altKey Retrieves the current state of the ALT key.

cancelBubble Sets or retrieves whether the current event should bubble up the hierarchy of event handlers.

clientX Retrieves the x-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.

clientY Retrieves the y-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.

ctrlKey Retrieves the state of the CTRL key.

dataTransfer Provides access to predefined clipboard formats for use in drag-and-drop operations.

offsetX Retrieves the horizontal coordinate of the mouse's position relative to the object firing the event.

offsetY Retrieves the vertical coordinate of the mouse's position relative to the object firing the event.

returnValue Sets or retrieves the return value from the event.

screenX Retrieves the horizontal position of the mouse, in pixels, relative to the user's screen.

screenY Retrieves the vertical position of the mouse, in pixels, relative to the user's screen.

shiftKey Retrieves the state of the SHIFT key.

srcElement Retrieves the object that fired the event.

type Retrieves the event name from the event object.

x Retrieves the x-coordinate of the mouse cursor relative to the parent element.

y Retrieves the y-coordinate of the mouse cursor relative to the parent element.

altKey	Retrieves the current state of the ALT key.
cancelBubble	Sets or retrieves whether the current event should bubble up the hierarchy of event handlers.
clientX	Retrieves the x-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
clientY	Retrieves the y-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
ctrlKey	Retrieves the state of the CTRL key.
dataTransfer	Provides access to predefined clipboard formats for use in drag-and-drop operations.
offsetX	Retrieves the horizontal coordinate of the mouse's position relative to the object firing the event.
offsetY	Retrieves the vertical coordinate of the mouse's position relative to the object firing the event.
returnValue	Sets or retrieves the return value from the event.
screenX	Retrieves the horizontal position of the mouse, in pixels, relative to the user's screen.
screenY	Retrieves the vertical position of the mouse, in pixels, relative to the user's screen.
shiftKey	Retrieves the state of the SHIFT key.
srcElement	Retrieves the object that fired the event.
type	Retrieves the event name from the event object.
x	Retrieves the x-coordinate of the mouse cursor relative to the parent element.
y	Retrieves the y-coordinate of the mouse cursor relative to the parent element.

Example

This example uses the onbeforecopy event to customize copy behavior.

Sample Code

<HEAD>
<SCRIPT>
var sNewValue = "copy event fired";
var bFired = false;
var sSave = "";

function Source_Beforecopy() 
{
  sSave = oSource.innerText;
  bFired = true;
  event.returnValue = false;
}

function Source_Copy() 
{
  window.clipboardData.setData("Text", sNewValue);
}

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

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

</SCRIPT>
</HEAD>
<BODY>
<SPAN ID=oSource onbeforecopy="Source_Beforecopy()"
       oncopy="Source_Copy()">copy this text</SPAN>
<INPUT ID=oTarget onbeforepaste="Target_BeforePaste()"
       onpaste="Target_Paste()">
</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.

Applies To

[ Object Name ]

Platform Version

Win16:

Win32:

Mac:

Unix:

WinCE:

Version data is listed when the mouse hovers over a link, or the link has focus.

A, ADDRESS, AREA, B, BDO, BIG, BLOCKQUOTE, CAPTION, CENTER, CITE, CODE, custom, DD, DFN, DIR, DIV, DL, DT, EM, FIELDSET, FORM, Hn, I, IMG, LABEL, LEGEND, LI, LISTING, MENU, NOBR, OL, P, PLAINTEXT, PRE, S, SAMP, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TD, TEXTAREA, TH, TR, TT, U, UL