Export (0) Print
Expand All

initCustomEvent method

Initializes a new custom event that the createEvent method created.

Important  As of Project Spartan, the createEvent()/initEvent() constructor pattern for synthetic events is deprecated. See the Synthetic Events page for more information.
Document Object Model (DOM) Level 3 Events Specification, Section 4.2Internet Explorer 9

 

Syntax

var retval = CustomEvent.initCustomEvent(eventType, canBubble, cancelable, detail);

Parameters

eventType [in]

Type: String

A user-defined custom event type.

canBubble [in]

Type: Boolean

true (true)

The event should propagate upward.

false (false)

The event does not propagate upward.

cancelable [in]

Type: Boolean

true (true)

The default action can be canceled.

false (false)

The default action cannot be canceled.

detail [in]

Type: Object

A user-defined object that can contain additional information about the event. This parameter can be null. This value is returned in the detail property of the event.

Return value

Type: HRESULT

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

Standards information

See also

CustomEvent

 

 

Show:
© 2015 Microsoft