Windows apps
Collapse the table of content
Expand the table of content
Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Control::IsKeyLocked Method (Keys)

.NET Framework (current version)
 

Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

C#
C++
F#
VB
Copy 
public:
static bool IsKeyLocked(
	Keys keyVal
)

Parameters

keyVal
Type: System.Windows.Forms::Keys

The CAPS LOCK, NUM LOCK, or SCROLL LOCK member of the Keys enumeration.

Return Value

Type: System::Boolean

true if the specified key or keys are in effect; otherwise, false.

Exception Condition
NotSupportedException

The keyVal parameter refers to a key other than the CAPS LOCK, NUM LOCK, or SCROLL LOCK key.

Use the IsKeyLocked property to determine whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK keys are on, whether individually or in combination.

The following code example displays a message box indicating whether the specified key (the Caps Lock key in this case) is in effect.

C#
C++
VB
Copy 
#using <System.dll>
#using <System.Drawing.dll>
#using <System.Windows.Forms.dll>

using namespace System;
using namespace System::Windows::Forms;
int main()
{
   if (Control::IsKeyLocked( Keys::CapsLock )) {
      MessageBox::Show( "The Caps Lock key is ON." );
   }
   else { 
      MessageBox::Show( "The Caps Lock key is OFF." );
   }

}

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft