PARAFORMAT2 structure (Rich Edit 2.0)
Contains information about paragraph formatting attributes in a rich edit control. PARAFORMAT2 is a Microsoft Rich Edit 2.0 extension of the PARAFORMAT structure. Microsoft Rich Edit 2.0 allows you to use either structure with the EM_GETPARAFORMAT and EM_SETPARAFORMAT messages.
Syntax
typedef struct _paraformat2 {
UINT cbSize;
DWORD dwMask;
WORD wNumbering;
union {
WORD wReserved;
WORD wEffects;
};
LONG dxStartIndent;
LONG dxRightIndent;
LONG dxOffset;
WORD wAlignment;
SHORT cTabCount;
LONG rgxTabs[MAX_TAB_STOPS];
LONG dySpaceBefore;
LONG dySpaceAfter;
LONG dyLineSpacing;
SHORT sStyle;
BYTE bLineSpacingRule;
BYTE bOutlineLevel;
WORD wShadingWeight;
WORD wShadingStyle;
WORD wNumberingStart;
WORD wNumberingStyle;
WORD wNumberingTab;
WORD wBorderSpace;
WORD wBorderWidth;
WORD wBorders;
} PARAFORMAT2;
Members
cbSize
Type: UINT
Structure size, in bytes. Before passing this structure to a rich edit control, set cbSize to the size of the PARAFORMAT or PARAFORMAT2 structure. If cbSize equals the size of a PARAFORMAT structure, the control uses only the PARAFORMAT members.
dwMask
Type: DWORD
The members of the PARAFORMAT2 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 wEffects member.
Set the following values to indicate the valid structure members.
Set the following values to indicate the valid attributes of the wEffects member.
wNumbering
Type: WORD
Options used for bulleted or numbered paragraphs. To use this member, set the PFM_NUMBERING flag in the dwMask member.
This member can be one of the following values.
| Value | Meaning |
|---|---|
|
No paragraph numbering or bullets. |
|
Insert a bullet at the beginning of each selected paragraph. |
Rich Edit versions earlier than version 3.0 do not display paragraph numbers. However, for compatibility with Microsoft Text Object Model (TOM) interfaces, wNumbering can specify one of the following values. (The rich edit control stores the value but does not use it to display the text.)
wReserved
wEffects
Type: WORD
This member is also known as wReserved for Microsoft Rich Edit 1.0 because it was reserved.
Rich Edit 1.0: Reserved; the value must be zero.
Rich Edit 2.0: A set of bit flags that specify paragraph effects. These flags are included only for compatibility with TOM interfaces; the rich edit control stores the value but does not use it to display the text.
This member can be a combination of the following values.
dxStartIndent
Type: LONG
Indentation of the paragraph's first line, in twips. The indentation of subsequent lines depends on the dxOffset member. To use the dxStartIndent member, set the PFM_STARTINDENT or PFM_OFFSETINDENT flag in the dwMask member. If you are setting the indentation, use the PFM_STARTINDENT flag to specify an absolute indentation from the left margin; or use the PFM_OFFSETINDENT flag to specify an indentation relative to the paragraph's current indentation. Use either flag to retrieve the current indentation.
dxRightIndent
Type: LONG
Indentation of the right side of the paragraph, relative to the right margin, in twips. To use this member, set the PFM_RIGHTINDENT flag in the dwMask member.
dxOffset
Type: LONG
Indentation of the second and subsequent lines, relative to the indentation of the first line, in twips. The first line is indented if this member is negative or outdented if this member is positive. To use this member, set the PFM_OFFSET flag in the dwMask member.
wAlignment
Type: WORD
Paragraph alignment. To use this member, set the PFM_ALIGNMENT flag in the dwMask member. This member can be one of the following values.
cTabCount
Type: SHORT
Number of tab stops defined in the rgxTabs array.
rgxTabs[MAX_TAB_STOPS]
Type: LONG
Array of absolute tab stop positions. Each element in the array specifies information about a tab stop. The 24 low-order bits specify the absolute offset, in twips. To use this member, set the PFM_TABSTOPS flag in the dwMask member.
Rich Edit 2.0: For compatibility with TOM interfaces, you can use the eight high-order bits to store additional information about each tab stop.
Bits 24-27 can specify one of the following values to indicate the tab alignment. These bits do not affect the rich edit control display for versions earlier than Microsoft Rich Edit 3.0.
| Value | Meaning |
|---|---|
|
Ordinary tab |
|
Center tab |
|
Right-aligned tab |
|
Decimal tab |
|
Word bar tab (vertical bar) |
Bits 28-31 can specify one of the following values to indicate the type of tab leader. These bits do not affect the rich edit control display.
| Value | Meaning |
|---|---|
|
No leader |
|
Dotted leader |
|
Dashed leader |
|
Underlined leader |
|
Thick line leader |
|
Double line leader |
dySpaceBefore
Type: LONG
Size of the spacing above the paragraph, in twips. To use this member, set the PFM_SPACEBEFORE flag in the dwMask member. The value must be greater than or equal to zero.
dySpaceAfter
Type: LONG
Specifies the size of the spacing below the paragraph, in twips. To use this member, set the PFM_SPACEAFTER flag in the dwMask member. The value must be greater than or equal to zero.
dyLineSpacing
Type: LONG
Spacing between lines. For a description of how this value is interpreted, see the bLineSpacingRule member. To use this member, set the PFM_LINESPACING flag in the dwMask member.
sStyle
Type: SHORT
Text style. To use this member, set the PFM_STYLE flag in the dwMask member. This member is included only for compatibility with TOM interfaces and Word; the rich edit control stores the value but does not use it to display the text.
bLineSpacingRule
Type: BYTE
Type of line spacing. To use this member, set the PFM_LINESPACING flag in the dwMask member. This member can be one of the following values.
bOutlineLevel
Type: BYTE
Reserved; must be zero.
wShadingWeight
Type: WORD
Percentage foreground color used in shading. The wShadingStyle member specifies the foreground and background shading colors. A value of 5 indicates a shading color consisting of 5 percent foreground color and 95 percent background color. To use these members, set the PFM_SHADING flag in the dwMask member. This member is included only for compatibility with Word; the rich edit control stores the value but does not use it to display the text.
wShadingStyle
Type: WORD
Style and colors used for background shading. Bits 0 to 3 contain the shading style, bits 4 to 7 contain the foreground color index, and bits 8 to 11 contain the background color index. To use this member, set the PFM_SHADING flag in the dwMask member. This member is included only for compatibility with Word; the rich edit control stores the value but does not use it to display the text.
The shading style can be one of the following values.
The foreground and background color indexes can be one of the following values.
| Value | Meaning |
|---|---|
|
Black |
|
Blue |
|
Cyan |
|
Green |
|
Magenta |
|
Red |
|
Yellow |
|
White |
|
Dark blue |
|
Dark cyan |
|
Dark green |
|
Dark magenta |
|
Dark red |
|
Dark yellow |
|
Dark gray |
|
Light gray |
wNumberingStart
Type: WORD
Starting number or Unicode value used for numbered paragraphs. Use this member in conjunction with the wNumbering member. This member is included only for compatibility with TOM interfaces; the rich edit control stores the value but does not use it to display the text or bullets. To use this member, set the PFM_NUMBERINGSTART flag in the dwMask member.
wNumberingStyle
Type: WORD
Numbering style used with numbered paragraphs. Use this member in conjunction with the wNumbering member. This member is included only for compatibility with TOM interfaces; the rich edit control stores the value but rich edit versions earlier than 3.0 do not use it to display the text or bullets. To use this member, set the PFM_NUMBERINGSTYLE flag in the dwMask member. This member can be one of the following values.
wNumberingTab
Type: WORD
Minimum space between a paragraph number and the paragraph text, in twips. Use this member in conjunction with the wNumbering member. The wNumberingTab member is included for compatibility with TOM interfaces; previous to Microsoft Rich Edit 3.0, the rich edit control stores the value but does not use it to display text. To use this member, set the PFM_NUMBERINGTAB flag in the dwMask member.
wBorderSpace
Type: WORD
The space between the border and the paragraph text, in twips. The wBorderSpace member is included for compatibility with Word; the rich edit control stores the values but does not use them to display text. To use this member, set the PFM_BORDER flag in the dwMask member.
wBorderWidth
Type: WORD
Border width, in twips. To use this member, set the PFM_BORDER flag in the dwMask member.
wBorders
Type: WORD
Border location, style, and color. Bits 0 to 7 specify the border locations, bits 8 to 11 specify the border style, and bits 12 to 15 specify the border color index. To use this member, set the PFM_BORDER flag in the dwMask member.
Specify the border locations using a combination of the following values in bits 0 to 7.
| Value | Meaning |
|---|---|
|
Left border. |
|
Right border. |
|
Top border. |
|
Bottom border. |
|
Inside borders. |
|
Outside borders. |
|
Autocolor. If this bit is set, the color index in bits 12 to 15 is not used. |
Specify the border style using one of the following values for bits 8 to 11.
| Value | Meaning |
|---|---|
|
None |
|
3/4 point |
|
11/2 point |
|
21/4 point |
|
3 point |
|
41/2 point |
|
6 point |
|
3/4 point double |
|
11/2 point double |
|
21/4 point double |
|
3/4 point gray |
|
3/4 point gray dashed |
Specify the border color using one of the following values for bits 12 to 15. This value is ignored if the autocolor bit (bit 6) is set.
| Value | Meaning |
|---|---|
|
Black |
|
Blue |
|
Cyan |
|
Green |
|
Magenta |
|
Red |
|
Yellow |
|
White |
|
Dark blue |
|
Dark cyan |
|
Dark green |
|
Dark magenta |
|
Dark red |
|
Dark yellow |
|
Dark gray |
|
Light gray |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Header | richedit.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for