StripMnemonics Method

Strips mnemonics from a string.

Syntax

Visual Basic

'Declaration
 
Public Shared Function StripMnemonics( _
   ByVal text As String, _
   ByVal escapeRemainingMnemonics As Boolean _
) As String

C#

public static string StripMnemonics( 
   string text,
   bool escapeRemainingMnemonics
)

Parameters

text

A string that may contain one or more mnemonic characters.

escapeRemainingMnemonics

True if any subsequent mnemonics should be escaped (if not already escaped by a preceeding '_'). This should be true if this will be assigned to an AccessText element (or a ContentPresenter whose RecognizesAccessKey is true) so that no character will be rendered as a mnemonic. This should be false to provide the behavior where the text appears as it would in an AccessText when the underline under the leading mnemonic is not rendered.

Return Value

A new string with those mnemonics stripped out or the passed in string if it didn't contain any.

Remarks

A mnemonic, or accelerator, character is defined as a character that has a single underscore ('_') preceding it.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2