Export (0) Print
Expand All
Expand Minimize

Control.ProcessMnemonic Method

Processes a mnemonic character.

[Visual Basic]
Protected Overridable Function ProcessMnemonic( _
   ByVal charCode As Char _
) As Boolean
[C#]
protected virtual bool ProcessMnemonic(
 char charCode
);
[C++]
protected: virtual bool ProcessMnemonic(
 __wchar_t charCode
);
[JScript]
protected function ProcessMnemonic(
   charCode : Char
) : Boolean;

Parameters

charCode
The character to process.

Return Value

true if the character was processed as a mnemonic by the control; otherwise, false.

Remarks

This method is called to give a control the opportunity to process a mnemonic character. The method should determine whether the control is in a state to process mnemonics and if whether the given character represents a mnemonic. If so, the method should perform the action associated with the mnemonic and return true. If not, the method should return false. Implementations of this method often use the IsMnemonic method to determine whether the given character matches a mnemonic in the control's text.

For example:

[C#] 
if (CanSelect && IsMnemonic(charCode, MyControl.Text) {
     // Perform action associated with mnemonic.
      }

This default implementation of the ProcessMnemonic method simply returns false to indicate that the control has no mnemonic.

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 | IsMnemonic | ProcessDialogChar

Show:
© 2014 Microsoft