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

public bool SuppressKeyPress { get; set; }
/** @property */
public boolean get_SuppressKeyPress ()

/** @property */
public void set_SuppressKeyPress (boolean value)

public function get SuppressKeyPress () : boolean

public function set SuppressKeyPress (value : boolean)

Not applicable.

Property Value

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.

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

Community Additions