StringFormat ::GetHotkeyPrefix, méthode (gdiplusstringformat.h)

La méthode StringFormat ::GetHotkeyPrefix obtient un élément de l’énumération HotkeyPrefix qui indique le type de traitement effectué sur une chaîne lorsqu’un préfixe de touche chaude, un ampersand (&) est rencontré.

Syntaxe

HotkeyPrefix GetHotkeyPrefix();

Valeur de retour

Type : HotkeyPrefix

Cette méthode retourne un élément de l’énumération HotkeyPrefix qui indique le type de traitement du préfixe de clé chaude effectué sur une chaîne.

Remarques

Les touches d’accès, également appelées touches d’accès, sont des touches qui sont programmées pour fournir à un utilisateur final des raccourcis clavier vers les fonctionnalités et qui sont activées en appuyant sur la touche ALT. Les clés dépendent de l’application et sont identifiées par une lettre soulignée, généralement dans un nom de menu ou un élément de menu ; par exemple, lorsque vous appuyez sur ALT, la lettre F du menu Fichier est soulignée. La touche F est un raccourci permettant d’afficher le menu Fichier .

Un programmeur client désigne une clé chaude dans une application en utilisant le préfixe de touche chaude, un ampersand (&), dans une chaîne qui s’affiche généralement comme nom d’un menu ou d’un élément d’un menu et en utilisant la méthode StringFormat ::SetHotkeyPrefix pour définir le type de traitement approprié. Lorsqu’un caractère d’une chaîne est précédé d’une esperluette, la clé qui correspond au caractère devient une touche chaude pendant le traitement qui se produit lorsque la chaîne est dessinée sur l’appareil d’affichage. L’ampersand est appelé préfixe de touche chaude, car il précède le caractère à activer. Si HotkeyPrefixNone est passé à StringFormat ::SetHotkeyPrefix, aucun traitement des préfixes de touches chaudes ne se produit.

Note Le terme de clé d’accès est ici synonyme de clé d’accès. Le terme de clé d’accès rapide peut avoir une signification différente dans d’autres API Windows.

 

Exemples

L’exemple suivant crée un objet StringFormat , définit le type de traitement du préfixe de clé chaude à effectuer sur la chaîne, puis obtient le type de traitement et le stocke dans une variable. Le code crée ensuite un deuxième objet StringFormat et utilise la valeur stockée pour définir le type de traitement du préfixe de clé chaude pour le deuxième objet StringFormat . Le code utilise le deuxième objet StringFormat pour dessiner une chaîne qui contient le caractère de préfixe de clé chaude. Le code dessine également le rectangle de disposition de la chaîne.

VOID Example_GetHotkeyPrefix(HDC hdc)
{
   Graphics graphics(hdc);

   SolidBrush  solidBrush(Color(255, 255, 0, 0)); 
   FontFamily  fontFamily(L"Times New Roman");
   Font        font(&fontFamily, 24, FontStyleRegular, UnitPixel);
   
   // Create a StringFormat object, and set its hot key prefix.
   StringFormat stringFormat;
   stringFormat.SetHotkeyPrefix(HotkeyPrefixShow);

   // Get the hot key prefix from the StringFormat object.
   HotkeyPrefix hotkeyPrefix = stringFormat.GetHotkeyPrefix();

   // Create a second StringFormat object with the same hot key prefix.
   StringFormat stringFormat2;
   stringFormat2.SetHotkeyPrefix(hotkeyPrefix);

   // Use the second StringFormat object in a call to DrawString.
  graphics.DrawString(
      L"This &text has some &underlined characters.", 
      43,  // string length
      &font, 
      RectF(30, 30, 160, 200), 
      &stringFormat2, 
      &solidBrush);

   // Draw the rectangle that encloses the text.
   Pen pen(Color(255, 255, 0, 0));
   graphics.DrawRectangle(&pen, 30, 30, 160, 200);
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP, Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	gdiplusstringformat.h (inclure Gdiplus.h)
Bibliothèque	Gdiplus.lib
DLL	Gdiplus.dll

Voir aussi

HotkeyPrefix

StringFormat