Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

KeyEventArgs.Modifiers Property

Gets the modifier flags for a KeyDown or KeyUp event. This indicates which combination of modifier keys (CTRL, SHIFT, and ALT) were pressed.

[Visual Basic]
Public ReadOnly Property Modifiers As Keys
[C#]
public Keys Modifiers {get;}
[C++]
public: __property Keys get_Modifiers();
[JScript]
public function get Modifiers() : Keys;

Property Value

A Keys value representing one or more modifier flags.

Remarks

To determine whether a specific modifier key was pressed, use the Control, Shift, and Alt properties. Modifier flags can be combined with bitwise OR.

Example

[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 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 TextBox control, named textBox1, has been added to the form and its KeyDown
' event has been contected to this event handling 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 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.", 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, S"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, S"Enter your first name followed by your last name. Middle name is optional.",
         Point(textBox1->Top, this->textBox1->Left));
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

KeyEventArgs Class | KeyEventArgs Members | System.Windows.Forms Namespace | Alt | Control | Shift | Control.ModifierKeys

Show:
© 2015 Microsoft