initTextEvent method

Initializes a new text event that the createEvent method created.

Important  As of Microsoft Edge, 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 5.2.5Internet Explorer 9



var retval = TextEvent.initTextEvent(eventType, canBubble, cancelable, viewArg, dataArg, inputMethod, locale);


eventType [in]

Type: String

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


Characters have been entered.

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.

viewArg [in]

Type: IHTMLWindow2

The active window object or null. This value is returned in the view property of the event.
dataArg [in]

Type: String

Character data. This value is returned in the data property of the event.

inputMethod [in]

Type: unsigned long

The input mode for the text. For more information, see inputMethod.

locale [in]

Type: String

The locale name. This value is returned in the locale attribute of the event.

Return value


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

Standards information

See also