onkeypress Event

Fires when the user presses an alphanumeric key.

Syntax

Inline HTML <ELEMENT onkeypress = "handler" ... > All platforms

Event property object.onkeypress = handler JScript (compatible with ECMA 262 language specification) only

Named script <SCRIPT FOR = object EVENT = onkeypress> Internet Explorer only

Inline HTML	<ELEMENT onkeypress = "handler" ... >	All platforms
Event property	object.onkeypress = handler	JScript (compatible with ECMA 262 language specification) only
Named script	<SCRIPT FOR = object EVENT = onkeypress>	Internet Explorer only

Remarks

Bubbles Yes

Cancels Yes

To invoke Press an alphanumeric keyboard key.

Default action Returns a number specifying the Unicode value of the key that was pressed.

Alphanumeric keyboard keys include uppercase letters, lowercase letters, numbers, symbols, punctuation characters, and the ESC, SPACE, and ENTER keys.

As of Microsoft® Internet Explorer 4.0, the onkeypress event fires and can be canceled for the following keys:

Letters: a - z
Numerals: 0 - 9
Symbols: ! @ # $ % ^ & * ( ) _ - + = < > [ ] { } , . / ? \ | ' ` " ~
System: ESCAPE, SPACE, SHIFT

Bubbles	Yes
Cancels	Yes
To invoke	Press an alphanumeric keyboard key.
Default action	Returns a number specifying the Unicode value of the key that was pressed.

Event Object Properties

Although event handlers in the DHTML Object Model do not receive parameters directly, the handler can query the event object for data.

Event Object Properties

altKey Retrieves the current state of the ALT key.

cancelBubble Sets or retrieves whether the current event should bubble up the hierarchy of event handlers.

clientX Retrieves the x-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.

clientY Retrieves the y-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.

ctrlKey Retrieves the state of the CTRL key.

keyCode Sets or retrieves the Unicode key code associated with the key that caused the event.

offsetX Retrieves the horizontal coordinate of the mouse's position relative to the object firing the event.

offsetY Retrieves the vertical coordinate of the mouse's position relative to the object firing the event.

returnValue Sets or retrieves the return value from the event.

screenX Retrieves the horizontal position of the mouse, in pixels, relative to the user's screen.

screenY Retrieves the vertical position of the mouse, in pixels, relative to the user's screen.

shiftKey Retrieves the state of the SHIFT key.

srcElement Retrieves the object that fired the event.

type Retrieves the event name from the event object.

x Retrieves the x-coordinate of the mouse cursor relative to the parent element.

y Retrieves the y-coordinate of the mouse cursor relative to the parent element.

altKey	Retrieves the current state of the ALT key.
cancelBubble	Sets or retrieves whether the current event should bubble up the hierarchy of event handlers.
clientX	Retrieves the x-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
clientY	Retrieves the y-coordinate of the mouse cursor relative to the client area of the window, excluding window decorations or scroll bars.
ctrlKey	Retrieves the state of the CTRL key.
keyCode	Sets or retrieves the Unicode key code associated with the key that caused the event.
offsetX	Retrieves the horizontal coordinate of the mouse's position relative to the object firing the event.
offsetY	Retrieves the vertical coordinate of the mouse's position relative to the object firing the event.
returnValue	Sets or retrieves the return value from the event.
screenX	Retrieves the horizontal position of the mouse, in pixels, relative to the user's screen.
screenY	Retrieves the vertical position of the mouse, in pixels, relative to the user's screen.
shiftKey	Retrieves the state of the SHIFT key.
srcElement	Retrieves the object that fired the event.
type	Retrieves the event name from the event object.
x	Retrieves the x-coordinate of the mouse cursor relative to the parent element.
y	Retrieves the y-coordinate of the mouse cursor relative to the parent element.

Example

This example shows how to retrieve information from the shiftKey property of the event object. When the user simultaneously presses the shift key and types a character in the first text field, the value "true" appears in the second text field.

Sample Code
<HEAD>
<SCRIPT>
function checkKey()
{
if (window.event.shiftKey)  // checks whether the SHIFT key 
                            // is pressed
   {
   txtOutput.value = "true"; // returns TRUE if SHIFT is pressed 
                             // when the event fires
   }
}
</SCRIPT>
</HEAD>
<BODY>
<P>Press the SHIFT key while pressing another key.<BR>
    <INPUT TYPE=text NAME=txtEnterValue onkeypress="checkKey()">
<P>Indicates "true" if the shift key is used.<BR>
    <INPUT TYPE=text NAME=txtOutput>
</BODY>
This feature requires Internet Explorer 4.0 or later. Click the icon below to install the latest version. Then reload this page to view the sample.

Applies To

[ Object Name ]

Platform Version

Win16:

Win32:

Mac:

Unix:

WinCE:

Version data is listed when the mouse hovers over a link, or the link has focus.

A, ACRONYM, ADDRESS, APPLET, AREA, B, BDO, BIG, BLOCKQUOTE, BODY, BUTTON, CAPTION, CENTER, CITE, CODE, custom, DD, DEL, DFN, DIR, DIV, document, DT, EM, FIELDSET, FONT, FORM, Hn, HR, I, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LEGEND, LI, LISTING, MAP, MARQUEE, MENU, NEXTID, NOBR, OBJECT, OL, P, PLAINTEXT, PRE, Q, RT, RUBY, S, SAMP, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TR, TT, U, UL, VAR, XMP