initCustomEvent method

Initializes a new custom event that the IDocumentEvent::createEvent method created.

 

Syntax

HRESULT retVal = object.initCustomEvent(eventType, canBubble, cancelable, detail);

Parameters

eventType [in]

Type: BSTR

A user-defined custom event IDOMEvent::type.

canBubble [in]

Type: VARIANT_BOOL

VARIANT_TRUE (true)

The event should propagate upward.

VARIANT_FALSE (false)

The event does not propagate upward.

cancelable [in]

Type: VARIANT_BOOL

VARIANT_TRUE (true)

The default action can be canceled.

VARIANT_FALSE (false)

The default action cannot be canceled.

detail [in]

Type: IDispatch

A user-defined object that can contain additional information about the event. This parameter can be NULL. This value is returned in the IDOMUIEvent::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