initUIEvent method

  • Article

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

 

Syntax

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

Parameters

eventType [in]

Type: BSTR

One of the following values, or a user-defined custom event type.

abort

An HTMLImgEvents::onabort event.

error

An HTMLLinkElementEvents::onerror event.

load

An HTMLFrameSiteEvents::onload event.

select

An HTMLTextContainerEvents::onselect event.

resize

An HTMLFrameSiteEvents::onresize event.

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.

view [in]

Type: IHTMLWindow2

An IHTMLWindow2 variable that specifies the active window, or NULL. This value is returned in the IDOMUIEvent::view property of the event.

detail [in]

Type: long

Anlong value that specifies additional information. 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