initKeyboardEvent method
[This documentation is preliminary and is subject to change.]
Initializes a new keyboard event that the createEvent method created.
![]() ![]() |
Syntax
HRESULT retVal = object.initKeyboardEvent(eventType, canBubble, cancelable, viewArg, keyArg, locationArg, modifiersListArg, repeat, locale);
Standards information
- Document Object Model (DOM) Level 3 Events Specification, Section 5.2.6
Parameters
eventType [in]
Type: BSTR
One of the following values, or a user-defined custom event type.
keydown
An onkeydown event.
keypress
An onkeypress event.
keyup
An onkeyup 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.
viewArg [in]
Type: IHTMLWindow2
An IHTMLWindow2 variable that specifies the active window, or NULL. This value is returned in the view property of the event.
keyArg [in]
Type: BSTR
The key identifier. This value is returned in the key property of the event.
locationArg [in]
Type: unsigned long
The location of the key on the device. This value is returned in the location property of the event.
modifiersListArg [in]
Type: BSTR
A space-separated list of any of the following values:
Alt
The left or right Alt key is pressed.
AltGraph
The Ctrl and Alt keys are pressed.
CapsLock
The Caps Lock toggle is enabled.
Control
The left or right Ctrl key is pressed.
Meta
The Meta/Control key is pressed.
NumLock
The Num Lock toggle is enabled.
Scroll
The Scroll Lock toggle is enabled.
Shift
The left or right Shift key is pressed.
Win
The left or right Windows logo key is pressed.
repeat [in]
Type: VARIANT_BOOL
The number of times this key has been pressed. This value is returned in the repeat property of the event.
locale [in]
Type: BSTR
The locale name. This value is returned in the locale attribute of the event.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Build date: 1/23/2012
.png)
.png)