KeyEventArgs.SuppressKeyPress プロパティ

.NET Framework クラス ライブラリ リファレンス

KeyEventArgs.SuppressKeyPress プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

キー イベントを基になるコントロールに渡すかどうかを示す値を取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Property SuppressKeyPress As
 Boolean

Visual Basic (使用法)

Dim instance As KeyEventArgs
Dim value As Boolean

value = instance.SuppressKeyPress

instance.SuppressKeyPress = value

C#

public bool SuppressKeyPress { get;
 set; }

C++

public:
property bool SuppressKeyPress {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_SuppressKeyPress ()

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

JScript

public function get SuppressKeyPress
 () : boolean

public function set SuppressKeyPress
 (value : boolean)

プロパティ値
キー イベントをコントロールに渡さない場合は true。それ以外の場合は false。

解説

KeyDown などのイベント ハンドラでこのプロパティを true に設定すると、ユーザーによる入力を防止できます。

SuppressKeyPress を true に設定すると、Handled も true に設定されます。

使用例

textBox1 という名前の TextBox が、数値のキーストロークを受け取らないようにするコード例を、次に示します。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
KeyEventArgs クラス
KeyEventArgs メンバ
System.Windows.Forms 名前空間
KeyEventArgs.Handled プロパティ