CHARFORMATA-Struktur (richedit.h)

Artikel
08/15/2024

Enthält Informationen zur Zeichenformatierung in einem Rich-Edit-Steuerelement.

Rich Edit 2.0: Die CHARFORMAT2-Struktur ist eine Microsoft Rich Edit 2.0-Erweiterung der CHARFORMAT- Struktur. Mit Microsoft Rich Edit 2.0 und höher können Sie eine der beiden Strukturen mit den EM_GETCHARFORMAT und EM_SETCHARFORMAT Nachrichten verwenden.

Syntax

typedef struct _charformat {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  char     szFaceName[LF_FACESIZE];
} CHARFORMATA;

Angehörige

cbSize

Typ: UINT-

Größe in Byte der angegebenen Struktur. Dieses Element muss festgelegt werden, bevor die Struktur an das Rich-Edit-Steuerelement übergeben wird.

dwMask

Typ: DWORD-

Elemente, die gültige Informationen oder Attribute enthalten, die festgelegt werden sollen. Dieses Element kann null, eins oder mehrere der folgenden Werte sein.

Wert	Bedeutung
CFM_ALL	Windows 8: Eine Kombination der folgenden Werte: CFM_EFFECTS \| CFM_SIZE \| CFM_FACE \| CFM_OFFSET \| CFM_CHARSET
CFM_BOLD	Der CFE_BOLD Wert des dwEffects Member ist gültig.
CFM_CHARSET	Das bCharSet Member ist gültig.
CFM_COLOR	Das crTextColor-Element und der CFE_AUTOCOLOR Wert des dwEffects Members sind gültig.
CFM_EFFECTS	Windows 8: Eine Kombination der folgenden Werte: CFM_BOLD \| CFM_ITALIC \| CFM_UNDERLINE \| CFM_COLOR \| CFM_STRIKEOUT \| CFE_PROTECTED \| CFM_LINK
CFM_FACE	Das szFaceName Member ist gültig.
CFM_ITALIC	Der CFE_ITALIC Wert des dwEffects Members ist gültig.
CFM_OFFSET	Das yOffset Member ist gültig.
CFM_PROTECTED	Der CFE_PROTECTED Wert des dwEffects Members ist gültig.
CFM_SIZE	Das yHeight Member ist gültig.
CFM_STRIKEOUT	Der CFE_STRIKEOUT Wert des dwEffects Member ist gültig.
CFM_UNDERLINE.	Der CFE_UNDERLINE Wert des dwEffects Member ist gültig.

dwEffects

Typ: DWORD-

Zeicheneffekte. Dieses Element kann eine Kombination aus den folgenden Werten sein.

Wert	Bedeutung
CFE_AUTOCOLOR	Die Textfarbe ist der Rückgabewert von GetSysColor-(COLOR_WINDOWTEXT).
CFE_BOLD	Zeichen sind fett formatiert.
CFE_DISABLED	RichEdit 2.0 und höher: Zeichen werden mit einem Schatten angezeigt, der um 3/4 Punkt oder ein Pixel versetzt wird, je nachdem, welcher Wert größer ist.
CFE_ITALIC	Zeichen sind kursiv.
CFE_STRIKEOUT	Zeichen werden getroffen.
CFE_UNDERLINE	Zeichen werden unterstrichen.
CFE_PROTECTED	Zeichen sind geschützt; Ein Versuch, sie zu ändern, führt zu einem EN_PROTECTED Benachrichtigungscode.

yHeight

Typ: LONG

Zeichenhöhe in Twips (1/1440 zoll oder 1/20 des Druckerpunkts).

yOffset

Typ: LONG

Zeichenoffset in Twips von der Basislinie. Wenn der Wert dieses Elements positiv ist, ist das Zeichen hochgestellt; wenn es negativ ist, ist das Zeichen ein Tiefgestellt.

crTextColor

Typ: COLORREF-

Textfarbe. Dieses Element wird ignoriert, wenn der CFE_AUTOCOLOR Zeicheneffekt angegeben wird. Verwenden Sie zum Generieren eines COLORREF-das RGB- Makro.

bCharSet

Typ: BYTE-

Zeichensatzwert. Das bCharSet--Element kann einer der für das lfCharSet Member der LOGFONT- Struktur angegebenen Werte sein. Microsoft Rich Edit 3.0 kann diesen Wert außer Kraft setzen, wenn er für die Zielzeichen ungültig ist.

bPitchAndFamily

Typ: BYTE-

Schriftfamilie und Schriftbreite. Dieses Element ist identisch mit dem lfPitchAndFamily Mitglied der LOGFONT Struktur.

szFaceName[LF_FACESIZE]

Typ: TCHAR[LF_FACESIZE]

Null-beendetes Zeichenarray, das den Schriftartnamen angibt.

Bemerkungen

Um ein Formatierungsattribut zu deaktivieren, legen Sie den entsprechenden Wert in dwMask- fest, legen aber nicht den entsprechenden Wert in dwEffectsfest. Wenn Sie z. B. Kursiv deaktivieren möchten, legen Sie CFM_ITALIC fest, legen sie jedoch nicht CFE_ITALIC fest.

Anmerkung

Der Richedit.h-Header definiert CHARFORMAT als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows Vista [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Header-	richedit.h

Siehe auch

Referenz

Freigeben über