PARAFORMAT2 structure (richedit.h)

  • Article

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

struct PARAFORMAT2 : _paraformat {
  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;
};

Inheritance

The PARAFORMAT2 structure implements _paraformat.

Members

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.

Value Meaning
0
 Single spacing. The dyLineSpacing member is ignored.
1
 One-and-a-half spacing. The dyLineSpacing member is ignored.
2
 Double spacing. The dyLineSpacing member is ignored.
3
 The dyLineSpacing member specifies the spacingfrom one line to the next, in twips. However, if dyLineSpacing specifies a value that is less than single spacing, the control displays single-spaced text.
4
 The dyLineSpacing member specifies the spacing from one line to the next, in twips. The control uses the exact spacing specified, even if dyLineSpacing specifies a value that is less than single spacing.
5
 The value of dyLineSpacing / 20 is the spacing, in lines, from one line to the next. Thus, setting dyLineSpacing to 20 produces single-spaced text, 40 is double spaced, 60 is triple spaced, and so on.

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.

Value Meaning
0
 None
1
 Dark horizontal
2
 Dark vertical
3
 Dark down diagonal
4
 Dark up diagonal
5
 Dark grid
6
 Dark trellis
7
 Light horizontal
8
 Light vertical
9
 Light down diagonal
10
 Light up diagonal
11
 Light grid
12
 Light trellis
 

The foreground and background color indexes can be one of the following values.

Value Meaning
0
 Black
1
 Blue
2
 Cyan
3
 Green
4
 Magenta
5
 Red
6
 Yellow
7
 White
8
 Dark blue
9
 Dark cyan
10
 Dark green
11
 Dark magenta
12
 Dark red
13
 Dark yellow
14
 Dark gray
15
 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.

Value Meaning
PFNS_PAREN
 Follows the number with a right parenthesis.
PFNS_PARENS
 Encloses the number in parentheses.
PFNS_PERIOD
 Follows the number with a period.
PFNS_PLAIN
 Displays only the number.
PFNS_NONUMBER
 Continues a numbered list without applying the next number or bullet.
PFNS_NEWNUMBER
 Starts a new number with wNumberingStart.

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
1
 Left border.
2
 Right border.
4
 Top border.
8
 Bottom border.
16
 Inside borders.
32
 Outside borders.
64
 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
0
 None
1
 3/4 point
2
 11/2 point
3
 21/4 point
4
 3 point
5
 41/2 point
6
 6 point
7
 3/4 point double
8
 11/2 point double
9
 21/4 point double
10
 3/4 point gray
11
 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
0
 Black
1
 Blue
2
 Cyan
3
 Green
4
 Magenta
5
 Red
6
 Yellow
7
 White
8
 Dark blue
9
 Dark cyan
10
 Dark green
11
 Dark magenta
12
 Dark red
13
 Dark yellow
14
 Dark gray
15
 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

EM_GETPARAFORMAT

EM_SETPARAFORMAT

PARAFORMAT