KeyEventArgs

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

KeyEventArgs クラス

KeyDown イベントまたは KeyUp イベントのデータを提供します。

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

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public Class KeyEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As KeyEventArgs

C#

[ComVisibleAttribute(true)] 
public class KeyEventArgs : EventArgs

C++

[ComVisibleAttribute(true)] 
public ref class KeyEventArgs : public
 EventArgs

J#

/** @attribute ComVisibleAttribute(true) */ 
public class KeyEventArgs extends EventArgs

JScript

ComVisibleAttribute(true) 
public class KeyEventArgs extends
 EventArgs

解説

各 KeyDown イベントまたは KeyUp イベントに伴い、ユーザーが押したキーおよび同時に任意の修飾子キー (Ctrl、Alt、および Shift) が押されたかどうかを指定する KeyEventArgs が渡されます。

KeyDown イベントは、ユーザーが任意のキーを押すと発生します。KeyUp イベントは、ユーザーが押していたキーを離すと発生します。キーを押し続けている間は、キーが繰り返されるたびに KeyDown イベントが複製され、ユーザーがキーを離すと KeyUp イベントが 1 つだけ生成されます。

キーが押されている間も KeyPress イベントが発生します。各 KeyPress イベントに伴い KeyPressEventArgs が渡され、各キーを押した結果作成される文字を指定します。

イベント モデルの詳細については、「イベントとデリゲート」を参照してください。

使用例

キーの押下状態を検出する方法を次のコード例に示します。

Visual Basic

' This example demonstrates how to use the KeyDown event with the Help
 class to display
' pop-up style help to the user of the application. The example filters
 for all variations
' of pressing the F1 key with a modifier key by using the KeyEventArgs
 properties passed
' to the event-handler method. 
' When the user presses any variation of F1 that includes any keyboard
 modifier, the Help
' class displays a pop-up window, similar to a ToolTip, near the control.
 If the user presses 
' ALT + F2, a different Help pop-up is displayed with additional information.
 This example assumes
' that a TextBox control, named textBox1, has been added to the form
 and its KeyDown
' event has been contected to this event-handler method.
Private Sub textBox1_KeyDown(ByVal
 sender As Object, ByVal
 e As System.Windows.Forms.KeyEventArgs) Handles textBox1.KeyDown
    ' Determine whether the key entered is the F1 key. If it is, display
 Help.
    If e.KeyCode = Keys.F1 AndAlso (e.Alt OrElse
 e.Control OrElse e.Shift) Then
        ' Display a pop-up Help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your name.",
 New Point(textBox1.Bottom, textBox1.Right))
    ElseIf e.KeyCode = Keys.F2 AndAlso e.Modifiers
 = Keys.Alt Then
        ' Display a pop-up Help topic to provide additional assistance
 to the user.
        Help.ShowPopup(textBox1, "Enter your first name followed
 by your last name. Middle name is optional.", _
             New Point(textBox1.Top, Me.textBox1.Left))
    End If
End Sub 'textBox1_KeyDown

C#

// This example demonstrates how to use the KeyDown event with the Help
 class to display
// pop-up style help to the user of the application. The example filters
 for all variations
// of pressing the F1 key with a modifier key by using the KeyEventArgs
 properties passed
// to the event-handler method.
// When the user presses any variation of F1 that includes any keyboard
 modifier, the Help
// class displays a pop-up window, similar to a ToolTip, near the control.
 If the user presses
// ALT + F2, a different Help pop-up is displayed with additional information.
 This example assumes
// that a tTextBox control, named textBox1, has been added to the form
 and its KeyDown
// event has been contected to this event-handler method.
private void textBox1_KeyDown(object sender,
 System.Windows.Forms.KeyEventArgs e)
{
    // Determine whether the key entered is the F1 key. If it is, display
 Help.
    if(e.KeyCode == Keys.F1 && (e.Alt || e.Control ||
 e.Shift))
    {
        // Display a pop-up Help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your name.", new
 Point(textBox1.Bottom, textBox1.Right));
    }
    else if(e.KeyCode == Keys.F2 &&
 e.Modifiers == Keys.Alt)
    {
        // Display a pop-up Help topic to provide additional assistance
 to the user.
        Help.ShowPopup(textBox1, "Enter your first name followed by your last
 name. Middle name is optional.",
            new Point(textBox1.Top, this.textBox1.Left));
    }
}

C++

   // This example demonstrates how to use the KeyDown event with the Help
 class to display
   // pop-up style help to the user of the application. The example filters
 for all variations
   // of pressing the F1 key with a modifier key by using the KeyEventArgs
 properties passed
   // to the event handling method.
   // When the user presses any variation of F1 that includes any keyboard
 modifier, the Help
   // class displays a pop-up window, similar to a ToolTip, near the control.
 If the user presses
   // ALT + F2, a different Help pop-up is displayed with additional information.
 This example assumes
   // that a tTextBox control, named textBox1, has been added to the form
 and its KeyDown
   // event has been contected to this event handling method.
private:
   void textBox1_KeyDown( Object^ /*sender*/, System::Windows::Forms::KeyEventArgs^
 e )
   {
      // Determine whether the key entered is the F1 key. If it is, display
 Help.
      if ( e->KeyCode == Keys::F1 && (e->Alt ||
 e->Control || e->Shift) )
      {
         
         // Display a pop-up Help topic to assist the user.
         Help::ShowPopup( textBox1, "Enter your name.", Point(textBox1->Bottom,textBox1->Right)
 );
      }
      else
      if ( e->KeyCode == Keys::F2 && e->Modifiers
 == Keys::Alt )
      {
         // Display a pop-up Help topic to provide additional assistance
 to the user.
         Help::ShowPopup( textBox1, "Enter your first name followed by your
 last name. Middle name is optional.",
            Point(textBox1->Top,this->textBox1->Left)
 );
      }
   }

J#

    // This example demonstrates how to use the KeyDown event with the Help
 
    // class to display pop-up style help to the user of the application.
    // The example filters for all variations of pressing the F1 key
 with
    // a modifier key by using the KeyEventArgs properties passed to
 the
    // event handling method.When the user presses any variation of
 F1 that
    // includes any keyboard modifier, the Help class displays a pop-up
 window,
    // similar to a ToolTip, near the control. If the user presses ALT
 + F2,
    // a different Help pop-up is displayed with additional information.
    // This example assumes that a tTextBox control, named textBox1,
 has been
    // added to the form and its KeyDown event has been contected to
 this 
    // event handling method.
    private void textBox1_KeyDown(Object sender
,
        System.Windows.Forms.KeyEventArgs e)
    {
        // Determine whether the key entered is the F1 key.
        //If it is, display Help.
        if (e.get_KeyCode().Equals(Keys.F1) && (e.get_Alt()
 || e.get_Control() 
            || e.get_Shift())) {
            // Display a pop-up Help topic to assist the user.
            Help.ShowPopup(textBox1, "Enter your name.", new
 Point(textBox1.
                get_Bottom(), textBox1.get_Right()));
        }
        else {
            if (e.get_KeyCode().Equals(Keys.F2) && e.get_Modifiers().
                Equals(Keys.Alt)) {
                // Display a pop-up Help topic to provide additional
 assistance
                // to the user.
                Help.ShowPopup(textBox1, "Enter your first name followed by"
 
                    + " your last name.Middle name is optional.",new
 Point(
                    textBox1.get_Top(), this.textBox1.get_Left()));
            }
        }
    } //textBox1_KeyDown
} //Form1

Visual Basic

Private Sub treeView1_KeyDown(sender As
 Object, _
  e As KeyEventArgs) Handles treeView1.KeyDown
   ' If the 'Alt' and 'E' keys are pressed,
   ' allow the user to edit the TreeNode label. 
   If e.Alt And e.KeyCode = Keys.E Then
      treeView1.LabelEdit = True
      ' If there is a TreeNode under the mose cursor, begin editing.
 
      Dim editNode As TreeNode = treeView1.GetNodeAt(
 _
        treeView1.PointToClient(Control.MousePosition))
      If Not (editNode Is
 Nothing) Then
         editNode.BeginEdit()
      End If
   End If
End Sub

Private Sub treeView1_AfterLabelEdit(sender
 As Object, _
  e As NodeLabelEditEventArgs) Handles treeView1.AfterLabelEdit
   ' Disable the ability to edit the TreeNode labels.
   treeView1.LabelEdit = False
End Sub

C#

private void treeView1_KeyDown(object sender,
 KeyEventArgs e)
{
   /* If the 'Alt' and 'E' keys are pressed,
      * allow the user to edit the TreeNode label. */
   if(e.Alt && e.KeyCode == Keys.E)
         
   {
      treeView1.LabelEdit = true;
      // If there is a TreeNode under the mose cursor, begin editing.
 
      TreeNode editNode = treeView1.GetNodeAt(
         treeView1.PointToClient(Control.MousePosition));
      if(editNode != null)
      { 
         editNode.BeginEdit();
      }
   }
}

private void treeView1_AfterLabelEdit(object
 sender, NodeLabelEditEventArgs e)
{
   // Disable the ability to edit the TreeNode labels.
   treeView1.LabelEdit = false;
}

C++

private:
   void treeView1_KeyDown( Object^ /*sender*/, KeyEventArgs^ e
 )
   {
      /* If the 'Alt' and 'E' keys are pressed,
         * allow the user to edit the TreeNode label. */
      if ( e->Alt && e->KeyCode == Keys::E )
      {
         treeView1->LabelEdit = true;
         
         // If there is a TreeNode under the mose cursor, begin editing.
         TreeNode^ editNode = treeView1->GetNodeAt( treeView1->PointToClient(
 Control::MousePosition ) );
         if ( editNode != nullptr )
         {
            editNode->BeginEdit();
         }
      }
   }

   void treeView1_AfterLabelEdit( Object^ /*sender*/, NodeLabelEditEventArgs^
 /*e*/ )
   {
      // Disable the ability to edit the TreeNode labels.
      treeView1->LabelEdit = false;
   }

J#

private void treeView1_KeyDown(Object sender,
 KeyEventArgs e)
{
    /* If the 'Alt' and 'E' keys are pressed,
       allow the user to edit the TreeNode label. 
     */
    if (e.get_Alt() && e.get_KeyCode() == Keys.E) {
        treeView1.set_LabelEdit(true);
        // If there is a TreeNode under the mose cursor, begin editing.
 
        TreeNode editNode = treeView1.GetNodeAt(treeView1.PointToClient(
            Control.get_MousePosition()));
        if (editNode != null) {
            editNode.BeginEdit();
        }
    }
} //treeView1_KeyDown

private void treeView1_AfterLabelEdit(Object
 sender, 
    NodeLabelEditEventArgs e)
{
    // Disable the ability to edit the TreeNode labels.
    treeView1.set_LabelEdit(false);
} //treeView1_AfterLabelEdit

Visual Basic

    ' Boolean flag used to determine when a character other than a number
 is entered.
    Private nonNumberEntered As Boolean
 = False
   
   
    ' Handle the KeyDown event to determine the type of character entered
 into the control.
    Private Sub textBox1_KeyDown(sender As
 Object, e As System.Windows.Forms.KeyEventArgs)
 _
         Handles textBox1.KeyDown
        ' Initialize the flag to false.
        nonNumberEntered = False
      
        ' Determine whether the keystroke is a number from the top of
 the keyboard.
        If e.KeyCode < Keys.D0 OrElse e.KeyCode
 > Keys.D9 Then
            ' Determine whether the keystroke is a number from the keypad.
            If e.KeyCode < Keys.NumPad0 OrElse
 e.KeyCode > Keys.NumPad9 Then
                ' Determine whether the keystroke is a backspace.
                If e.KeyCode <> Keys.Back Then
                    ' A non-numerical keystroke was pressed. 
                    ' Set the flag to true and evaluate in KeyPress
 event.
                    nonNumberEntered = True
                End If
            End If
        End If
    End Sub 'textBox1_KeyDown
   
   
    ' This event occurs after the KeyDown event and can be used 
    ' to prevent characters from entering the control.
    Private Sub textBox1_KeyPress(sender As
 Object, e As System.Windows.Forms.KeyPressEventArgs)
 _
        Handles textBox1.KeyPress
        ' Check for the flag being set in the KeyDown event.
        If nonNumberEntered = True Then
            ' Stop the character from being entered into the control
 since it is non-numerical.
            e.Handled = True
        End If
    End Sub 'textBox1_KeyPress
End Class 'Form1 

C#

// Boolean flag used to determine when a character other than a number
 is entered.
private bool nonNumberEntered = false;

// Handle the KeyDown event to determine the type of character entered
 into the control.
private void textBox1_KeyDown(object sender,
 System.Windows.Forms.KeyEventArgs e)
{
    // Initialize the flag to false.
    nonNumberEntered = false;

    // Determine whether the keystroke is a number from the top of the
 keyboard.
    if (e.KeyCode < Keys.D0 || e.KeyCode > Keys.D9)
    {
        // Determine whether the keystroke is a number from the keypad.
        if (e.KeyCode < Keys.NumPad0 || e.KeyCode > Keys.NumPad9)
        {
            // Determine whether the keystroke is a backspace.
            if(e.KeyCode != Keys.Back)
            {
                // A non-numerical keystroke was pressed.
                // Set the flag to true and evaluate in KeyPress event.
                nonNumberEntered = true;
            }
        }
    }
}

// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
private void textBox1_KeyPress(object sender,
 System.Windows.Forms.KeyPressEventArgs e)
{
    // Check for the flag being set in the KeyDown event.
    if (nonNumberEntered == true)
    {
        // Stop the character from being entered into the control since
 it is non-numerical.
        e.Handled = true;
    }
}

C++

   // Boolean flag used to determine when a character other than a number
 is entered.
private:
   bool nonNumberEntered;

   // Handle the KeyDown event to determine the type of character entered
 into the control.
   void textBox1_KeyDown( Object^ /*sender*/, System::Windows::Forms::KeyEventArgs^
 e )
   {
      // Initialize the flag to false.
      nonNumberEntered = false;

      // Determine whether the keystroke is a number from the top of the
 keyboard.
      if ( e->KeyCode < Keys::D0 || e->KeyCode > Keys::D9
 )
      {
         // Determine whether the keystroke is a number from the keypad.
         if ( e->KeyCode < Keys::NumPad0 || e->KeyCode
 > Keys::NumPad9 )
         {
            // Determine whether the keystroke is a backspace.
            if ( e->KeyCode != Keys::Back )
            {
               // A non-numerical keystroke was pressed.
               // Set the flag to true and evaluate in KeyPress event.
               nonNumberEntered = true;
            }
         }
      }
   }

   // This event occurs after the KeyDown event and can be used to prevent
   // characters from entering the control.
   void textBox1_KeyPress( Object^ /*sender*/, System::Windows::Forms::KeyPressEventArgs^
 e )
   {
      // Check for the flag being set in the KeyDown event.
      if ( nonNumberEntered == true )
      {         // Stop the character from being entered into the control since
 it is non-numerical.
         e->Handled = true;
      }
   }

J#

// Boolean flag used to determine when a character other than a number
 
// is entered.
private boolean nonNumberEntered = false;

// Handle the KeyDown event to determine the type of character entered
 
// into the control.
private void textBox1_KeyDown(Object sender,
 
    System.Windows.Forms.KeyEventArgs e)
{
    // Initialize the flag to false.
    nonNumberEntered = false;

    // Determine whether the keystroke is a number from the top of the
 
    // keyboard.
    if ((e.get_KeyCode().CompareTo(Keys.D0)) < 0 
        || (e.get_KeyCode().CompareTo(Keys.D9) > 0)) {

        // Determine whether the keystroke is a number from the keypad.
        if ((e.get_KeyCode().CompareTo(Keys.NumPad0) < 0 
            || (e.get_KeyCode().CompareTo(Keys.NumPad9)) > 0)) {

            // Determine whether the keystroke is a backspace.
            if (!(e.get_KeyCode().Equals(Keys.Back))) {
                    // A non-numerical keystroke was pressed.
                    // Set the flag to true and evaluate in KeyPress
 event.
                    nonNumberEntered = true;
            }
        }
    }
} //textBox1_KeyDown

// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
private void textBox1_KeyPress(Object sender,
 System.Windows.Forms.
    KeyPressEventArgs e)
{
    // Check for the flag being set in the KeyDown event.
    if (nonNumberEntered == true) {
        // Stop the character from being entered into the control since
 
        // it is non-numerical.
        e.set_Handled(true);
    }
} //textBox1_KeyPress

継承階層

System.Object
   System.EventArgs
    System.Windows.Forms.KeyEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
KeyEventArgs メンバ
System.Windows.Forms 名前空間
OnKeyDown
Control.KeyDown イベント
OnKeyUp
Control.KeyUp イベント
KeyPressEventArgs
OnKeyPress
Control.KeyPress イベント

KeyEventArgs コンストラクタ

KeyEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    keyData As Keys _
)

Visual Basic (使用法)

Dim keyData As Keys

Dim instance As New KeyEventArgs(keyData)

C#

public KeyEventArgs (
    Keys keyData
)

C++

public:
KeyEventArgs (
    Keys keyData
)

J#

public KeyEventArgs (
    Keys keyData
)

JScript

public function KeyEventArgs (
    keyData : Keys
)

パラメータ

keyData

押されたキーを表す Keys。これには、同時に押されたキーが Ctrl キー、Shift キー、Alt キーのいずれであるかを示す修飾フラグが組み合わされます。この値は、Keys 列挙体の定数にビット単位の OR (|) 演算を適用した値になります。

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
KeyEventArgs クラス
KeyEventArgs メンバ
System.Windows.Forms 名前空間
KeyPressEventArgs

KeyEventArgs プロパティ

パブリック プロパティ

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

参照

関連項目

KeyEventArgs クラス
System.Windows.Forms 名前空間
OnKeyDown
Control.KeyDown イベント
OnKeyUp
Control.KeyUp イベント
KeyPressEventArgs
OnKeyPress
Control.KeyPress イベント

KeyEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

KeyEventArgs クラス
System.Windows.Forms 名前空間
OnKeyDown
Control.KeyDown イベント
OnKeyUp
Control.KeyUp イベント
KeyPressEventArgs
OnKeyPress
Control.KeyPress イベント

KeyEventArgs メンバ

KeyDown イベントまたは KeyUp イベントのデータを提供します。

KeyEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	KeyEventArgs	KeyEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

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

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

KeyEventArgs クラス
System.Windows.Forms 名前空間
OnKeyDown
Control.KeyDown イベント
OnKeyUp
Control.KeyUp イベント
KeyPressEventArgs
OnKeyPress
Control.KeyPress イベント