preventDefault method

Cancels the default action of an event.

 

Syntax

HRESULT retVal = object.preventDefault();

Parameters

This method has no parameters.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

• Document Object Model (DOM) Level 3 Events Specification, Section 4.1

Remarks

If an event is IDOMEvent::cancelable, the IDOMEvent::preventDefault method signfies that the event should be canceled. Any event handler can cancel the default action. If the event cannot be canceled, this method has no effect.

A call to this method is similar to setting the IHTMLEventObj::returnValue event property to VARIANT_FALSE in Windows Internet Explorer 8 and earlier versions.

See also

Reference

IDOMEvent::cancelable

IDOMEvent::stopPropagation