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

El método StringFormat::SetHotkeyPrefix establece el tipo de procesamiento que se realiza en una cadena cuando se encuentra el prefijo de clave activa, una y comercial (&). La y comercial se denomina prefijo de clave activa y se puede usar para designar determinadas claves como teclas de acceso rápido.

Sintaxis

Status SetHotkeyPrefix(
  [in] HotkeyPrefix hotkeyPrefix
);

Parámetros

[in] hotkeyPrefix

Tipo: HotkeyPrefix

Elemento de la enumeración HotkeyPrefix que especifica cómo procesar el prefijo de clave activa.

Valor devuelto

Tipo: Estado

Si el método se ejecuta correctamente, devuelve Ok, que es un elemento de la enumeración Status .

Si se produce un error en el método, devuelve uno de los otros elementos de la enumeración Status .

Comentarios

Las teclas de acceso frecuente, 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 de subrayado, 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 tecla 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 está precedido de una y comercial, la tecla 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 del prefijo de clave activa.

Nota El término clave de acceso rápido se usa aquí como sinónimo del 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 y se establece el tipo de procesamiento de prefijos de clave activa que se realizará en la cadena. A continuación, el código usa el objeto StringFormat para dibujar una cadena que contiene 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_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);
}

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

StringFormat::GetHotkeyPrefix