Functions/Properties

Setup & configuration

• componentVersion: Retrieve the component version number.
• setConfig: Process a configuration command.

Opening & closing PDF files

• loadFile: Load a PDF file from disk.
• loadFileWithPassword: Load a PDF file from disk, with a password.
• loadStream: Load a PDF file from an OLE IStream object.
• loadStreamWithPassword: Load a PDF file from an OLE IStream object, with a password.
• loadURL: Load a PDF file from via a URL.
• loadURLWithPassword: Load a PDF file via a URL, with a password.
• closeFile: Close the currently open PDF file.

PDF file information

• numPages: Get the number of pages.
• getPageWidth: Get the width of the specified page.
• getPageHeight: Get the height of the specified page.
• getPageBoxXMax: Get the maximum x coordinate of the specified page box.
• getPageBoxXMin: Get the minimum x coordinate of the specified page box.
• getPageBoxYMax: Get the maximum y coordinate of the specified page box.
• getPageBoxYMin: Get the minimum y coordinate of the specified page box.
• getPageSize: Get the size of the specified page.
• getPageRotation: Get the default rotation for the specified page.
• getPageUserUnit: Get the UserUnit scaling factor for the specified page.
• okToPrint: Check to see if the PDF file allows printing.
• fileIsDamaged: Check to see if the PDF file is damaged.
• getInfoString: Get the content of a document info field.
• getViewerPreference: Return an entry from the ViewerPreferences dictionary.

Printer list

• getNumPrinters: Get the number of available printers.
• getPrinterName: Get a printer name.
• getNumBins: Get the number of available paper bins/trays.
• getBinID: Get a paper bin ID.
• getBinName: Get a paper bin name.
• getNumPapers: Get the number of available paper sizes.
• getPaperID: Get a paper size ID.
• getPaperName: Get a paper size name.
• getPaperSize: Get a paper size.
• getNumMediaTypes: Get the number of available media types.
• getMediaTypeID: Get a media type ID.
• getMediaTypeName: Get a media type name.
• printerSupportsCollation: Check to see if a printer supports collation.
• printerSupportsColor: Check to see if a printer supports color printing.
• printerSupportsDuplexing: Check to see if a printer supports duplex printing.
• printerSupportsQuality: Check to see if a printer supports the print quality setting.
• printerSupportsPostScript: Check to see if a printer supports PostScript.

Printing

• printPDF4: Print a PDF file.

Print job API

• startJob: Start a print job.
• printToJob: Add pages to a print job.
• printOtherFileToJob: Add pages from another PDF file to a print job.
• printBlankPageToJob: Add a blank page to a print job.
• printJobPageCount: Get the number of pages printed so far in a print job.
• finishJob: Finish a print job.

Printing parameters

• resetParams: Reset all printing parameters to their default values.
• printer: Set the printer name.
• binID: Set the paper bin ID.
• paperID: Set the paper size/type ID.
• customPaperWidth: Set a custom paper width.
• customPaperHeight: Set a custom paper height.
• paperMatch: Match paper to page size.
• mediaTypeID: Set the media type ID.
• paperOrientation: Pass page orientation info to the printer.
• printToFile: Set the name for the print output file.
• queueName: Set the name to show in the print queue.
• pages: Set the pages to print.
• firstPage: Set the first page to print.
• lastPage: Set the last page to print.
• rectLLX: Set the lower-left x coordinate of the rectangular window of the page to be printed.
• rectLLY: Set the lower-left y coordinate of the rectangular window of the page to be printed.
• rectURX: Set the upper-right x coordinate of the rectangular window of the page to be printed.
• rectURY: Set the upper-right y coordinate of the rectangular window of the page to be printed.
• xScale: Set the horizontal scale factor.
• yScale: Set the vertical scale factor.
• xOffset: Set the horizontal offset from the lower-left corner of the paper.
• yOffset: Set the vertical offset from the lower-left corner of the paper.
• rotate: Set the page rotation.
• printableArea: Scale pages to fit the printable area.
• expandSmallPages: Scale up pages that area smaller than the paper.
• forceGDI: Force the print operation to go through GDI.
• forceImage: Force printing each page as an image.
• rawSpoolFile: Force the spool file to be in raw format.
• duplex: Set the duplexing mode.
• duplexDefault: Use the printer's default duplex setting.
• duplexVert: Duplex printing with long-edge (vertical) binding.
• duplexHoriz: Duplex printing with short-edge (horizontal) binding.
• simplex: Simplex printing.
• forceMono: Force printing in monochrome.
• forceColor: Force printing in color.
• hDPI: Set the horizontal print resolution.
• vDPI: Set the vertical print resolution.
• quality: Set the print quality.
• copies: Set the number of copies.
• collate: Set the collation mode.
• collateDefault: Use the printer's default collation setting.
• collateTrue: Collate when printing multiple copies.
• collateFalse: Do not collate when printing multiple copies.
• emulatedMultiCopy: Enable/disable emulated multi copy mode.
• priority: Set the print job priority.
• owner: Set the print job owner.
• notifyName: Set the print job notification name.
• startPaused: Start the print job paused.

PostScript options

• setPSCustomDocSetup: Set a string to be included in the PostScript DocSetup section.
• setPSCustomPageSetup: Set a string to be included in the PostScript PageSetup section.

Print information

• getJobID: Get the job ID for the most recent print job.
• getPageCount: Get the page count for the most recent print call.

Text overlays

• addOverlayText: Add an overlay text item.
• overlayUnder: Place the overlay text 'under' other drawn objects.
• clearOverlayText: Clear all overlay text items.

GDI overlays

• gdiOverlay: Event fired at the end of each page.

Print status and aborting

• printStatus: Event fired periodically while printing.
• abortPrint: Abort an in-progress print job.

Layers

• getNumLayers: Get the number of layers.
• getLayer: Get a layer handle.
• getLayerName: Get the name of a layer.
• getLayerVisibility: Get the visibility state of a layer.
• setLayerVisibility: Set the visibility state of a layer.
• getLayerViewState: Get the suggested state of a layer for viewing mode.
• getLayerPrintState: Get the suggested state of a layer for printing mode.
• getLayerOrderRoot: Get the root of the layer display order tree.
• getLayerOrderIsName: Check to see if a layer display order node is a name.
• getLayerOrderName: Get the name of a layer display order node.
• getLayerOrderLayer: Get the layer associated with a layer display order node.
• getLayerOrderNumChildren: Get the number of children attached to a layer display order node.
• getLayerOrderChild: Get a child of a layer display order node.

Embedded files

• getNumEmbeddedFiles: Get the number of embedded files.
• getEmbeddedFileName: Get the name of an embedded file.
• saveEmbeddedFile: Save an embedded file.

Miscellaneous

• errorMsg: Error event.
• clearWin32ErrorInfo: Clear Win32 API error function and error code.
• getWin32ErrorFunc: Return the name of the last Win32 API function to fail.
• getWin32ErrorCode: Return the error code of the last Win32 API function to fail.