Actions: Printing

add to print job

Adds the specified element’s rectangular boundary of a given screen to the print job as a new page. This action must be called after the ‘start print process’ action and before the ‘end print process’ action.

Argument Description
Screen The screen to be printed.
Element An element whose rectangular boundary specifies the area of the screen to be printed.

end print process

Ends the print process and sends the open print job to the printer or saves it as a PDF, as specified by the ‘start print process’ action called prior to this action. This action must be called after the ‘start print process’ action.

get print setting

Retrieves the value of the specified print setting. Print margins are returned in inches.

Argument Description
Setting The print setting whose value will be returned.
Output The location where the result will go (variable or field or text element).

Prints a single page of the specified element’s rectangular boundary of a given screen. This is only available for MacOS and Windows platforms.

Argument Description
Screen The screen to be printed.
Element An element whose rectangular boundary specifies the area of the screen to be printed.

Prints the specified element’s rectangular boundary of a given screen to a single-page pdf file.

Argument Description
Filename The filename of the pdf to be saved.
Screen The screen to be printed.
Element An element whose rectangular boundary specifies the area of the screen to be printed.

set print margins

Specify the margin widths of the page(s) when printed. This action must be called before the ‘start print process’ action.

Argument Description
Left Width of the left margin in inches.
Top Width of the top margin in inches.
Right Width of the right margin in inches.
Bottom Width of the bottom margin in inches.

set print orientation

Specify the orientation of the page(s) when printed. This action must be called before the ‘start print process’ action.

Argument Description
Orientation The orientation of the printed content.

start print process

Starts a print job to send to a printer (desktop only) or save as a PDF.

Argument Description
Filename The filename of the PDF to be saved if the ‘output’ argument is set to ‘PDF’. If this argument is empty, a default name with the app’s name and timestamp will be used.
Output Where the print job goes, either sent to a printer (desktop only) or saved as a PDF.
Result The action taken by the user when presented with the print dialog if the ‘output’ argument is set to ‘printer’. ‘True’ will be returned if the user proceeds with the print job. Otherwise ‘false’ will be returned.

This chapter was last updated on Mon 22 Apr 2024 17:03:19 BST