cancelBubble

HTML (DHTML)

previous page next page

cancelBubble Property

Internet Development Index

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

Syntax

event.cancelBubble [ = bCancel ]

Possible Values

bCancelBoolean that specifies or receives one of the following values.
falseDefault. Bubbling is enabled, allowing the next event handler in the hierarchy to receive the event.
trueBubbling is disabled for this event, preventing the next event handler in the hierarchy from receiving the event.

The property is read/write. The property has a default value of false.

Expressions can be used in place of the preceding value(s), as of Microsoft® Internet Explorer 5. For more information, see About Dynamic Properties.

Remarks

Using this property to cancel bubbling for an event does not affect subsequent events.

Example

This example cancels bubbling of the onclick event if it occurs in the img object when the user presses the SHIFT key. This prevents the event from bubbling up to the onclick event handler for the document.

<SCRIPT LANGUAGE="JScript">
function checkCancel()
{
if (window.event.shiftKey)
window.event.cancelBubble = true;
}
function showSrc()
{
if (window.event.srcElement.tagName == "IMG")
alert(window.event.srcElement.src);
}
</SCRIPT>
<BODY onclick="showSrc()">
<IMG onclick="checkCancel()" SRC="sample.gif">

Standards Information

There is no public standard that applies to this property.

Applies To

event
previous page start next page