About starting a print job

Calling the PrintJob.start() method prompts Flash Player to spool the print job to the user's operating system and also prompts the user's operating system print dialog box to appear.

If, from the print dialog box, the user selects an option to begin printing, the PrintJob.start() method returns a value of true. (The value is false if the user cancels the print job, in which case the script should only call delete). If successful, the PrintJob.start() method sets values for the paperHeight, paperWidth, pageHeight, pageWidth, and orientation properties.

Depending on the user's operating system, an additional dialog box might appear until spooling is complete and the function PrintJob.send is called: calls to PrintJob.addPage() and then PrintJob.send() should be made expeditiously. If ten seconds elapse between the PrintJob.start() function call and the function call PrintJob.send(), which sends the print job to the printer, Flash Player effectively calls PrintJob.send(), causing any pages that are added using PrintJob.addPage() to be printed and spooling to stop.

When a new print job is constructed, the PrintJob() properties are initialized to 0. When PrintJob.start() is called, after the user selects the print option in the operating system print dialog box, Flash Player retrieves the print settings from the operating system. The PrintJob.start() function populates the following properties:

Property

Type

Unit

Notes

PrintJob.paperHeight

number

points

Overall paper height.

PrintJob.paperWidth

number

points

Overall paper width

PrintJob.pageHeight

number

points

Height of actual printable area on the page; does not include any user-set margins

PrintJob.pageWidth

number

points

Width of actual printable area on the page; does not include any user-set margins

PrintJob.orientation

string

n/a

Portrait or Landscape orientation

Note: A point is a print unit of measurement that is equal in size to one pixel, a screen unit of measure. For more information about unit equivalencies, see About scaling.