Public Member Functions | List of all members
IPrintEngine Struct Referenceabstract

Interface used by printer drivers and print event handlers to access print engine properties during print processing. More...

#include <IPrintEngine.h>

Public Member Functions

virtual IPlotterP GetEnginePlotter ()=0
 Returns the current engine IPlotter instance. More...
 
virtual bool IsPreview () const =0
 Indicates if print preview is currently in progress. More...
 
virtual bool IsLegacyPreview () const =0
 Indicates if legacy print preview (e.g. plotdlg) is currently in progress. More...
 
virtual bool IsPartOfPrintSet () const =0
 Indicates if printing as a set. More...
 
virtual bool IsRasterized () const =0
 Indicates if printing in rasterized mode. More...
 
virtual int GetNumCopies () const =0
 Gets the number of copies. More...
 
virtual bool WasGeometryOutput () const =0
 Indicates whether any geometry was output during print processing. More...
 
virtual Transform GetTransform (PlotTagTransform tag) const =0
 Gets the value of the requested print transform. More...
 
virtual PlotFileSpecCR GetOutputFileSpec () const =0
 Gets the output file specification. More...
 
virtual void GetPrintDefinitionName (WStringR value) const =0
 Gets the name of the current print definition. More...
 
virtual void GetPrintDefinitionSourceFspec (PlotFileSpecR value) const =0
 Gets the source file specification of the current print definition. More...
 
virtual void GetPrintSetPropertyValue (WCharCP name, PlotPropValueR value) const =0
 Gets the value of the specified property for the current print set. More...
 
virtual void GetPrintDefinitionPropertyValue (WCharCP name, PlotPropValueR value) const =0
 Gets the value of the specified property for the current print definition. More...
 
virtual bool IsPlotBorderLicenseLabelNeeded () const =0
 Indicates whether a license string must be added to the plot border label. More...
 
virtual void GetLicenseLabel (WStringR label) const =0
 Get the license string to be added to the plot border label. More...
 
virtual IPrintEngineCapabilityR Capability ()=0
 Gets/Sets print engine capabilities. More...
 
virtual ICadPrintHandlerP GetCadPrintHandler ()=0
 Gets the CAD print handler interface. More...
 

Detailed Description

Interface used by printer drivers and print event handlers to access print engine properties during print processing.

Member Function Documentation

virtual IPrintEngineCapabilityR Capability ( )
pure virtual

Gets/Sets print engine capabilities.

virtual ICadPrintHandlerP GetCadPrintHandler ( )
pure virtual

Gets the CAD print handler interface.

Remarks
May be NULL. Internal use only.
virtual IPlotterP GetEnginePlotter ( )
pure virtual

Returns the current engine IPlotter instance.

virtual void GetLicenseLabel ( WStringR  label) const
pure virtual

Get the license string to be added to the plot border label.

virtual int GetNumCopies ( ) const
pure virtual

Gets the number of copies.

virtual PlotFileSpecCR GetOutputFileSpec ( ) const
pure virtual

Gets the output file specification.

virtual void GetPrintDefinitionName ( WStringR  value) const
pure virtual

Gets the name of the current print definition.

virtual void GetPrintDefinitionPropertyValue ( WCharCP  name,
PlotPropValueR  value 
) const
pure virtual

Gets the value of the specified property for the current print definition.

virtual void GetPrintDefinitionSourceFspec ( PlotFileSpecR  value) const
pure virtual

Gets the source file specification of the current print definition.

virtual void GetPrintSetPropertyValue ( WCharCP  name,
PlotPropValueR  value 
) const
pure virtual

Gets the value of the specified property for the current print set.

virtual Transform GetTransform ( PlotTagTransform  tag) const
pure virtual

Gets the value of the requested print transform.

virtual bool IsLegacyPreview ( ) const
pure virtual

Indicates if legacy print preview (e.g. plotdlg) is currently in progress.

virtual bool IsPartOfPrintSet ( ) const
pure virtual

Indicates if printing as a set.

virtual bool IsPlotBorderLicenseLabelNeeded ( ) const
pure virtual

Indicates whether a license string must be added to the plot border label.

virtual bool IsPreview ( ) const
pure virtual

Indicates if print preview is currently in progress.

virtual bool IsRasterized ( ) const
pure virtual

Indicates if printing in rasterized mode.

virtual bool WasGeometryOutput ( ) const
pure virtual

Indicates whether any geometry was output during print processing.


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

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