initPopStateEvent

Summary

Initializes the properties of a PopStateEvent.

Method of dom/PopStateEventdom/PopStateEvent

Syntax

var object = object.initPopStateEvent(/* see parameter list */);

Parameters

typeArg

Data-type

any

The type of the event being created.

canBubbleArg

Data-type

any

Indicates whether the event can bubble. When true, the event propagates upward. When false, the event does not propagate upward.

cancelableArg

Data-type

Boolean

Indicates whether the event’s default action can be prevented. When true, the default action can be canceled. When false, the default action cannot be canceled.

stateArg

Data-type

any

The object to be applied to the state property.

Return Value

Returns an object of type DOM NodeDOM Node

Type: HRESULT

This method can return one of these values.

S_OK

Examples

var evt = document.createEvent("PopStateEvent");
evt.initPopStateEvent("popstate", false, false, { .. state object  ..});
window.dispatchEvent(evt);

Notes

Remarks

Initializes attributes of an event created through the createEvent method. This method can only be called before the event has been dispatched via the dispatchEvent method. If the method is called several times before invoking dispatchEvent, only the final invocation takes precedence. This method has no effect if called after the event has been dispatched.

Syntax

var retval = PopStateEvent.initPopStateEvent(typeArg, canBubbleArg, cancelableArg, stateArg);

Attributions

• Microsoft Developer Network: [initPopStateEvent Method Article]