Export (0) Print
Expand All
4 out of 10 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)
'Declaration
Public Property KeyChar As Char

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.

NoteNote

For information about how to detect any of the non-character keys mentioned above, see the KeyEventArgs class.

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.

Imports System
Imports System.Windows.Forms

Public Class Form1
    Inherits Form

    Public Sub New()
        ' Create a TextBox control. 
        Dim tb As New TextBox()
        Me.Controls.Add(tb)
        AddHandler tb.KeyPress, AddressOf keypressed
    End Sub 'New 

    Private Sub keypressed(ByVal o As [Object], ByVal e As KeyPressEventArgs)
        ' 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 = Microsoft.VisualBasic.ChrW(Keys.Return) Then
            e.Handled = True 
        End If 
    End Sub 'keypressed

    Public Shared Sub Main()
        Application.Run(New Form1())
    End Sub 'Main
End Class 'Form1

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.