initPopStateEvent method

Initializes the properties of a PopStateEvent.

Important  As of Microsoft Edge, the createEvent()/initEvent() constructor pattern for synthetic events is deprecated. See the Synthetic Events page for more information.
 
Internet Explorer 10

 

Syntax

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

Parameters

typeArg [in]

Type: DOMString

The type of the event being created.

canBubbleArg [in]

Type: boolean

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

cancelableArg [in]

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 [in]

Type: any

The object to be applied to the state property.

Return value

Type: HRESULT

This method can return one of these values.

S_OK

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.

See also

PopStateEvent

 

 

Show: