4D v18
WP INSERT BREAK
- 4D Write Pro Reference
-
- 4D Write Pro Language
-
- About 4D Write Pro objects
- Using commands from the Objects (Forms) theme
- Using commands from the Styled Text theme
- Accessing document contents by programming
- 4D Write Pro Constants
- WP Add picture
- WP Bookmark range
- WP DELETE BOOKMARK
- WP DELETE FOOTER
- WP DELETE HEADER
- WP DELETE STYLE SHEETNew
- WP DELETE SUBSECTION
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get body
- WP GET BOOKMARKS
- WP Get element by ID
- WP Get elements
- WP Get footer
- WP Get frame
- WP Get header
- WP Get links
- WP Get page count
- WP Get position
- WP Get section
- WP Get sections
- WP Get style sheetNew
- WP Get style sheetsNew
- WP Get subsection
- WP Get text
- WP Get view properties
- WP Import document
- WP IMPORT STYLE SHEETSNew
- WP INSERT BREAK
- WP INSERT DOCUMENT
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP NEW BOOKMARK
- WP New footer
- WP New header
- WP New style sheetNew
- WP New subsection
- WP Paragraph range
- WP Picture range
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP Selection range
- WP SET ATTRIBUTES
- WP SET FRAME
- WP SET LINK
- WP SET TEXT
- WP SET VIEW PROPERTIES
- WP Table append row
- WP TABLE DELETE COLUMNSNew
- WP TABLE DELETE ROWSNew
- WP Table get cellsUpd
- WP Table get columnsUpd
- WP Table get rowsUpd
- WP Table insert columnsNew
- WP Table insert rowsNew
- WP Table range
- WP Text range
- WP USE PAGE SETUP
- 4D Write Pro Attributes
4D v18
WP INSERT BREAK
WP INSERT BREAK
| WP INSERT BREAK ( targetObj ; breakType ; mode {; rangeUpdate} ) | ||||||||
| Parameter | Type | Description | ||||||
| targetObj | Object |
|
Range or element or 4D Write Pro document | |||||
| breakType | Longint |
|
Type of break to insert | |||||
| mode | Longint |
|
Insertion mode | |||||
| rangeUpdate | Longint |
|
Range update mode | |||||
The WP INSERT BREAK command inserts a new break of the breakType type in the targetObj according to the specified insertion mode and rangeUpdate parameters.
In targetObj, pass:
- a range, or
- an element (table / row / paragraph / body / header / footer / inline picture / section / subsection), or
- a 4D Write Pro document
In breakType, pass one of the following constants from the 4D Write Pro Constants theme to define the type of break to insert:
| Constant | Type | Value | Comment |
| wk column break | Longint | 3 | Column break: inserts a column break |
| wk line break | Longint | 0 | Line break (in the same paragraph) |
| wk page break | Longint | 2 | Page break: defines a new page |
| wk paragraph break | Longint | 4 | Paragraph break: defines a new paragraph |
| wk section break | Longint | 1 | Section break: defines a new section |
In the mode parameter, pass a constant to indicate the insertion mode to be used for the break in the destination targetObj:
| Constant | Type | Value | Comment |
| wk append | Longint | 2 | Insert contents at end of target |
| wk prepend | Longint | 1 | Insert contents at beginning of target |
| wk replace | Longint | 0 | Replace target contents |
- If targetObj is a range, you can use the optional rangeUpdate parameter to pass one of the following constants to specify whether or not the inserted contents are included in the resulting range:
Constant Type Value Comment wk exclude from range Longint 1 Inserted contents not included in updated range wk include in range Longint 0 Inserted contents included in updated range (default)
If you do not pass a rangeUpdate parameter, by default the inserted contents are included in the resulting range.
- If targetObj is not a range, rangeUpdate is ignored.
While building invoices, you want to insert page breaks except on the last page:
$nbInvoices:=Records in selection([INVOICE])
For($j;1;$nbInvoices)
... //processing invoices
If($j#$nbInvoices) //insert page break except for last page
WP INSERT BREAK($buildRange;wk page break;wk append;wk exclude from range)
End if
End for
See also
PROPERTIES
Product: 4D
Theme: 4D Write Pro Language
Number:
1413
HISTORY
Created: 4D v16
Modified: 4D v17
Modified: 4D v17 R2
Modified: 4D v17 R5
ARTICLE USAGE
4D Write Pro Reference ( 4D v18)
© 1985-2020 4D SAS / 4D, Inc. All rights reserved.