SetSpacing

Description

Sets the line spacing for the selected paragraphs or the paragraph containing the insertion point in a RichTextEdit control.

Applies to

RichTextEdit controls

Syntax

rtename.SetSpacing ( spacing )

Argument

Description

rtename

The name of the RichTextEdit control in which you want to set the line spacing.

spacing

A value of the Spacing enumerated datatype specifying the line spacing for the text. Values are:

Spacing1! -- Single spacing

Spacing15! -- One and a half line spacing

Spacing2! -- Double spacing


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs.

Usage

Because spacing is a setting for paragraphs, not individual lines, then if lines have wrapped, spacing will change for all the lines in all the paragraphs that are selected.

When you expand the line spacing, the extra space is added before the affected lines.

Examples

This example specifies double spacing for the selected paragraphs in the RichTextEdit rte_1:

rte_1.SetSpacing(Spacing2!)

This example specifies one and a half line spacing:

rte_1.SetSpacing(Spacing15!)