StringFormat::SetHotkeyPrefix-Methode (gdiplusstringformat.h)

Artikel
01/10/2024

Die StringFormat::SetHotkeyPrefix-Methode legt den Verarbeitungstyp fest, der für eine Zeichenfolge ausgeführt wird, wenn das Präfix für den Heißen Schlüssel, ein ampersand (&), gefunden wird. Das Amper- und -Zeichen wird als Hot key-Präfix bezeichnet und kann verwendet werden, um bestimmte Schlüssel als Hot keys zu kennzeichnen.

Syntax

Status SetHotkeyPrefix(
  [in] HotkeyPrefix hotkeyPrefix
);

Parameter

[in] hotkeyPrefix

Typ: HotkeyPrefix

Element der HotkeyPrefix-Enumeration , das angibt, wie das Präfix für den Heißschlüssel verarbeitet werden soll.

Rückgabewert

Typ: Status

Wenn die Methode erfolgreich ist, gibt sie OK zurück, ein Element der Status-Enumeration .

Wenn die Methode fehlschlägt, wird eines der anderen Elemente der Status-Enumeration zurückgegeben.

Hinweise

Tastenkombinationen, auch Zugriffstasten genannt, sind Tasten, die so programmiert sind, dass ein Endbenutzer Tastenkombinationen für die Funktionalität bereitstellt und die durch Drücken der ALT-TASTE aktiviert werden. Die Schlüssel sind anwendungsabhängig und werden durch einen unterstrichenen Buchstaben identifiziert, in der Regel in einem Menünamen oder Menüelement. Wenn Sie z. B. ALT drücken, wird der Buchstabe F des Menüs Datei unterstrichen. Die F-Taste ist eine Verknüpfung zum Anzeigen des Menüs Datei .

Ein Clientprogrammierer bestimmt einen Hot key in einer Anwendung mithilfe des Präfixes "ampersand" (&) in einer Zeichenfolge, die in der Regel als Name eines Menüs oder Elements in einem Menü angezeigt wird, und indem er die StringFormat::SetHotkeyPrefix-Methode verwendet, um den entsprechenden Verarbeitungstyp festzulegen. Wenn einem Zeichen in einer Zeichenfolge ein ampersand vorangestellt wird, wird der Schlüssel, der dem Zeichen entspricht, während der Verarbeitung, die auftritt, wenn die Zeichenfolge auf dem Anzeigegerät gezeichnet wird, zu einer Schlüsseltaste. Das Amper- und -Zeichen wird als Präfix mit heißer Taste bezeichnet, da es dem zu aktivierenden Zeichen vorangestellt ist. Wenn HotkeyPrefixNone an StringFormat::SetHotkeyPrefix übergeben wird, erfolgt keine Verarbeitung des Präfixes für den Heißen Schlüssel.

Hinweis Der Begriff Hot Key wird hier synonym mit dem Begriff Zugriffsschlüssel verwendet. Der Begriff hot key kann in anderen Windows-APIs eine andere Bedeutung haben.

Beispiele

Im folgenden Beispiel wird ein StringFormat-Objekt erstellt und der Typ der Präfixverarbeitung für die Zeichenfolge festgelegt. Der Code verwendet dann das StringFormat-Objekt , um eine Zeichenfolge zu zeichnen, die das Präfixzeichen des Heißschlüssels enthält. Der Code zeichnet auch das Layoutrechteck der Zeichenfolge.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP, Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	gdiplusstringformat.h (include Gdiplus.h)
Bibliothek	Gdiplus.lib
DLL	Gdiplus.dll

Weitere Informationen

Hotkeyprefix

StringFormat

StringFormat::GetHotkeyPrefix

Share via