KeyEventArgs.SuppressKeyPress KeyEventArgs.SuppressKeyPress KeyEventArgs.SuppressKeyPress KeyEventArgs.SuppressKeyPress Property

定義

キー イベントを基になるコントロールに渡すかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the key event should be passed on to the underlying control.

public:
 property bool SuppressKeyPress { bool get(); void set(bool value); };
public bool SuppressKeyPress { get; set; }
member this.SuppressKeyPress : bool with get, set
Public Property SuppressKeyPress As Boolean

プロパティ値

キー イベントをコントロールに渡さない場合は true。それ以外の場合は falsetrue if the key event should not be sent to the control; otherwise, false.

次のコード例では、数値のキー TextBox入力がtextBox1という名前のコントロールに到達しないようにします。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;
    }
}
Private Sub TextBox1_KeyDown(ByVal sender As System.Object, _
    ByVal e As System.Windows.Forms.KeyEventArgs) Handles TextBox1.KeyDown
    
    If e.KeyCode >= Keys.D0 And e.KeyCode <= Keys.D9 And _
    e.Modifiers <> Keys.Shift Then
        e.SuppressKeyPress = True
    End If
End Sub

注釈

ユーザーの入力trueを防ぐために、などKeyDownのイベントハンドラーでこのプロパティにを割り当てることができます。You can assign true to this property in an event handler such as KeyDown in order to prevent user input.

をに設定するHandledtrue、もに設定されます。 true SuppressKeyPressSetting SuppressKeyPress to true also sets Handled to true.

適用対象

こちらもご覧ください