print-form

Parameter	Type		Description
aTable	Table	→	Table owning the form, or Default table, if omitted
form	Text, Object	→	Name (string) of the form, or a POSIX path (string) to a .json file describing the form, or an object describing the form to print
formData	Object	→	Data to associate to the form
areaStart	Integer	→	Print marker, or Beginning area (if areaEnd is specified)
areaEnd	Integer	→	Ending area (if areaStart specified)
Function result	Integer	←	Height of printed section

Description

In the form parameter, you can pass:

• the name of a form, or
• the path (in POSIX syntax) to a valid .json file containing a description of the form to use (see Form file path), or
• an object containing a description of the form.

Since Print form does not issue a page break after printing the form, it is easy to combine different forms on the same page. Thus, Print form is perfect for complex printing tasks that involve different tables and different forms. To force a page break between forms, use the PAGE BREAK command. In order to carry printing over to the next page for a form whose height is greater than the available space, call the CANCEL command before the PAGE BREAK command.

Three different syntaxes may be used:

• Detail area printing

Syntax:

 height:=Print form(myTable;myForm)

In this case, Print form only prints the Detail area (the area between the Header line and the Detail line) of the form.

• Form area printing

Syntax:

 height:=Print form(myTable;myForm;marker)

In this case, the command will print the section designated by the marker. Pass one of the constants of the Form Area theme in the marker parameter:

Constant	Type	Value
Form break0	Integer	300
Form break1	Integer	301
Form break2	Integer	302
Form break3	Integer	303
Form break4	Integer	304
Form break5	Integer	305
Form break6	Integer	306
Form break7	Integer	307
Form break8	Integer	308
Form break9	Integer	309
Form detail	Integer	0
Form footer	Integer	100
Form header	Integer	200
Form header1	Integer	201
Form header10	Integer	210
Form header2	Integer	202
Form header3	Integer	203
Form header4	Integer	204
Form header5	Integer	205
Form header6	Integer	206
Form header7	Integer	207
Form header8	Integer	208
Form header9	Integer	209

• Section printing

Syntax:

 height:=Print form(myTable;myForm;areaStart;areaEnd)

In this case, the command will print the section included between the areaStart and areaEnd parameters. The values entered must be expressed in pixels.

formData

Optionally, you can pass parameters to the form using either the formData object or the form class object automatically instantiated by 4D if you have associated a user class to the form. Any properties of the form data object will then be available from within the form context through the Form command. The form data object is available in the On Printing Detail form event.