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

KeyEventArgs.SuppressKeyPress Property

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

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.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
© 2014 Microsoft. All rights reserved.