Fires when the user double-clicks the object.
| Inline |
<element ondblclick = "handler" ... > |
| Script |
object.ondblclick = handler |
| Bubbles |
Yes |
| Cancels |
Yes |
| To invoke |
Click the left mouse button twice in rapid succession over an object. The two clicks must occur within the time limit specified by the double-click speed setting of the user's system. |
| Default action |
Initiates any action that is associated with the event. |
The order of events leading to the ondblclick event is onmousedown, onmouseup, onclick, onmouseup, and then ondblclick. Actions associated with any of these events will be executed when the ondblclick event fires.
While event handlers in the Document 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. |
| 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 |
Returns the horizontal position of the mouse when the event fires. |
| y |
Returns the vertical position of the mouse when the event fires. |
This example demonstrates how a user can add items to a list box by double-clicking.
Sample Code
<head>
. . .
<script language="JavaScript">
function addItem ( ) {
sNewItem = new Option(txtEnter.value)
selList.add(sNewItem, -1);}
</script>
</head>
<body>
. . .
<div align="center">
<input type=text name=txtEnter
value="Enter text" ondblclick="addItem()">
<select name=selList></select></div>
</body>
Show me