CHARFORMAT
The CHARFORMAT
structure contains information about character formatting in a rich edit
control.
typedef struct _charformat {
UINT cbSize;
_WPAD _wPad1;
DWORD dwMask;
DWORD dwEffects;
LONG yHeight;
LONG yOffset;
COLORREF
crTextColor;
BYTE bCharSet;
BYTE bPitchAndFamily;
CHAR szFaceName[LF_FACESIZE];
_WPAD _wPad2;
} CHARFORMAT;
Members
cbSize
Size in bytes
of this structure. Must be set before passing the structure to the rich edit
control.
dwMask
Members
containing valid information or attributes to set. This member can be zero or
more of the following values:
|
Value |
Meaning |
|
CFM_BOLD |
The CFE_BOLD
value of the dwEffects member is valid. |
|
CFM_COLOR |
The crTextColor
member and the CFE_AUTOCOLOR value of the dwEffects member are valid. |
|
CFM_FACE |
The szFaceName
member is valid. |
|
CFM_ITALIC |
The
CFE_ITALIC value of the dwEffects member is valid. |
|
CFM_OFFSET |
The yOffset
member is valid. |
|
CFM_PROTECTED |
The
CFE_PROTECTED value of the dwEffects member is valid. |
|
CFM_SIZE |
The yHeight
member is valid. |
|
CFM_STRIKEOUT |
The
CFE_STRIKEOUT value of the dwEffects member is valid. |
|
CFM_UNDERLINE. |
The
CFE_UNDERLINE value of the dwEffects member is valid. |
dwEffects
Character
effects. This member can be a combination of the following values:
|
Value |
Meaning |
|
CFE_AUTOCOLOR |
The text
color is the return value of GetSysColor (COLOR_WINDOWTEXT). |
|
CFE_BOLD |
Characters
are bold. |
|
CFE_ITALIC |
Characters
are italic. |
|
CFE_STRIKEOUT |
Characters
are struck out. |
|
CFE_UNDERLINE |
Characters
are underlined. |
|
CFE_PROTECTED |
Characters
are protected; an attempt to modify them will cause an EN_PROTECTED notification message. |
yHeight
Character
height.
yOffset
Character
offset from the baseline. If this member is positive, the character is a
superscript; if it is negative, the character is a subscript.
crTextColor
Text color.
This member is ignored if the CFE_AUTOCOLOR character effect is specified.
bCharSet
Character set
value. Can be one of the values specified for the lfCharSet member of
the LOGFONT
structure.
bPitchAndFamily
Font family
and pitch. This member is the same as the lfPitchAndFamily member of the
LOGFONT structure.
szFaceName
Null-terminated
character array specifying the font face name.
Remarks
This
structure is used with the EM_GETCHARFORMAT and EM_SETCHARFORMAT messages.
See Also