CHARFORMAT2W-Struktur (Rich Edit 2.0)

  • Artikel

Enthält Informationen zur Zeichenformatierung in einem umfangreichen Bearbeitungssteuerelement. CHARFORMAT2 ist eine Microsoft Rich Edit 2.0-Erweiterung der CHARFORMAT-Struktur . Mit Microsoft Rich Edit 2.0 können Sie beide Strukturen mit den EM_GETCHARFORMAT - und EM_SETCHARFORMAT-Nachrichten verwenden.

Syntax

typedef struct _charformat2w {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  WCHAR    szFaceName[LF_FACESIZE];
  WORD     wWeight;
  SHORT    sSpacing;
  COLORREF crBackColor;
  LCID     lcid;
  union {
    DWORD dwReserved;
    DWORD dwCookie;
  };
  DWORD    dwReserved;
  SHORT    sStyle;
  WORD     wKerning;
  BYTE     bUnderlineType;
  BYTE     bAnimation;
  BYTE     bRevAuthor;
  BYTE     bUnderlineColor;
} CHARFORMAT2W;

Member

cbSize

Typ: UINT

Gibt die Größe (in Bytes) der Struktur an. Bevor Sie diese Struktur an ein Rich-Edit-Steuerelement übergeben, legen Sie cbSize auf die Größe der CHARFORMAT - oder CHARFORMAT2-Struktur fest. Wenn cbSize der Größe einer CHARFORMAT-Struktur entspricht, verwendet das Steuerelement nur die CHARFORMAT-Member .

dwMask

Typ: DWORD

Gibt die Teile der CHARFORMAT2-Struktur an, die gültige Informationen enthalten. Das dwMask-Element kann eine Kombination der Werte aus zwei Sätzen von Bitflags sein. Ein Satz gibt die gültigen Strukturmember an. Ein weiterer Satz gibt die gültigen Attribute im dwEffects-Element an.

Legen Sie die folgenden Werte fest, um die gültigen Attribute des dwEffects-Elements anzugeben.

Wert Bedeutung
CFM_ALL
 Eine Kombination der folgenden Werte: CFM_EFFECTS | CFM_SIZE | CFM_FACE | CFM_OFFSET | CFM_CHARSET
CFM_ALL2
 Eine Kombination der folgenden Werte: CFM_ALL | CFM_EFFECTS2 | CFM_BACKCOLOR | CFM_LCID CFM_UNDERLINETYPE | CFM_WEIGHT | CFM_REVAUTHOR | CFM_SPACING | CFM_KERNING | | CFM_STYLE | CFM_ANIMATION | CFM_COOKIE
CFM_ALLCAPS
 Der CFE_ALLCAPS Wert ist gültig.
CFM_EFFECTS
 Eine Kombination der folgenden Werte: CFM_EFFECTS2 | CFM_FONTBOUND | CFM_EXTENDED | CFM_MATHNOBUILDUP | CFM_MATH | CFM_MATHORDINARY
CFM_BOLD
 Der CFE_BOLD Wert ist gültig.
CFM_COLOR
 Der CFE_AUTOCOLOR Wert ist gültig, oder der crTextColor-Member ist gültig.
CFM_COOKIE
 Der dwCookie-Wert ist gültig.
CFM_DISABLED
 Der CFE_DISABLED Wert ist gültig.
CFM_EXTENDED
 Der CFE_EXTENDED Wert ist gültig.
CFM_EFFECTS
 Eine Kombination der folgenden Werte: CFM_BOLD | CFM_ITALIC | CFM_UNDERLINE | CFM_COLOR CFM_STRIKEOUT | | CFE_PROTECTED | CFM_LINK
CFM_EFFECTS2
 Eine Kombination der folgenden Werte: CFM_EFFECTS | CFM_DISABLED | CFM_SMALLCAPS | CFM_ALLCAPS CFM_HIDDEN | CFM_OUTLINE | CFM_SHADOW CFM_EMBOSS | | | CFM_IMPRINT CFM_REVISED | | CFM_SUBSCRIPT | CFM_SUPERSCRIPT | CFM_BACKCOLOR
CFM_EMBOSS
 Der CFE_EMBOSS Wert ist gültig.
CFM_FONTBOUND
 Der CFE_FONTBOUND Wert ist gültig.
CFM_HIDDEN
 Der CFE_HIDDEN Wert ist gültig.
CFM_IMPRINT
 Der CFE_IMPRINT Wert ist gültig.
CFM_ITALIC
 Der CFE_ITALIC Wert ist gültig.
CFM_LINK
 Der CFE_LINK Wert ist gültig.
CFM_LINKPROTECTED
 Der CFE_LINKPROTECTED Wert ist gültig.
CFM_MATH
 Der CFE_MATH Wert ist gültig.
CFM_MATHNOBUILDUP
 Der CFE_MATHNOBUILDUP Wert ist gültig.
CFM_MATHORDINARY
 Der CFE_MATHORDINARY Wert ist gültig.
CFM_OUTLINE
 Der CFE_OUTLINE Wert ist gültig.
CFM_PROTECTED
 Der CFE_PROTECTED Wert ist gültig.
CFM_REVISED
 Der CFE_REVISION Wert ist gültig.
CFM_SHADOW
 Der CFE_SHADOW Wert ist gültig.
CFM_SMALLCAPS
 Der CFE_SMALLCAPS Wert ist gültig.
CFM_STRIKEOUT
 Der CFE_STRIKEOUT Wert ist gültig.
CFM_SUBSCRIPT
 Die werte CFE_SUBSCRIPT und CFE_SUPERSCRIPT sind gültig.
CFM_SUPERSCRIPT
 Die werte CFE_SUBSCRIPT und CFE_SUPERSCRIPT sind gültig.
CFM_UNDERLINE
 Der CFE_UNDERLINE Wert ist gültig.
 

Legen Sie die folgenden Werte fest, um die gültigen Strukturmember anzugeben.

Wert Bedeutung
CFM_ANIMATION
 Das bAnimation-Element ist gültig.
CFM_BACKCOLOR
 Das crBackColor-Element ist gültig.
CFM_CHARSET
 Das bCharSet-Element ist gültig.
CFM_COLOR
 Das crTextColor-Element ist gültig, es sei denn, das CFE_AUTOCOLOR-Flag ist im dwEffects-Element festgelegt.
CFM_FACE
 Das szFaceName-Element ist gültig.
CFM_KERNING
 Der wKerning-Member ist gültig.
CFM_LCID
 Der lcid-Member ist gültig.
CFM_OFFSET
 Das yOffset-Element ist gültig.
CFM_REVAUTHOR
 Das bRevAuthor-Element ist gültig.
CFM_SIZE
 Das yHeight-Element ist gültig.
CFM_SPACING
 Der sSpacing-Member ist gültig.
CFM_STYLE
 Das sStyle-Element ist gültig.
CFM_UNDERLINETYPE
 Das bUnderlineType-Element ist gültig.
CFM_WEIGHT
 Das wWeight-Element ist gültig.

dwEffects

Typ: DWORD

Ein Satz von Bitflags, die Zeicheneffekte angeben. Einige der Flags sind nur aus Gründen der Kompatibilität mit Microsoft Text Object Model (TOM)-Schnittstellen enthalten. Das Rich-Edit-Steuerelement speichert den Wert, verwendet ihn jedoch nicht zum Anzeigen von Text.

Dieser Member kann eine Kombination der folgenden Werte sein.

Wert Bedeutung
CFE_ALLCAPS
 Zeichen sind alle Großbuchstaben. Der Wert wirkt sich nicht auf die Art und Weise aus, wie der Text vom Steuerelement angezeigt wird. Dieser Wert gilt nur für Versionen vor Microsoft Rich Edit 3.0.
CFE_AUTOBACKCOLOR
 Die Hintergrundfarbe ist der Rückgabewert von GetSysColor(COLOR_WINDOW). Wenn dieses Flag festgelegt ist, wird das CrBackColor-Element ignoriert.
CFE_AUTOCOLOR
 Die Textfarbe ist der Rückgabewert von GetSysColor(COLOR_WINDOWTEXT). Wenn dieses Flag festgelegt ist, wird das crTextColor-Element ignoriert.
CFE_BOLD
 Die Zeichen sind fett formatiert.
CFE_DISABLED
 Zeichen werden mit einem Schatten angezeigt, der um 3/4 Punkt oder ein Pixel versetzt wird, je nachdem, welcher Wert größer ist.
CFE_EMBOSS
 Zeichen werden geprägt. Der Wert wirkt sich nicht darauf aus, wie der Text vom Steuerelement angezeigt wird.
CFE_EXTENDED
 Die Zeichen sind weniger häufige Elemente eines Skripts. Eine Schriftart, die ein Skript unterstützt, sollte überprüfen, ob sie über Glyphen für solche Zeichen verfügt.
CFE_FONTBOUND
 Schriftart wird vom Rich-Edit-Steuerelement ausgewählt, da die aktive Schriftart die Zeichen nicht unterstützt. Dieser Prozess wird als Schriftbindung bezeichnet.
CFE_HIDDEN
 Für Microsoft Rich Edit 3.0 und höher werden keine Zeichen angezeigt.
CFE_IMPRINT
 Zeichen werden als beschriftete Zeichen angezeigt. Der Wert wirkt sich nicht darauf aus, wie der Text vom Steuerelement angezeigt wird.
CFE_ITALIC
 Die Zeichen sind kursiv.
CFE_LINK
 Ein umfangreiches Bearbeitungssteuerelement kann EN_LINK Benachrichtigungscodes senden, wenn es Mausnachrichten empfängt, während der Mauszeiger über Text mit dem CFE_LINK Effekt liegt.
CFE_LINKPROTECTED
 Zeichen sind Teil eines Anzeigenamenlinks.
CFE_MATH
 Zeichen befinden sich in einer mathematischen Zone.
CFE_MATHNOBUILDUP
 Zeichen sind nicht an einem mathematischen Aufbau beteiligt. Wenn sie beispielsweise auf ein /-Element angewendet wird, wird / nicht verwendet, um einen Bruchteil zu erstellen.
CFE_MATHORDINARY
 Zeichen werden als gewöhnlicher Text innerhalb einer mathematischen Zone angezeigt.
CFE_OUTLINE
 Zeichen werden als umrissene Zeichen angezeigt. Der Wert wirkt sich nicht darauf aus, wie der Text vom Steuerelement angezeigt wird.
CFE_PROTECTED
 Zeichen sind geschützt; Ein Versuch, sie zu ändern, führt zu einem EN_PROTECTED Benachrichtigungscode.
CFE_REVISED
 Zeichen werden als überarbeitet markiert.
CFE_SHADOW
 Zeichen werden als schattierte Zeichen angezeigt. Der Wert wirkt sich nicht darauf aus, wie der Text vom Steuerelement angezeigt wird.
CFE_SMALLCAPS
 Die Zeichen sind in kleinen Großbuchstaben dargestellt. Der Wert wirkt sich nicht darauf aus, wie der Text vom Steuerelement angezeigt wird.
CFE_STRIKEOUT
 Zeichen werden ausgeschlagen.
CFE_SUBSCRIPT
 Zeichen sind tiefgestellt. Die werte CFE_SUPERSCRIPT und CFE_SUBSCRIPT schließen sich gegenseitig aus. Für beide Werte berechnet das Steuerelement automatisch einen Offset und einen kleineren Schriftgrad. Alternativ können Sie die Elemente yHeight und yOffset verwenden, um den Schriftgrad und den Offset für tiefgestellte und hochgestellte Zeichen explizit anzugeben.
CFE_SUPERSCRIPT
 Zeichen sind hochgestellt.
CFE_UNDERLINE
 Zeichen werden unterstrichen.

yHeight

Typ: LONG

Gibt die Zeichenhöhe in Twips (1/1440 zoll oder 1/20 des Punkts eines Druckers) an. Um dieses Element zu verwenden, legen Sie das flag CFM_SIZE im dwMask-Element fest.

yOffset

Typ: LONG

Zeichenoffset aus der Baseline in Twips. Wenn der Wert dieses Elements positiv ist, ist das Zeichen hochgestellt; wenn der Wert negativ ist, ist das Zeichen ein tiefgestellter Wert. Um dieses Element zu verwenden, legen Sie das flag CFM_OFFSET im dwMask-Element fest.

crTextColor

Typ: COLORREF

Textfarbe. Um dieses Element zu verwenden, legen Sie das flag CFM_COLOR im dwMask-Element fest. Dieser Member wird ignoriert, wenn der CFE_AUTOCOLOR Zeicheneffekt angegeben wird. Verwenden Sie zum Generieren einer COLORREF das RGB-Makro .

bCharSet

Typ: BYTE

Zeichensatzwert. Dies kann einer der Werte sein, die für das lfCharSet-Element der LOGFONT-Struktur angegeben sind. Um dieses Element zu verwenden, legen Sie das flag CFM_CHARSET im dwMask-Element fest.

bPitchAndFamily

Typ: BYTE

Gibt die Schriftfamilie und die Tonhöhe an. Dieses Element ist identisch mit dem lfPitchAndFamily-Member der LOGFONT-Struktur .

szFaceName[LF_FACESIZE]

Typ: TCHAR[LF_FACESIZE]

Ein Zeichenarray mit NULL-Beendigung, das den Namen der Schriftart angibt. Um dieses Element zu verwenden, legen Sie das flag CFM_FACE im dwMask-Element fest.

wWeight

Typ: WORD

Schriftgrad. Dieses Element ist identisch mit dem lfWeight-Member der LOGFONT-Struktur . Um dieses Element zu verwenden, legen Sie das flag CFM_WEIGHT im dwMask-Element fest.

sSpacing

Typ: SHORT

Horizontaler Abstand zwischen Buchstaben in Twips. Dieser Wert hat keine Auswirkung auf den Text, der von einem Rich-Edit-Steuerelement angezeigt wird. es ist aus Gründen der Kompatibilität mit Windows TOM-Schnittstellen enthalten. Um dieses Element zu verwenden, legen Sie das flag CFM_SPACING im dwMask-Element fest.

crBackColor

Typ: COLORREF

Hintergrundfarbe. Um dieses Element zu verwenden, legen Sie das flag CFM_BACKCOLOR im dwMask-Element fest. Dieser Member wird ignoriert, wenn der CFE_AUTOBACKCOLOR Zeicheneffekt angegeben wird. Verwenden Sie das Makro, um einen zu generieren.

lcid

Typ: LCID

Ein 32-Bit-Gebietsschemabezeichner, der einen Sprachbezeichner im unteren Wort und einen Sortierbezeichner und einen reservierten Wert im oberen Wort enthält. Dieser Member hat keine Auswirkungen auf den Text, der von einem umfangreichen Bearbeitungssteuerelement angezeigt wird, aber Rechtschreib- und Grammatikprüfung kann es verwenden, um sprachabhängige Probleme zu behandeln. Sie können das Makro verwenden, um einen LCID-Wert zu erstellen. Um dieses Element zu verwenden, legen Sie das flag CFM_LCID im dwMask-Element fest.

dwReserved

Typ: DWORD

Reserviert; der Wert muss 0 (null) sein.

dwCookie

Typ: DWORD

Clientcookies. Dieses Element ist für ein umfangreiches Bearbeitungssteuerelement undurchsichtig.

sStyle

Typ: SHORT

Zeichenformathandle. Dieser Wert hat keine Auswirkung auf den Text, der von einem Rich-Edit-Steuerelement angezeigt wird. Es ist aus Gründen der Kompatibilität mit WindowsTOM-Schnittstellen enthalten. Um dieses Element zu verwenden, legen Sie das flag CFM_STYLE im dwMask-Element fest. Weitere Informationen finden Sie in der TOM-Dokumentation.

wKerning

Typ: WORD

Wert des Schriftgrads, über dem das Zeichen eingeschlossen werden soll (yHeight). Dieser Wert hat keine Auswirkung auf den Text, der von einem Rich-Edit-Steuerelement angezeigt wird. es ist aus Gründen der Kompatibilität mit TOM-Schnittstellen enthalten. Um dieses Element zu verwenden, legen Sie das flag CFM_KERNING im dwMask-Element fest.

bUnderlineType

Typ: BYTE

Gibt den Unterstreichungstyp an. Um dieses Element zu verwenden, legen Sie das flag CFM_UNDERLINETYPE im dwMask-Element fest. Dieser Member kann einer der folgenden Werte sein.

Wert Bedeutung
CFU_CF1UNDERLINE
 Die -Struktur ordnet die Bit-Unterstriche von CHARFORMATCHARFORMAT2 zu (das heißt, sie führt einen CHARFORMAT-Typ der Unterstreichung für diesen Text aus).
CFU_INVERT
 Fälschen Sie für die IME-Komposition eine Auswahl.
CFU_UNDERLINE
 Text unterstrichen mit einer einzelnen durchgehenden Zeile.
CFU_UNDERLINEDASH
 Text unterstrichen mit Bindestrichen.
CFU_UNDERLINEDASHDOT
 Text unterstrichen mit einer gestrichelten und gepunkteten Linie.
CFU_UNDERLINEDASHDOTDOT
 Text unterstrichen mit gestrichelter und doppelt gepunkteter Linie.
CFU_UNDERLINEDOTTED
 Text unterstrichen mit einer gepunkteten Linie. Bei Versionen vor Microsoft Rich Edit 3.0 wird Text mit einer durchgehenden Unterstreichung angezeigt.
CFU_UNDERLINEDOUBLE
 Text unterstrichen mit einer doppelten Zeile. Das Rich-Edit-Steuerelement zeigt den Text mit einer vollfarbigen Unterstreichung an.
CFU_UNDERLINEDOUBLEWAVE
 Wird als CFU_UNDERLINEWAVE angezeigt.
CFU_UNDERLINEHAIRLINE
 Wird als CFU_UNDERLINE angezeigt.
CFU_UNDERLINEHEAVYWAVE
 Wird als CFU_UNDERLINEWAVE angezeigt.
CFU_UNDERLINELONGDASH
 Wird als CFU_UNDERLINEDASH angezeigt.
CFU_UNDERLINENONE
 Keine Unterstreichung. Dies ist die Standardoption.
CFU_UNDERLINETHICK
 Wird als CFU_UNDERLINE angezeigt.
CFU_UNDERLINETHICKDASH
 Wird als CFU_UNDERLINEDASH angezeigt.
CFU_UNDERLINETHICKDASHDOT
 Wird als CFU_UNDERLINEDASHDOT angezeigt.
CFU_UNDERLINETHICKDASHDOTDOT
 Wird als CFU_UNDERLINEDASHDOT angezeigt.
CFU_UNDERLINETHICKDOTTED
 Wird als CFU_UNDERLINEDOT angezeigt.
CFU_UNDERLINETHICKLONGDASH
 Wird als CFU_UNDERLINEDASH angezeigt.
CFU_UNDERLINEWAVE
 RichEdit 4.1 und höher: Text unterstrichen mit einer wellenförmigen Linie.
CFU_UNDERLINEWORD
 RichEdit 4.1 und höher: Nur Wörter unterstreichen. Das Rich-Edit-Steuerelement zeigt den Text mit einer vollfarbigen Unterstreichung an.

bAnimation

Typ: BYTE

Textanimationstyp. Dieser Wert hat keine Auswirkung auf den Text, der von einem Rich-Edit-Steuerelement angezeigt wird. es ist aus Gründen der Kompatibilität mit TOM-Schnittstellen enthalten. Um dieses Element zu verwenden, legen Sie das flag CFM_ANIMATION im dwMask-Element fest.

bRevAuthor

Typ: BYTE

Ein Index, der den Autor identifiziert, der eine Überarbeitung vornimmt. Das Rich-Edit-Steuerelement verwendet unterschiedliche Textfarben für jeden verschiedenen Autorenindex. Um dieses Element zu verwenden, legen Sie das flag CFM_REVAUTHOR im dwMask-Element fest.

bUnderlineColor

Typ: BYTE

Unterstreichungsfarbe:

  • UnderlineColor_Black = 0x00;
  • UnderlineColor_Blue = 0x01;
  • UnderlineColor_Aqua = 0x02;
  • UnderlineColor_Lime = 0x03;
  • UnderlineColor_Fuchsia = 0x04;
  • UnderlineColor_Red = 0x05;
  • UnderlineColor_Yellow = 0x06;
  • UnderlineColor_White = 0x07;
  • UnderlineColor_Navy = 0x08;
  • UnderlineColor_Teal = 0x09;
  • UnderlineColor_Green = 0x0A;
  • UnderlineColor_Purple = 0x0B;
  • UnderlineColor_Maroon = 0x0C;
  • UnderlineColor_Olive = 0x0D;
  • UnderlineColor_DkGray = 0x0E;
  • UnderlineColor_LtGray = 0x0F;

Hinweise

Um ein Formatierungsattribut zu deaktivieren, legen Sie den entsprechenden Wert in dwMask fest, aber nicht den entsprechenden Wert in dwEffects. Um z. B. kursiv zu deaktivieren, legen Sie CFM_ITALIC fest, aber nicht CFE_ITALIC.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Kopfzeile richedit.h

Weitere Informationen

CHARFORMAT

COLORREF

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

GetSysColor

LOGFONT

RGB