PrintSetSpacing

Description

Sets the factor that PocketBuilder uses to calculate line spacing.

Syntax

PrintSetSpacing ( printjobnumber, spacingfactor )

Argument

Description

printjobnumber

The number the PrintOpen function assigned to the print job.

spacingfactor

The number by which you want to multiply the character height to determine the vertical line-to-line spacing. The default is 1.2.

Returns

Integer. Returns 1 if it succeeds and -1 if an error occurs. If any argument’s value is null, PrintSetSpacing returns null.

Usage

Line spacing in PocketBuilder is proportional to character height. The default line spacing is 1.2 times the character height. When Print starts a new line, it sets the x coordinate of the cursor to 0 and increases the y coordinate by the current line spacing. The PrintSetSpacing function lets you specify a new factor to be multiplied by the character height for an open print job.

Examples

Example 1

These statements start a new print job and set the vertical spacing factor to 1.5 (one and a half spacing):

long Job


// Define a new blank page.

Job = PrintOpen()


// Set the spacing factor.

PrintSetSpacing(Job, 1.5)

See also