Control.IsKeyLocked(Keys) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

Control.cs

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

public:
 static bool IsKeyLocked(System::Windows::Forms::Keys keyVal);

public static bool IsKeyLocked (System.Windows.Forms.Keys keyVal);

static member IsKeyLocked : System.Windows.Forms.Keys -> bool

Public Shared Function IsKeyLocked (keyVal As Keys) As Boolean

Parameters

keyVal

Keys

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

Returns

Boolean

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

Exceptions

NotSupportedException

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

Examples

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

#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." );
   }

}

using System;
using System.Windows.Forms;

public class CapsLockIndicator
{
    public static void Main()
    {
        if (Control.IsKeyLocked(Keys.CapsLock)) {
            MessageBox.Show("The Caps Lock key is ON.");
        }
        else {
            MessageBox.Show("The Caps Lock key is OFF.");
        }
    }
}

' To compile and run this sample from the command line, proceed as follows:
' vbc controliskeylocked.vb /r:System.Windows.Forms.dll /r:System.dll 
' /r:System.Data.dll /r:System.Drawing.dll

Imports System.Windows.Forms

Public Class CapsLockIndicator
   
    Public Shared Sub Main()
        if Control.IsKeyLocked(Keys.CapsLock) Then
            MessageBox.Show("The Caps Lock key is ON.")
        Else
            MessageBox.Show("The Caps Lock key is OFF.")
        End If
    End Sub
End Class

Remarks

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