Método StringFormat::GetHotkeyPrefix (gdiplusstringformat.h)

El método StringFormat::GetHotkeyPrefix obtiene un elemento de la enumeración HotkeyPrefix que indica el tipo de procesamiento que se realiza en una cadena cuando se encuentra un prefijo de clave activa, una y comercial (&).

Sintaxis

HotkeyPrefix GetHotkeyPrefix();

Valor devuelto

Tipo: HotkeyPrefix

Este método devuelve un elemento de la enumeración HotkeyPrefix que indica el tipo de procesamiento de prefijos de clave activa que se realiza en una cadena.

Comentarios

Las teclas de acceso, también llamadas teclas de acceso, son teclas programadas para proporcionar a un usuario final métodos abreviados de teclado para la funcionalidad y se activan presionando la tecla ALT. Las claves dependen de la aplicación y se identifican mediante una letra subrayada, normalmente en un nombre de menú o elemento de menú; por ejemplo, al presionar ALT, se subraya la letra F del menú Archivo . La tecla F es un acceso directo para mostrar el menú Archivo .

Un programador cliente designa una clave activa en una aplicación mediante el prefijo de clave activa, una y comercial (&), en una cadena que normalmente se muestra como el nombre de un menú o un elemento de un menú y mediante el método StringFormat::SetHotkeyPrefix para establecer el tipo de procesamiento adecuado. Cuando un carácter de una cadena va precedido de una y comercial, la clave que corresponde al carácter se convierte en una tecla activa durante el procesamiento que se produce cuando la cadena se dibuja en el dispositivo de visualización. La y comercial se denomina prefijo de tecla activa porque precede al carácter que se va a activar. Si HotkeyPrefixNone se pasa a StringFormat::SetHotkeyPrefix, no se produce ningún procesamiento de prefijos de clave activa.

Nota El término clave activa se usa como sinónimo de aquí con el término clave de acceso. El término clave activa puede tener un significado diferente en otras API de Windows.

 

Ejemplos

En el ejemplo siguiente se crea un objeto StringFormat , se establece el tipo de procesamiento de prefijos de clave activa que se realizará en la cadena y, a continuación, obtiene el tipo de procesamiento y lo almacena en una variable. A continuación, el código crea un segundo objeto StringFormat y usa el valor almacenado para establecer el tipo de procesamiento de prefijos de clave activa para el segundo objeto StringFormat . El código usa el segundo objeto StringFormat para dibujar una cadena que contenga el carácter de prefijo de tecla activa. El código también dibuja el rectángulo de diseño de la cadena.

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);
}

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP, Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	gdiplusstringformat.h (include Gdiplus.h)
Library	Gdiplus.lib
Archivo DLL	Gdiplus.dll

Consulte también

HotkeyPrefix

StringFormat