Public Member Functions | List of all members
IPrintEventHandler2 Struct Referenceabstract

An event handler interface for more per-page printing system events. More...

#include <IPlotHook.h>

Public Member Functions

virtual void PrePrintDefinition (IPrePrintDefinitionParamP param)=0
 Called before processing each print definition. More...
 
virtual void PrePenChart (IPlotPrePenChartParamP param)=0
 Called during print engine setup, before the print engine plotter is completely configured. More...
 
virtual void PreElementScan (IPlotPreElementScanParamP param)=0
 Called just before the print engine begins the element scanning loop. More...
 
virtual void PostElementScan (IPlotPostElementScanParamP param)=0
 Called just after the print engine finishes the element scanning loop. More...
 
virtual void GetColorTable (IPlotGetColorTableParamP param)=0
 Called just after the print engine gets the color table for a model. More...
 
virtual void OnNewModelRef (IPlotPreModelParamP param)=0
 Called before the specified model is printed, and before any of the transformations and other settings related to the model have been set up. More...
 
virtual void PreModel (IPlotPreModelParamP param)=0
 Called before the print engine begins scanning elements in the specified model, after plot structure setup for the model has been completed. More...
 
virtual void PreDynamicViewClip (IPreDynamicViewClipParamP param)=0
 Called before the plot begins to acquire the dynamic view clip for a model. More...
 
virtual void BeginElement (IPlotBeginElementParamP param)=0
 Gives applications the opportunity to replace the element being plotted, or defer the element with an assigned display list priority. More...
 
virtual void EndElement (IPlotEndElementParamP param)=0
 Called when the print engine has finished output and post-processing of the specified element. More...
 
virtual void PreElementOutput (IPlotPreElementOutputParamP param)=0
 Called before the specified element has been output. More...
 
virtual void PostElementOutput (IPlotPostElementOutputParamP param)=0
 Called after the specified element has been output. More...
 
virtual void Resymbolize (IPlotResymbolizeParamP param)=0
 Gives applications the opportunity to modify the current output symbology. More...
 
virtual void PostPlotFileOpen ()=0
 Called during cleanup operations after plot processing has finished. More...
 
virtual void PostPlotFileClosed ()=0
 Called during cleanup operations after plot processing has finished. More...
 

Detailed Description

An event handler interface for more per-page printing system events.

Remarks
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 void BeginElement ( IPlotBeginElementParamP  param)
pure virtual

Gives applications the opportunity to replace the element being plotted, or defer the element with an assigned display list priority.

Remarks
Priority may be assigned without replacing the element. The input element descriptor may not be modified in any way. For example, this method may implement text substution or patterning appending linkages or changing the text characters. Since copying element descriptors hurts performance, simple symbology changes are best performed in the Resymbolize event.
Parameters
[in]paramEvent parameters.
virtual void EndElement ( IPlotEndElementParamP  param)
pure virtual

Called when the print engine has finished output and post-processing of the specified element.

Remarks
The EndElement event is invoked for every element seen by BeginElement, even if that element was not printed.
Parameters
[in]paramEvent parameters.
virtual void GetColorTable ( IPlotGetColorTableParamP  param)
pure virtual

Called just after the print engine gets the color table for a model.

Remarks
Applications may use this event to override the default color table. Printing-specific overrides such as automatic white-to-black inversion and printer-driver-defined output colors are applied after this method returns.
Parameters
[in]paramEvent parameters.
virtual void OnNewModelRef ( IPlotPreModelParamP  param)
pure virtual

Called before the specified model is printed, and before any of the transformations and other settings related to the model have been set up.

Remarks
This event provides the opportunity to prevent the model from printing before any of the setup processing has begun.
Parameters
[in]paramEvent parameters.
virtual void PostElementOutput ( IPlotPostElementOutputParamP  param)
pure virtual

Called after the specified element has been output.

Parameters
[in]paramEvent parameters.
virtual void PostElementScan ( IPlotPostElementScanParamP  param)
pure virtual

Called just after the print engine finishes the element scanning loop.

Remarks
When printing in rasterized mode, this event is called once per tile.
Parameters
[in]paramEvent parameters.
virtual void PostPlotFileClosed ( )
pure virtual

Called during cleanup operations after plot processing has finished.

Remarks
The plot buffer has been flushed, and the plot file (if one) has been closed. Post-plot operating system commands (if any) have not yet been executed. This event is not called for print preview, or in the event of plot failure.
virtual void PostPlotFileOpen ( )
pure virtual

Called during cleanup operations after plot processing has finished.

Remarks
The plot buffer has not been flushed, and the plot file (if one) is still open. It is not called for print preview, or in the event of plot failure.
virtual void PreDynamicViewClip ( IPreDynamicViewClipParamP  param)
pure virtual

Called before the plot begins to acquire the dynamic view clip for a model.

Parameters
[in]paramEvent parameters.
virtual void PreElementOutput ( IPlotPreElementOutputParamP  param)
pure virtual

Called before the specified element has been output.

Remarks
Depending on the actions of other print event handlers, this element may be different than the one seen in the BeginElement event. Elements ignored by BeginElement handlers will not be seen by the PreElementOutput/PostElementOutput events.
Parameters
[in]paramEvent parameters.
virtual void PreElementScan ( IPlotPreElementScanParamP  param)
pure virtual

Called just before the print engine begins the element scanning loop.

Remarks
At this point, the print engine and printer driver are fully initialized. Note that when printing in rasterized mode, this event is called once for each tile.
Parameters
[in]paramEvent parameters.
virtual void PreModel ( IPlotPreModelParamP  param)
pure virtual

Called before the print engine begins scanning elements in the specified model, after plot structure setup for the model has been completed.

Parameters
[in]paramEvent parameters.
virtual void PrePenChart ( IPlotPrePenChartParamP  param)
pure virtual

Called during print engine setup, before the print engine plotter is completely configured.

Remarks
Non-system-printer drivers have been loaded, but have not yet been initialized. This event gives applications the opportunity to override the printer driver's pen setup before the print engine configures its pen chart and color table.
Parameters
[in]paramEvent parameters.
virtual void PrePrintDefinition ( IPrePrintDefinitionParamP  param)
pure virtual

Called before processing each print definition.

Remarks
Invoked after the source file has been loaded into the worker process and before the print output file name has been determined for Print Organizer. Primary purpose is to obtain the print output file name in the context of the Print Organizer worker process.
Parameters
[in]paramEvent parameters.
virtual void Resymbolize ( IPlotResymbolizeParamP  param)
pure virtual

Gives applications the opportunity to modify the current output symbology.

Remarks
This event may be invoked multiple times for a given element.
Parameters
[in]paramEvent parameters.

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

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