RichText.SetParagraphFormat

OverviewExamples

RichText.SetParagraphFormat (

string ObjectName,

table ParagraphFormat )

Description

Sets the paragraph format of the current selection in a richtext object.

Parameters

ObjectName

(string) The name of the richtext object.

ParagraphFormat

(table) A table containing the paragraph settings you want to modify in the richtext object, indexed by the following items.

Note: The functionality of some of the items may be depend on the version of the rich edit control available on the user's system.

KEY	TYPE	DESCRIPTION
Bulleted	boolean	True if the text selection should be bulleted, false if it is not.
StartIndent	number	The left indent of the first line to set in twips. (and all subsequent lines if Offset is 0).
RightIndent	number	The right indent of the text to set, relative to the right margin, in twips.
Offset	number	The indentation of the second and subsequent lines to set, relative to the indentation of the first line, in twips.
Alignment	number	The paragraph alignment to set: PFA_LEFT (1) - Align paragraphs with the left margin. PFA_RIGHT (2) - Align paragraphs with the right margin. PFA_CENTER (3) - Center paragraphs. PFA_JUSTIFY (4) - Justify paragraphs (Rich Edit 2.0). This value is included for compatibility with TOM interfaces; rich edit controls earlier than Rich Edit 3.0 display the text aligned with the left margin.
Tabs	table	A numerically indexed table of the tab positions to set.
SpaceBefore	number	The size of the spacing above the paragraph to set, in twips.
SpaceAfter	number	The size of the spacing below the paragraph to set, in twips.
LineSpacing	number	The spacing between lines to set, based on the LineSpacingRule defined below.
LineSpacingRule	number	Type of line spacing to set, based on one of the following values: 0 - Single spacing. The LineSpacing item is ignored. 1 - One-and-a-half spacing. The LineSpacing item is ignored. 2 - Double spacing. The LineSpacing item is ignored. 3 - The LineSpacing item specifies the spacing from one line to the next, in twips. However, if LineSpacing specifies a value that is less than single spacing, the control displays single-spaced text. 4 - The LineSpacing item specifies the spacing from one line to the next, in twips. The control uses the exact spacing specified, even if LineSpacing specifies a value that is less than single spacing. 5 - The value of LineSpacing / 20 is the spacing, in lines, from one line to the next. Thus, setting LineSpacing to 20 produces single-spaced text, 40 is double spaced, 60 is triple spaced, and so on.
BorderSpace	number	The space between the border and the paragraph text to set, in twips. This item is included for compatibility with Word; the rich edit control stores the values but does not use them to display text.
BorderWidth	number	The border width to set, in twips.
Borders	number	This item is only included for compatibility, and may not have any visible effect. For a description of this option, see MSDN: PARAFORMAT2 Structure.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.