KeyEventArgs.SuppressKeyPress Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether the key event should be passed on to the underlying control.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public bool SuppressKeyPress { get; set; }

Property Value

Type: System.Boolean

true if the key event should not be sent to the control; otherwise, false.

You can assign true to this property in an event handler such as KeyDown in order to prevent user input.

Setting SuppressKeyPress to true also sets Handled to true.

The following code example prevents numeric keystrokes from reaching the TextBox control named textBox1.

private void textBox1_KeyDown(object sender, KeyEventArgs e)
{
    if (e.KeyCode >= Keys.D0 && e.KeyCode <= Keys.D9 && e.Modifiers != Keys.Shift)
    {
        e.SuppressKeyPress = true;
    }
}

.NET Framework
Available since 2.0
Return to top
Show: