←Select platform

SetAnnRenderingEngineInstance Method

Summary

Sets the rendering engine to use when overlaying annotations during document conversion.

Syntax

Java

C++

public void SetAnnRenderingEngineInstance( 
   AnnRenderingEngine instance 
)

Public Sub SetAnnRenderingEngineInstance( 
   ByVal instance As AnnRenderingEngine 
)

public:  
   void SetAnnRenderingEngineInstance( 
      AnnRenderingEngine^ instance 
   )

public void setAnnRenderingEngineInstance(AnnRenderingEngine instance)

Parameters

instance

The rendering engine to use when overlaying annotations during document conversion.

Remarks

The AnnRenderingEngine instance passed to this method will be used when the any job has the value of AnnotationsMode set to DocumentConverterAnnotationsMode.Overlay and raster conversion is used.

You must initialize this object with the IAnnObjectRenderer's to use before starting any conversion if annotation containers are to be overlayed on images.

AnnRenderingEngineInstance will return the same value passed for instance.

The previously set AnnRenderingEngineInstance is removed when a new instance is set. You can set a value of null.

Example

For an example, refer to DocumentConverter.

Requirements

Target Platforms