Public Member Functions | List of all members
IPrintSetEventHandler Struct Referenceabstract

An event handler interface for printing system events related to print sets. More...

#include <IPlotHook.h>

Public Member Functions

virtual StatusInt BeginPrintSet (IBeginPrintSetParamP param)=0
 Called before the print engine begins work on the first page of a print set. More...
 
virtual StatusInt EndPrintSet (IEndPrintSetParamP param)=0
 Called after the last page in a print set has been completed. More...
 
virtual void PrePrintSetDefinition (IPrePrintSetDefinitionParamP param)=0
 Called before processing each print definition when printing as a set. More...
 

Detailed Description

An event handler interface for printing system events related to print sets.

Remarks
The events in this interface are called in a different process than those in IPrintEventHandler. This interface must be implemented in the same class as IPrintEventHandler and (except when implemented by a printer driver) registered using MstnEventManager::AddPrintEventHandler (IPrintEventHandler).

Member Function Documentation

virtual StatusInt BeginPrintSet ( IBeginPrintSetParamP  param)
pure virtual

Called before the print engine begins work on the first page of a print set.

Remarks
This event is not invoked unless printing as a set to printer drivers that support set printing (i.e. PDF). This event is only called within the interative (primary) process. It is not invoked within the Print Organizer worker process. Neither the global print engine nor its internal Plotter instance has been created yet, so no IPrintEngine or IPlotter calls are permitted during this event.
Parameters
[in]paramEvent parameters.
Returns
SUCCESS to continue print processing; ERROR to abort the plot.
virtual StatusInt EndPrintSet ( IEndPrintSetParamP  param)
pure virtual

Called after the last page in a print set has been completed.

Remarks
This event is not invoked unless printing as a set, to printer drivers that support set printing (i.e. PDF). This event is only called within the interative (primary) process. It is not invoked within the Print Organizer worker process. This event is called even if the print job fails. Use param.GetIsSuccess to query the job status.
Parameters
[in]paramEvent parameters.
Returns
SUCCESS or ERROR.
virtual void PrePrintSetDefinition ( IPrePrintSetDefinitionParamP  param)
pure virtual

Called before processing each print definition when printing as a set.

Remarks
This event is not invoked unless printing as a set, to printer drivers that support set printing (i.e. PDF). This event is only called within the interative (primary) process. It is not invoked within the Print Organizer worker process. Important: The capability to change the output file name here is provided for use by printer drivers only. Normal print event handlers should not attempt to change the output file name during this event.
Parameters
[in]paramEvent parameters.

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.