This documentation is archived and is not being maintained.

KeyEventArgs.KeyCode Property

Gets the keyboard code for a KeyDown or KeyUp event.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public Keys KeyCode { get; }
/** @property */
public Keys get_KeyCode ()

public function get KeyCode () : Keys

Not applicable.

Property Value

A Keys value that is the key code for the event.

The following code examples show how to use the KeyCode property to determine which key was pressed.

Example 1

The following code example demonstrates how to use the KeyDown event with the Help class to display pop-up style Help to the user of the application. The example uses the KeyEventArgs properties passed to the event handler method to filter for all variations of pressing the F1 key with a modifier key. When the user presses any variation of F1 that includes any keyboard modifier, the Help class displays a pop-up window, similar to a ToolTip, near the control. If the user presses ALT+F2, a different Help pop-up is displayed with additional information.

private void textBox1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e)
{
    // Determine whether the key entered is the F1 key. If it is, display Help.
    if(e.KeyCode == Keys.F1 && (e.Alt || e.Control || e.Shift))
    {
        // Display a pop-up Help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your name.", new Point(textBox1.Bottom, textBox1.Right));
    }
    else if(e.KeyCode == Keys.F2 && e.Modifiers == Keys.Alt)
    {
        // Display a pop-up Help topic to provide additional assistance to the user.
        Help.ShowPopup(textBox1, "Enter your first name followed by your last name. Middle name is optional.",
            new Point(textBox1.Top, this.textBox1.Left));
    }
}

    // This example demonstrates how to use the KeyDown event with the Help 
    // class to display pop-up style help to the user of the application.
    // The example filters for all variations of pressing the F1 key with
    // a modifier key by using the KeyEventArgs properties passed to the
    // event handling method.When the user presses any variation of F1 that
    // includes any keyboard modifier, the Help class displays a pop-up window,
    // similar to a ToolTip, near the control. If the user presses ALT + F2,
    // a different Help pop-up is displayed with additional information.
    // This example assumes that a tTextBox control, named textBox1, has been
    // added to the form and its KeyDown event has been contected to this 
    // event handling method.
    private void textBox1_KeyDown(Object sender,
        System.Windows.Forms.KeyEventArgs e)
    {
        // Determine whether the key entered is the F1 key.
        //If it is, display Help.
        if (e.get_KeyCode().Equals(Keys.F1) && (e.get_Alt() || e.get_Control() 
            || e.get_Shift())) {
            // Display a pop-up Help topic to assist the user.
            Help.ShowPopup(textBox1, "Enter your name.", new Point(textBox1.
                get_Bottom(), textBox1.get_Right()));
        }
        else {
            if (e.get_KeyCode().Equals(Keys.F2) && e.get_Modifiers().
                Equals(Keys.Alt)) {
                // Display a pop-up Help topic to provide additional assistance
                // to the user.
                Help.ShowPopup(textBox1, "Enter your first name followed by" 
                    + " your last name.Middle name is optional.",new Point(
                    textBox1.get_Top(), this.textBox1.get_Left()));
            }
        }
    } //textBox1_KeyDown
} //Form1

Example 2

The following example determines whether the user pressed ALT+E, and if the mouse pointer is over a TreeNode, allows the user to edit that TreeNode.

private void treeView1_KeyDown(object sender, KeyEventArgs e)
{
   /* If the 'Alt' and 'E' keys are pressed,
      * allow the user to edit the TreeNode label. */
   if(e.Alt && e.KeyCode == Keys.E)
         
   {
      treeView1.LabelEdit = true;
      // If there is a TreeNode under the mose cursor, begin editing. 
      TreeNode editNode = treeView1.GetNodeAt(
         treeView1.PointToClient(Control.MousePosition));
      if(editNode != null)
      { 
         editNode.BeginEdit();
      }
   }
}

private void treeView1_AfterLabelEdit(object sender, NodeLabelEditEventArgs e)
{
   // Disable the ability to edit the TreeNode labels.
   treeView1.LabelEdit = false;
}

private void treeView1_KeyDown(Object sender, KeyEventArgs e)
{
    /* If the 'Alt' and 'E' keys are pressed,
       allow the user to edit the TreeNode label. 
     */
    if (e.get_Alt() && e.get_KeyCode() == Keys.E) {
        treeView1.set_LabelEdit(true);
        // If there is a TreeNode under the mose cursor, begin editing. 
        TreeNode editNode = treeView1.GetNodeAt(treeView1.PointToClient(
            Control.get_MousePosition()));
        if (editNode != null) {
            editNode.BeginEdit();
        }
    }
} //treeView1_KeyDown

private void treeView1_AfterLabelEdit(Object sender, 
    NodeLabelEditEventArgs e)
{
    // Disable the ability to edit the TreeNode labels.
    treeView1.set_LabelEdit(false);
} //treeView1_AfterLabelEdit

Example 3

The following example determines whether the user pressed a non-numeric key, and if so, cancels the KeyPress event by using the Handled property.

// Boolean flag used to determine when a character other than a number is entered.
private bool nonNumberEntered = false;

// Handle the KeyDown event to determine the type of character entered into the control.
private void textBox1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e)
{
    // Initialize the flag to false.
    nonNumberEntered = false;

    // Determine whether the keystroke is a number from the top of the keyboard.
    if (e.KeyCode < Keys.D0 || e.KeyCode > Keys.D9)
    {
        // Determine whether the keystroke is a number from the keypad.
        if (e.KeyCode < Keys.NumPad0 || e.KeyCode > Keys.NumPad9)
        {
            // Determine whether the keystroke is a backspace.
            if(e.KeyCode != Keys.Back)
            {
                // A non-numerical keystroke was pressed.
                // Set the flag to true and evaluate in KeyPress event.
                nonNumberEntered = true;
            }
        }
    }
}

// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
private void textBox1_KeyPress(object sender, System.Windows.Forms.KeyPressEventArgs e)
{
    // Check for the flag being set in the KeyDown event.
    if (nonNumberEntered == true)
    {
        // Stop the character from being entered into the control since it is non-numerical.
        e.Handled = true;
    }
}


// Boolean flag used to determine when a character other than a number 
// is entered.
private boolean nonNumberEntered = false;

// Handle the KeyDown event to determine the type of character entered 
// into the control.
private void textBox1_KeyDown(Object sender, 
    System.Windows.Forms.KeyEventArgs e)
{
    // Initialize the flag to false.
    nonNumberEntered = false;

    // Determine whether the keystroke is a number from the top of the 
    // keyboard.
    if ((e.get_KeyCode().CompareTo(Keys.D0)) < 0 
        || (e.get_KeyCode().CompareTo(Keys.D9) > 0)) {

        // Determine whether the keystroke is a number from the keypad.
        if ((e.get_KeyCode().CompareTo(Keys.NumPad0) < 0 
            || (e.get_KeyCode().CompareTo(Keys.NumPad9)) > 0)) {

            // Determine whether the keystroke is a backspace.
            if (!(e.get_KeyCode().Equals(Keys.Back))) {
                    // A non-numerical keystroke was pressed.
                    // Set the flag to true and evaluate in KeyPress event.
                    nonNumberEntered = true;
            }
        }
    }
} //textBox1_KeyDown

// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
private void textBox1_KeyPress(Object sender, System.Windows.Forms.
    KeyPressEventArgs e)
{
    // Check for the flag being set in the KeyDown event.
    if (nonNumberEntered == true) {
        // Stop the character from being entered into the control since 
        // it is non-numerical.
        e.set_Handled(true);
    }
} //textBox1_KeyPress

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: