ondragstart Event

This document describes technologies available in the Internet Explorer 5 Beta. While we encourage you to evaluate these features and to send us your feedback, please note that these features are subject to change.

Fires on the source object when the user first starts to drag a text selection or selected object.

Syntax

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

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

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

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

Remarks

Bubbles Yes

Cancels Yes

To invoke Drag the selected text or object.

Default action Calls the associated event handler.

The ondragstart event is the first to fire when a drag procedure is initiated. It is essential to every drag operation, yet is just one of several source events in the data-transfer object model. Source events use the setData method of the dataTransfer object to provide information about data being transferred. The list of source events includes:

onbeforecopy
onbeforecut
oncopy
oncut
ondragstart
ondrag
ondragend

Bubbles	Yes
Cancels	Yes
To invoke	Drag the selected text or object.
Default action	Calls the associated event handler.

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 position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.

clientY Returns the y-coordinate of the position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.

ctrlKey Retrieves the state of the CTRL key.

dataTransfer Provides access to predefined clipboard formats for use in data transfer 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.

srcElement Retrieves the object that fired the event.

type Retrieves the event name from the event object.

x Returns the horizontal position of the mouse when the event fires.

y Returns the vertical position of the mouse when the event fires.

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 position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.
clientY	Returns the y-coordinate of the position of the cursor when the mouse is clicked, relative to the size of the client area of the window but excluding window decorations or scroll bars.
ctrlKey	Retrieves the state of the CTRL key.
dataTransfer	Provides access to predefined clipboard formats for use in data transfer 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.
srcElement	Retrieves the object that fired the event.
type	Retrieves the event name from the event object.
x	Returns the horizontal position of the mouse when the event fires.
y	Returns the vertical position of the mouse when the event fires.

Example

The first sample detects the tagName of the object from which the ondragstart event has originated. The second shows the order of event firing for drag-and-drop events.

Sample Code
The sample detects the tagName of the object from which the ondragstart event has originated. Because the event bubbles, it can be handled at the BODY level.
<BODY ondragstart="alert(event.srcElement.tagName)">
  <INPUT TYPE=text VALUE="Select and drag this text">
  <SPAN>Select and drag this text</SPAN>
  <TEXTAREA>Select and drag this text</TEXTAREA>
</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.

The following example illustrates when each event fires during a drag-and-drop operation.
<HEAD>
<SCRIPT>
function ShowResults()
var oNewOption;            

// Code for dynamically adding options to a select.

function ShowResults()
{                // Information about the events 
                 // and what object fired them.
  arg = event.type + "  fired by  " + event.srcElement.id;  
  oNewOption = new Option(); 
  oNewOption.text = arg;
  oResults.add(oNewOption,0);
}
</SCRIPT>
</HEAD>
<BODY>
<P>Source events are wired up to this text box.</P>
<INPUT ID=txtDragOrigin VALUE="Text to Drag"
    ondragstart="ShowResults()"
    ondrag="ShowResults()"
    ondragend="ShowResults()"
>
<P>Target events are bound to this text box.</P>
<INPUT ID=txtDragDestination VALUE="Drag Destination"
    ondragenter="ShowResults()"
    ondragover="ShowResults()"
    ondragleave="ShowResults()"
    ondrop="ShowResults()"
>
<SELECT ID=oResults SIZE=30>
  <OPTION>List of Events Fired
</SELECT>
</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

A, ACRONYM, ADDRESS, AREA, B, BDO, BIG, BLOCKQUOTE, BODY, BUTTON, CAPTION, CENTER, CITE, CODE, DD, DEL, DFN, DIR, DIV, DL, document, DT, EM, FIELDSET, FONT, FORM, Hn, HR, HTMLAREA, I, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=hidden, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LI, LISTING, MAP, MARQUEE, MENU, NEXTID, NOBR, OBJECT, OL, OPTION, P, PLAINTEXT, PRE, Q, RB, RT, RUBY, S, SAMP, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TR, TT, U, UL, VAR, XMP


A, ACRONYM, ADDRESS, AREA, B, BDO, BIG, BLOCKQUOTE, BODY, BUTTON, CAPTION, CENTER, CITE, CODE, DD, DEL, DFN, DIR, DIV, DL, document, DT, EM, FIELDSET, FONT, FORM, Hn, HR, HTMLAREA, I, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=hidden, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LI, LISTING, MAP, MARQUEE, MENU, NEXTID, NOBR, OBJECT, OL, OPTION, P, PLAINTEXT, PRE, Q, RB, RT, RUBY, S, SAMP, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TR, TT, U, UL, VAR, XMP