HTMLWindowEvents4::ondblclick Event

[This documentation is preliminary and is subject to change.]

Fires when the user double-clicks the object.

Syntax

VARIANT_BOOL ondblclick(
    IHTMLEventObj *pEvtObj
);

Parameters

• pEvtObj
  [in] Pointer to an IHTMLEventObj interface for the current event. This is the same interface returned from IHTMLWindow2::event.

Return Value

If the event bubbles and is cancellable, return VARIANT_TRUE to prevent the event from bubbling to other event handlers in the document tree. Return VARIANT_FALSE to allow bubbling.

Event DISPID

DISPID_HTMLWINDOWEVENTS4_ONDBLCLICK

The DISPID for this event is defined in mshtmdid.h. Use this value to identify the event handler when implementing IDispatch::Invoke.

Event Information

Bubbles	Yes
Cancels	Yes
To invoke	Click the left mouse button twice in rapid succession over an object. The user's double-click must occur within the time limit specified by the user's system.
Default action	Initiates any action that is associated with the event.

Event Object Properties

The IHTMLEventObj interface contains additional information about the current event. When the ondblclick event is fired, you can use the IHTMLWindow2::event property to retrieve an IHTMLEventObj interface. To obtain an alternate interface pointer such as IHTMLEventObj2 or IHTMLEventObj3, call QueryInterface on the object.

Available Properties

IHTMLEventObj::button	Gets the mouse button pressed by the user.
IHTMLEventObj2::button	Gets or sets the mouse button pressed by the user.
IDOMMouseEvent::button	Gets the mouse button that caused an event.
IHTMLEventObj::clientX	Gets the x-coordinate of the mouse pointer's position relative to the client area of the window, excluding window decorations and scroll bars.
IHTMLEventObj2::clientX	Gets or sets the x-coordinate of the mouse pointer's position relative to the client area of the window, excluding window decorations and scroll bars.
IDOMMouseEvent::clientX	Gets the x-coordinate of the mouse pointer, relative to the upper-left corner of the viewport (that is, the browser's client area).
IHTMLEventObj::clientY	Gets the y-coordinate of the mouse pointer's position relative to the client area of the window, excluding window decorations and scroll bars.
IHTMLEventObj2::clientY	Gets or sets the y-coordinate of the mouse pointer's position relative to the client area of the window, excluding window decorations and scroll bars.
IDOMMouseEvent::clientY	Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the viewport (that is, the browser's client area).
IHTMLEventObj::ctrlKey	Gets the state of the CTRL key.
IHTMLEventObj2::ctrlKey	Gets or sets the state of the CTRL key.
IDOMMouseEvent::ctrlKey	Gets a value that indicates whether the Ctrl key is pressed.
IHTMLEventObj::offsetX	Gets the x-coordinate of the mouse pointer's position relative to the object firing the event.
IHTMLEventObj2::offsetX	Gets or sets the x-coordinate of the mouse pointer's position relative to the object firing the event.
IDOMMouseEvent::offsetX	Gets the y-coordinate of the mouse pointer, relative to the target node.
IHTMLEventObj::offsetY	Gets the y-coordinate of the mouse pointer's position relative to the object firing the event.
IHTMLEventObj2::offsetY	Gets or sets the y-coordinate of the mouse pointer's position relative to the object firing the event.
IDOMMouseEvent::offsetY	Gets the y-coordinate of the mouse pointer, relative to the target node.
IHTMLEventObj::screenX	Gets the x-coordinate of the mouse pointer's position relative to the user's screen.
IHTMLEventObj2::screenX	Gets or sets the x-coordinate of the mouse pointer's position relative to the user's screen.
IDOMMouseEvent::screenX	Gets the x-coordinate of the mouse pointer, relative to the upper-left corner of the screen.
IHTMLEventObj::screenY	Gets the y-coordinate of the mouse pointer's position relative to the user's screen.
IHTMLEventObj2::screenY	Gets or sets the y-coordinate of the mouse pointer's position relative to the user's screen.
IDOMMouseEvent::screenY	Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the screen.
IHTMLEventObj::shiftKey	Gets the state of the SHIFT key.
IHTMLEventObj2::shiftKey	Gets the state of the SHIFT key.
IDOMMouseEvent::shiftKey	Gets a value that indicates whether the Shift key is pressed.
IHTMLEventObj::srcElement	Gets the object that fired the event.
IHTMLEventObj2::srcElement	Gets or sets the object that fired the event.
IHTMLEventObj::x	Gets the x-coordinate (in pixels) of the mouse pointer's offset from the closest relatively positioned parent element of the element that fired the event.
IHTMLEventObj2::x	Gets or sets the x-coordinate (in pixels) of the mouse pointer's offset from the closest relatively positioned parent element of the element that fired the event.
IDOMMouseEvent::x	Gets the x-coordinate of the mouse pointer, relative to the last positioned ancestor element.
IHTMLEventObj::y	Gets the y-coordinate (in pixels) of the mouse pointer's offset from the closest relatively positioned parent element of the element that fired the event.
IHTMLEventObj2::y	Gets or sets the y-coordinate (in pixels) of the mouse pointer's offset from the closest relatively positioned parent element of the element that fired the event.
IDOMMouseEvent::y	Gets the y-coordinate of the mouse pointer, relative to the last positioned ancestor element.

Refer to the specific event object for additional event properties.

Remarks

The order of events leading to the HTMLWindowEvents4::ondblclick event is HTMLWindowEvents4::onmousedown, HTMLWindowEvents4::onmouseup, HTMLWindowEvents4::onclick, HTMLWindowEvents4::onmouseup, and then HTMLWindowEvents4::ondblclick. Actions associated with any of these events are executed when the HTMLWindowEvents4::ondblclick event fires.