Events

<< Click to Display Table of Contents >>

Navigation:  Printing Process > IPXCPrinter Interface >

Events


 

DAPI_ICON_ Events

 


 

The IPXCPrinter interface details events that developers can use to determine the stages of PDF creation within their applications. Events are grouped into two categories:

 

Asynchronous events fire when documents are spooled. The PDF-XChange Drivers API does not wait for the host application to receive and return them. They are fired independently in order to prevent dead-locking and host applications receive them immediately.

 

Synchronous events are fired when documents are generated. The PDF-XChange Drivers API waits for host applications to complete them before proceeding further.

 

All events have a JobID parameter that specifies the internal Job identifier of the printed document. These IDs can be used to determine the document from which the event was fired when multiple documents are printing.

 

The following events are supported in the PDF-XChange Drivers API:

 

Asynchronous Events:

 

Event OnStartDoc is fired when printing starts for a new document.

Event OnStartPage is fired when printing starts to for a new page.

Event OnEndPage is fired when printing is complete for a page.

Event OnEndDoc is fired when the GDI spools a complete document.

 

Synchronous Events:

 

Event OnDocSpooled is fired immediately when the PDF-XChange Drivers API starts processing documents printed by the GDI.

Event OnFileSaved is fired when documents are saved.

Event OnFileSent is fired when automatic document emailing is enabled and the associated email has been sent. See Email for further information.

Event OnError is fired when an error occurs during document processing.