Partager via


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

La méthode StringFormat ::SetHotkeyPrefix définit le type de traitement effectué sur une chaîne lorsque le préfixe de touche rapide, une esperluette (&), est rencontré. L’esperluette est appelé préfixe de touche à chaud et peut être utilisé pour désigner certaines clés en tant que touches chaudes.

Syntaxe

Status SetHotkeyPrefix(
  [in] HotkeyPrefix hotkeyPrefix
);

Paramètres

[in] hotkeyPrefix

Type : HotkeyPrefix

Élément de l’énumération HotkeyPrefix qui spécifie comment traiter le préfixe de touche rapide.

Valeur retournée

Type : État

Si la méthode réussit, elle retourne Ok, qui est un élément de l’énumération Status .

Si la méthode échoue, elle retourne l’un des autres éléments de l’énumération Status .

Remarques

Les touches d’accès rapide, également appelées touches d’accès, sont des touches qui sont programmées pour fournir à l’utilisateur final des raccourcis clavier vers la fonctionnalité et qui sont activées en appuyant sur la touche ALT. Les touches 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 touche d’accès rapide dans une application à l’aide du préfixe de touche rapide, une esperluette (&), 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 touche qui correspond au caractère devient une touche d’accès rapide pendant le traitement qui se produit lorsque la chaîne est dessinée sur le périphérique d’affichage. L’esperluette est appelé préfixe de touche d’accès rapide, car il précède le caractère à activer. Si HotkeyPrefixNone est passé à StringFormat ::SetHotkeyPrefix, aucun traitement du préfixe de touche rapide n’a lieu.

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

Exemples

L’exemple suivant crée un objet StringFormat et définit le type de traitement de préfixe par touche rapide à effectuer sur la chaîne. Le code utilise ensuite l’objet StringFormat pour dessiner une chaîne qui contient le caractère de préfixe de touche rapide. Le code dessine également le rectangle de disposition de la chaîne.

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

   SolidBrush  solidBrush(Color(255, 255, 0, 0)); 
   FontFamily  fontFamily(L"Times New Roman");
   Font        font(&fontFamily, 24, FontStyleRegular, UnitPixel);
   
   StringFormat stringFormat;
   stringFormat.SetHotkeyPrefix(HotkeyPrefixShow);

   graphics.DrawString(
      L"This &text has some &underlined characters.", 
      43,  // string length
      &font, 
      RectF(30, 30, 160, 200), 
      &stringFormat, 
      &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

StringFormat ::GetHotkeyPrefix