CHARFORMAT2

描述

The CHARFORMAT2 structure contains information about character formatting in a rich edit control. CHARFORMAT2 is a Microsoft Rich Edit 2.0 extension of the CHARFORMAT structure. Rich Edit 2.0 allows you to use either structure with the EM_GETCHARFORMAT and EM_SETCHARFORMAT messages.

C/C++ 语法

typedef struct _charformat2 {

UINT cbSize;

DWORD dwMask;

DWORD dwEffects;

LONG yHeight;

LONG yOffset;

COLORREF crTextColor;

BYTE bCharSet;

BYTE bPitchAndFamily;

TCHAR szFaceName[LF_FACESIZE];

WORD wWeight;

SHORT sSpacing;

COLORREF crBackColor;

LCID lcid;

DWORD dwReserved;

SHORT sStyle;

WORD wKerning;

BYTE bUnderlineType;

BYTE bAnimation;

BYTE bRevAuthor;

BYTE bReserved1;

} CHARFORMAT2;

FreeBasic Syntax

TYPE CHARFORMAT2W BYTE

cbSize AS UINT

dwMask AS DWORD

dwEffects AS DWORD

yHeight AS LONG

yOffset AS LONG

crTextColor AS COLORREF

bCharSet AS UBYTE

bPitchAndFamily AS UBYTE

szFaceName AS WSTRING * 32

wWeight AS WORD

sSpacing AS SHORT

crBackColor AS COLORREF

lcid AS LCID

UNION

dwReserved AS DWORD

dwCookie AS DWORD

END UNION

sStyle AS SHORT

wKerning AS WORD

bUnderlineType AS UBYTE

bAnimation AS UBYTE

bRevAuthor AS UBYTE

bReserved1 AS UBYTE

END TYPE

成员

cbSize

Specifies the size, in bytes, of the structure. Before passing this structure to a rich edit control, set cbSize to the size of the CHARFORMAT or CHARFORMAT2 structure. If cbSize equals the size of a CHARFORMAT structure, the control uses only the CHARFORMAT members.

dwMask

Specifies the parts of the CHARFORMAT2 structure that contain valid information. The dwMask member can be a combination of the values from two sets of bit flags. One set indicates the structure members that are valid. Another set indicates the valid attributes in the dwEffects member.

Set the following values to indicate the valid attributes of the dwEffects member.

Value	Meaning
CFM_ALLCAPS	The CFE_ALLCAPS value is valid.
CFM_BOLD	The CFE_BOLD value is valid.
CFM_COLOR	The CFE_AUTOCOLOR value is valid, or the crTextColor member is valid.
CFM_DISABLED	The CFE_DISABLED value is valid.
CFM_EMBOSS	The CFE_EMBOSS value is valid.
CFM_HIDDEN	The CFE_HIDDEN value is valid.
CFM_IMPRINT	The CFE_IMPRINT value is valid.
CFM_ITALIC	The CFE_ITALIC value is valid.
CFM_LINK	The CFE_LINK value is valid.
CFM_OUTLINE	The CFE_OUTLINE value is valid.
CFM_PROTECTED	The CFE_PROTECTED value is valid.
CFM_REVISED	The CFE_REVISION value is valid.
CFM_SHADOW	The CFE_SHADOW value is valid.
CFM_SMALLCAPS	The CFE_SMALLCAPS value is valid.
CFM_STRIKEOUT	The CFE_STRIKEOUT value is valid.
CFM_SUBSCRIPT	The CFE_SUBSCRIPT and CFE_SUPERSCRIPT values are valid.
CFM_SUPERSCRIPT	The CFE_SUBSCRIPT and CFE_SUPERSCRIPT values are valid.
CFM_UNDERLINE	The CFE_UNDERLINE value is valid.

Set the following values to indicate the valid structure members.

CFM_ANIMATION

The bAnimation member is valid.

CFM_BACKCOLOR

The crBackColor member is valid.

CFM_CHARSET

The bCharSet member is valid.

CFM_COLOR

The crTextColor member is valid unless the CFE_AUTOCOLOR flag is set in the dwEffects member.

CFM_FACE

The szFaceName member is valid.

CFM_KERNING

The wKerning member is valid.

CFM_LCID

The lcid member is valid.

CFM_OFFSET

The yOffset member is valid.

CFM_REVAUTHOR

The bRevAuthor member is valid.

CFM_SIZE

The yHeight member is valid.

CFM_SPACING

The sSpacing member is valid.

CFM_STYLE

The sStyle member is valid.

CFM_UNDERLINETYPE

The bUnderlineType member is valid.

CFM_WEIGHT

The wWeight member is valid.

dwEffects

A set of bit flags that specify character effects. Some of the flags are included only for compatibility with Microsoft Text Object Model (TOM) interfaces; the rich edit control stores the value but does not use it to display text.

This member can be a combination of the following values.

CFE_ALLCAPS

Characters are all capital letters. The value does not affect the way the control displays the text. This value applies only to versions earlier than Rich Edit 3.0.

CFE_AUTOBACKCOLOR

The background color is the return value of GetSysColor(COLOR_WINDOW). If this flag is set, crBackColor member is ignored.

CFE_AUTOCOLOR

The text color is the return value of GetSysColor(COLOR_WINDOWTEXT). If this flag is set, the crTextColor member is ignored.

CFE_BOLD

Characters are bold.

CFE_DISABLED

Characters are displayed with a shadow that is offset by 3/4 point or one pixel, whichever is larger.

CFE_EMBOSS

Characters are embossed. The value does not affect how the control displays the text.

CFE_HIDDEN

For Rich Edit 3.0 and later, characters are not displayed.

CFE_IMPRINT

Characters are displayed as imprinted characters. The value does not affect how the control displays the text.

CFE_ITALIC

Characters are italic.

CFE_LINK

A rich edit control can send EN_LINK notification messages when it receives mouse messages while the mouse pointer is over text with the CFE_LINK effect.

CFE_OUTLINE

Characters are displayed as outlined characters. The value does not affect how the control displays the text.

CFE_PROTECTED

Characters are protected; an attempt to modify them will cause an EN_PROTECTED notification message.

CFE_REVISED

Characters are marked as revised.

CFE_SHADOW

Characters are displayed as shadowed characters. The value does not affect how the control displays the text.

CFE_SMALLCAPS

Characters are in small capital letters. The value does not affect how the control displays the text.

CFE_STRIKEOUT

Characters are struck out.

CFE_SUBSCRIPT

Characters are subscript. The CFE_SUPERSCRIPT and CFE_SUBSCRIPT values are mutually exclusive. For both values, the control automatically calculates an offset and a smaller font size. Alternatively, you can use the yHeight and yOffset members to explicitly specify font size and offset for subscript and superscript characters.

CFE_SUPERSCRIPT

Characters are superscript.

CFE_UNDERLINE

Characters are underlined.

yHeight

Specifies the character height, in twips (1/1440 of an inch, or 1/20 of a printer's point). To use this member, set the CFM_SIZE flag in the dwMask member.

yOffset

Character offset from the baseline, in twips,. If the value of this member is positive, the character is a superscript; if the value is negative, the character is a subscript. To use this member, set the CFM_OFFSET flag in the dwMask member.

crTextColor

Text color. To use this member, set the CFM_COLOR flag in the dwMask member. This member is ignored if the CFE_AUTOCOLOR character effect is specified. To generate a COLORREF, use the RGB function.

bCharSet

Character set value. It can be one of the values specified for the lfCharSet member of the LOGFONT structure. To use this member, set the CFM_CHARSET flag in the dwMask member.

bPitchAndFamily

Specifies the font family and pitch. This member is the same as the lfPitchAndFamily member of the LOGFONT structure.

wWeight

Font weight. This member is the same as the lfWeight member of the LOGFONT structure. To use this member, set the CFM_WEIGHT flag in the dwMask member.

sSpacing

Horizontal space between letters, in twips. This value has no effect on the text displayed by a rich edit control; it is included for compatibility with Microsoft WindowsText Object Model (TOM) interfaces. To use this member, set the CFM_SPACING flag in the dwMask member.

crBackColor

Background color. To use this member, set the CFM_BACKCOLOR flag in the dwMask member. This member is ignored if the CFE_AUTOBACKCOLOR character effect is specified. To generate a , use the macro.

lcid

A 32-bit locale identifier that contains a language identifier in the lower word and a sorting identifier and reserved value in the upper word. This member has no effect on the text displayed by a rich edit control, but spelling and grammar checkers can use it to deal with language-dependent problems. You can use the macro to create an LCID value. To use this member, set the CFM_LCID flag in the dwMask member.

dwReserved

Reserved; the value must be zero.

sStyle

Character style handle. This value has no effect on the text displayed by a rich edit control; it is included for compatibility with WindowsTOM interfaces. To use this member, set the CFM_STYLE flag in the dwMask member. For more information see the Text Object Model documentation.

wKerning

Value of the font size, above which to kern the character (yHeight). This value has no effect on the text displayed by a rich edit control; it is included for compatibility with TOM interfaces. To use this member, set the CFM_KERNING flag in the dwMask member.

bUnderlineType

Specifies the underline type. To use this member, set the CFM_UNDERLINETYPE flag in the dwMask member. This member can be one of the following values.

CFU_CF1UNDERLINE

The structure maps CHARFORMAT's bit underline to CHARFORMAT2, (that is, it performs a CHARFORMAT type of underline on this text).

CFU_UNDERLINE

Solid underlined text.

CFU_UNDERLINEDOTTED

Dotted underlined text. For versions earlier than Rich Edit 3.0, text is displayed with a solid underline.

CFU_UNDERLINEDOUBLE

Double-underlined text. The rich edit control displays the text with a solid underline.

CFU_UNDERLINENONE

No underline. This is the default.

CFU_UNDERLINEWORD

Underline words only. The rich edit control displays the text with a solid underline.

bAnimation

Text animation type. This value has no effect on the text displayed by a rich edit control; it is included for compatibility with TOM interfaces. To use this member, set the CFM_ANIMATION flag in the dwMask member.

bRevAuthor

An index that identifies the author making a revision. The rich edit control uses different text colors for each different author index. To use this member, set the CFM_REVAUTHOR flag in the dwMask member.

bReserved1

Reserved; the value must be zero.

备注

To turn off a formatting attribute, set the appropriate value in dwMask but do not set the corresponding value in dwEffects. For example, to turn off italics, set CFM_ITALIC but do not set CFE_ITALIC.

最低操作系统

Windows 95 with Rich Edit 2.0, Windows 98, Windows NT 4.0.