This documentation is archived and is not being maintained.

Control.IsMnemonic Method

Determines if the specified character is the mnemonic character assigned to the control in the specified string.

[Visual Basic]
Public Shared Function IsMnemonic( _
   ByVal charCode As Char, _
   ByVal text As String _
) As Boolean
[C#]
public static bool IsMnemonic(
 char charCode,
 string text
);
[C++]
public: static bool IsMnemonic(
 __wchar_t charCode,
 String* text
);
[JScript]
public static function IsMnemonic(
   charCode : Char,
 text : String
) : Boolean;

Parameters

charCode
The character to test.
text
The string to search.

Return Value

true if the charCode character is the mnemonic character assigned to the control; otherwise, false.

Remarks

The mnemonic character is the character immediately following the first instance of "&" in a String.

Example

[Visual Basic, C#] The following code example demonstrates an extension of the button class that overrides the ProcessMnemonic method to exhibit custom behavior. The example also demonstrates the use of the CanSelect and IsMnemonic properties. To run this example paste the following code after a form class, in the same file. Add a button of type MnemonicButton to the form.

[Visual Basic] 
' This button is a simple extension of the button class that overrides
' the ProcessMnemonic method.  If the mnemonic is correctly entered,  
' the message box will appear and the click event will be raised.  
Public Class MyMnemonicButton
    Inherits Button

    ' This method makes sure the control is selectable and the 
    ' mneumonic is correct before displaying the message box
    ' and triggering the click event.
    Protected Overrides Function ProcessMnemonic( _
        ByVal inputChar As Char) As Boolean

        If (CanSelect And IsMnemonic(inputChar, Me.Text)) Then
            MessageBox.Show("You've raised the click event " _
                & "using the mnemonic.")
            Me.PerformClick()
            Return True
        End If
        Return False
    End Function

End Class

[C#] 
// This button is a simple extension of the button class that overrides
// the ProcessMnemonic method.  If the mnemonic is correctly entered,  
// the message box will appear and the click event will be raised.  
public class MyMnemonicButton:
    Button

    // This method makes sure the control is selectable and the 
    // mneumonic is correct before displaying the message box
    // and triggering the click event.
{
    protected override bool ProcessMnemonic(char inputChar)
    {

        if (CanSelect&&IsMnemonic(inputChar, this.Text))
        {
            MessageBox.Show("You've raised the click event " +
                "using the mnemonic.");
            this.PerformClick();
            return true;
        }
        return false;
    }

}

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic 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 Framework Security: 

See Also

Control Class | Control Members | System.Windows.Forms Namespace | ProcessMnemonic

Show: