Control.IsMnemonic Method (Char, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

Public Shared Function IsMnemonic (
	charCode As Char,
	text As String
) As Boolean

Parameters

charCode
Type: System.Char

The character to test.

text
Type: System.String

The string to search.

Return Value

Type: System.Boolean

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

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

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.

' 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.
    <System.Security.Permissions.UIPermission( _
    System.Security.Permissions.SecurityAction.Demand, Window:=UIPermissionWindow.AllWindows)> _
    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

UIPermission

for all windows for inheriting classes to call this method. Associated enumeration: AllWindows value of UIPermissionWindow.

.NET Framework
Available since 1.1
Return to top
Show: