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

O método StringFormat::SetHotkeyPrefix define o tipo de processamento que é executado em uma cadeia de caracteres quando o prefixo de tecla frequente, um e comercial (&), é encontrado. O e comercial é chamado de prefixo de tecla de acesso frequente e pode ser usado para designar determinadas chaves como teclas de acesso.

Sintaxe

Status SetHotkeyPrefix(
  [in] HotkeyPrefix hotkeyPrefix
);

Parâmetros

[in] hotkeyPrefix

Tipo: HotkeyPrefix

Elemento da enumeração HotkeyPrefix que especifica como processar o prefixo de tecla frequente.

Retornar valor

Tipo: Status

Se o método for bem-sucedido, ele retornará Ok, que é um elemento da enumeração Status .

Se o método falhar, ele retornará um dos outros elementos da enumeração Status .

Comentários

Teclas de acesso, também chamadas de teclas de acesso, são teclas programadas para fornecer a um usuário final atalhos de teclado para a funcionalidade e são ativadas pressionando a tecla ALT. As chaves são dependentes do aplicativo e são identificadas por uma letra sublinhada, normalmente em um nome de menu ou item de menu; por exemplo, quando você pressiona ALT, a letra F do menu Arquivo é sublinhada. A tecla F é um atalho para exibir o menu Arquivo .

Um programador cliente designa uma tecla de acesso em um aplicativo usando o prefixo de tecla frequente, um e comercial (&), em uma cadeia de caracteres que normalmente é exibida como o nome de um menu ou um item em um menu e usando o método StringFormat::SetHotkeyPrefix para definir o tipo apropriado de processamento. Quando um caractere em uma cadeia de caracteres é precedido por um e comercial, a chave que corresponde ao caractere se torna uma tecla dinâmica durante o processamento que ocorre quando a cadeia de caracteres é desenhada no dispositivo de exibição. O e comercial é chamado de prefixo de tecla de acesso frequente porque precede o caractere a ser ativado. Se HotkeyPrefixNone for passado para StringFormat::SetHotkeyPrefix, nenhum processamento do prefixo de tecla frequente ocorrerá.

Nota O termo hot key é usado como sinônimo aqui com o termo chave de acesso. O termo hot key pode ter um significado diferente em outras APIs do Windows.

 

Exemplos

O exemplo a seguir cria um objeto StringFormat e define o tipo de processamento de prefixo de tecla frequente a ser executado na cadeia de caracteres. Em seguida, o código usa o objeto StringFormat para desenhar uma cadeia de caracteres que contém o caractere de prefixo de tecla frequente. O código também desenha o retângulo de layout da cadeia de caracteres.

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	Valor
Cliente mínimo com suporte	Windows XP, Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	gdiplusstringformat.h (inclua Gdiplus.h)
Biblioteca	Gdiplus.lib
DLL	Gdiplus.dll

Confira também

Hotkeyprefix

StringFormat

StringFormat::GetHotkeyPrefix