Export (0) Print
Expand All
3 out of 4 rated this helpful - Rate this topic

KeyPressEventArgs.Handled Property

Gets or sets a value indicating whether the KeyPress event was handled.

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

Property Value

Type: System.Boolean
true if the event is handled; otherwise, false.

If the event is not handled, it will be sent to the operating system for default processing. Set Handled to true to cancel the KeyPress event.

The following example creates a TextBox control. 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, 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());
    }
}

.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.

Show:
© 2014 Microsoft. All rights reserved.