VpeSetAutoBreak

<< Click to Display Table of Contents >>

Navigation:  Layout Functions >

VpeSetAutoBreak

Previous pageReturn to chapter overviewNext page

Controls, if and how text is handled, that overflows the bottom of the current output rectangle.

For details see "Page Margins" and "Automatic Text Break" in the Programmer's Manual.

void VpeSetAutoBreak(

VpeHandle hDoc,

int mode

)

VpeHandle hDoc

Document Handle

int mode

Constant Name

Comment

AUTO_BREAK_ON

Auto Break is activated. An Auto Break will happen if
y2 = VFREE or y > VBOTTOMMARGIN.

Remaining text is broken onto the next page(s) with the following coordinates:

x

= the original x coordinate of the inserted object

x2

= the original x2 coordinate of the inserted object

y

= top of the Output Rectangle of the successive page - if a new page is generated, it will be the top of the Default Output Rectangle

y2

= VFREE

AUTO_BREAK_OFF

Same behavior as AUTO_BREAK_ON (limited positioning / rendering to the bottom of the output rectangle is active), but remaining text is NOT broken onto next page(s). It is cut instead.

AUTO_BREAK_NO_LIMITS

Remaining text is NOT broken onto the next page(s), it can be placed anywhere on the paper with no limits.

AUTO_BREAK_FULL

Auto Break is activated. An Auto Break will happen if
y2 = VFREE or y > VBOTTOMMARGIN.

Remaining text is broken onto the next page(s) with the following coordinates:

x

= left margin of the Output Rectangle

x2

= right margin of the Output Rectangle

y

= top margin of the Output Rectangle

y2

= VFREE

Note: if a new blank page is added by VPE, the Default Output Rectangle will be used to set x, x2 and y. Otherwise if the next page is already existing, the Output Rectangle of the existing page is used. You can modify the Output Rectangle of an existing page at any time.

Default:

AUTO_BREAK_ON