Export (0) Print
Expand All
9 out of 12 rated this helpful - Rate this topic

KeyPressEventArgs.KeyChar Property

Gets or sets the character corresponding to the key pressed.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public char KeyChar { get; set; }

Property Value

Type: System.Char
The ASCII character that is composed. For example, if the user presses SHIFT + K, this property returns an uppercase K.

Use the KeyChar property to sample keystrokes at run time and to modify keystrokes under special run-time circumstances. For example, you can use KeyChar to disable non-numeric keypresses when the user enters a ZIP code, change all alphabetical keypresses to uppercase in a data entry field, or monitor the keyboard or other key input device for specific key combinations.

You can get or set the following keys:

  • a-z, A-Z.

  • CTRL.

  • Punctuation marks.

  • Number keys, both across the top of the keyboard and on the numeric keypad.

  • ENTER.

You cannot get or set the following keys:

  • The TAB key.

  • INSERT and DELETE.

  • HOME.

  • END.

  • PAGE UP and PAGE DOWN.

  • F1-F2.

  • ALT.

  • Arrow keys.

The following example creates a TextBox control. The keypressed method uses the KeyChar property to check whether the ENTER key pressed. If the ENTER key is pressed, the Handled property is set to true, which indicates the event is handled.

using System;
using System.Windows.Forms;

public class Form1: Form
{
    public Form1()
    {
        // Create a TextBox control.
        TextBox tb = new TextBox();
        this.Controls.Add(tb);
        tb.KeyPress += new KeyPressEventHandler(keypressed);
    }

    private void keypressed(Object o, KeyPressEventArgs e)
    {
        // The keypressed method uses the KeyChar property to check  
        // whether the ENTER key is pressed.  

        // If the ENTER key is pressed, the Handled property is set to true,  
        // to indicate the event is handled. 
        if (e.KeyChar == (char)Keys.Return)
        {
            e.Handled = true;
        }
    }

    public static void Main()
    {
        Application.Run(new Form1());
    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.