Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Do not use it in old or new projects. Pages or Web apps using it may break at any time.

The UIEvent.initUIEvent() method initializes a UI event once it's been created.

Events initialized in this way must have been created with the Document.createEvent() method. This method must be called to set the event before it is dispatched, using EventTarget.dispatchEvent(). Once dispatched, it doesn't do anything anymore.

Do not use this method anymore as it is deprecated.

Instead use specific event constructors, like UIEvent(). The page on Creating and triggering events gives more information about the way to use these.

Syntax

event.initUIEvent(type, canBubble, cancelable, view, detail) 

Parameters

type
Is a DOMString defining the type of event.
canBubble
Is a Boolean deciding whether the event should bubble up through the event chain or not. Once set, the read-only property Event.bubbles will give its value.
cancelable
Is a Boolean defining whether the event can be canceled. Once set, the read-only property Event.cancelable will give its value.
view
Is the WindowProxy associated with the event.
detail
Is an unsigned long  specifying some detail information about the event, depending on the type of event. For mouse events, it indicates how many times the mouse has been clicked on a given screen location.

Example

var e = document.createEvent("UIEvent");
// creates a click event that bubbles, can be cancelled,
// and with its view and detail property initialized to window and 1,
// respectively
e.initUIEvent("click", true, true, window, 1);

Specifications

Specification Status Comment
Document Object Model (DOM) Level 3 Events Specification
The definition of 'UIEvent.initUIEvent()' in that specification.
Working Draft From Document Object Model (DOM) Level 2 Events Specification, deprecated.
Document Object Model (DOM) Level 2 Events Specification
The definition of 'UIEvent.initUIEvent()' in that specification.
Recommendation Initial definition.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) (Yes) ? (Yes) ?
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) (Yes) ? (Yes) ?

See also

  • UIEvent
  • The constructor to use instead of this deprecated method: UIEvent(). More specific constructors can be used too.

Document Tags and Contributors

Last updated by: fscholz,