Accelerator Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Utilities
Assembly:
Microsoft.VisualStudio.Utilities.dll
Package:
Microsoft.VisualStudio.Utilities v17.11.40262

Utility methods for dealing with keyboard accelerators.

public ref class Accelerator abstract sealed
public ref class Accelerator abstract sealed
class Accelerator abstract sealed
public static class Accelerator
type Accelerator = class
Public Class Accelerator
Inheritance
Object
Accelerator

Methods

AccessKeySpecifierFromObject(Object)

Converts the input object into an access key specifier. Objects of type char or single-character strings can be converted. If an object of a different type is passed in, & is returned.
StripAccelerators(String, Char)

Strips non-escaped accelerator markers from the given string using the same algorithm used by MsoPwchStripWtz (bugs and all), to wit:

Strip odd chars that match accessSpecifier from the string. As per DrawText, consecutive pairs of characters matching accessSpecifier will leave a single character matching accessSpecifier, and all odd characters matching accessSpecifier are removed even though only the last may be underlined.

If a character matching accessSpecifier occurs inside of parens then the parens and the character following the accessSpecifier matching character are also stripped out. This is useful to remove accelarator strings of format (%accessSpecifier%N) which are appended to label in some FE language versions.

NOTE: We do not check for language to do this i.e. we assume that there isn't any realistic label in other languages with (%accessSpecifier%N) stuck in.

StripAccelerators(String, Object)

Returns the input string with the specified access key specifier stripped
StripAccelerators(String)

Strips non-escaped accelerator markers ('&') from the given string using the same algorithm used by MsoPwchStripWtz (bugs and all), to wit:

Strip odd '&' chars from the string. As per DrawText, consecutive pairs of '&'s will leave a real '&' character, and all odd '&'s are removed even though only the last may be underlined.

If an '&' occurs inside of parens then the parens and the character following the '&' are also stripped out. This is useful to remove accelarator strings of format (&N) which are appended to label in some FE language versions.

NOTE: We do not check for language to do this i.e. we assume that there isn't any realistic label in other languages with (&N) stuck in.

Applies to