Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0Version 17.0 (current version)Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0Version 2.0

On this page

You are viewing an old version of this documentation. Click here to open the current version, 17.0.

attachDOMEvent

Summary

Attach user-defined event handler for any DOM event for an element.

Syntax

keyman.util.attachDOMEvent(Pelem, eventName, handler, useCapture);

Parameters

Pelem
Type: Element
Element to which the event is being attached.
eventName
Type: string
The name of the event, without an 'on' prefix.
handler
Type: function(Object)
The event handler being attached.
useCapture
Type: boolean optional
Set this to true if the event should be captured in the bubbling phase; otherwise, use false or leave this parameter empty.

Return Value

undefined

Description

The event name should be specified without the 'on' prefix. The fourth argument, useCapture, is optional and will default to false.

The method exists for legacy reasons that arise when dealing with old versions of IE, simplifying event-handling code.

See also: keyman.util.detachDOMEvent