Class Ecrion.Ultrascale::Engine

Top Previous Topic Next Topic  Print this topic

Engine represents a single instance of a renderer. To use it, the Render method must be called.

 

Methods

 

Name

Description

Render

Renders an input data source into an output stream.

Render

Renders an input data source into an output stream and gets the number of pages.

GetNewMergeContextID

Creates a unique merge context identifier.

 

Render

Takes an input stream, a set of parameters and generates the output.

 

 

       public void Render(IDataSource dataSource, Stream outputStream, RenderingParameters parameters)

 

                       

Parameters

 

dataSource

       The input data source; reading is performed from the current position.

outputStream

       The file path where the renderer should place the output.

parameters

       A set of parameters that will customize the conversion. The structure is described in detail here.

 

 

Render

Renders a document using the supplied input and gets the number of pages.

 

 

       public void Render(IDataSource dataSource, Stream outputStream, RenderingParameters parameters, ref OutputInformation info)

 

                       

Parameters

 

dataSource

       The input data source; reading is performed from the current position.

outputStream

       The file path where the renderer should place the output.

parameters

       A set of parameters that will customize the conversion. The structure is described in detail here.

info

       An OutputInformation object. The structure is described in detail here.

 

Note:

The number of pages in a document can be returned without actually rendering it. In order to accomplish this, ComputePageCountOnly from RenderingParameters must be set to "true".

 

GetNewMergeContextID

Creates a unique merge context identifier.

 

 

       public static String GetNewMergeContextID()

 

                       

Obsolete Methods

Render

 

       public void Render(Stream inputStream, Stream outputStream, RenderingParameters parameters)

 

Deprecated. Instead, Render must be used.

 

Render

 

       public void Render(Stream inputStream, Stream outputStream, RenderingParameters parameters, ref OutputInformation info)

 

Deprecated. Instead, Render must be used.

 

GetPageCount

 

       public int GetPageCount(Stream inputStream, RenderingParameters parameters)

 

Deprecated. Instead, Render and set ComputePageCountOnly from RenderingParameters, set to "true", must be used.