The RenderingParameters object encapsulates all customizable parameters that can override the settings specified in the Management Console.

 

Members

 

 

afpOutputFlags

Specifies options for generating AFP output. Default value is "0", that is, system wide options configured in the Management Console will be used. A detailed description of each flag can be found here.

 

 

       STDMETHOD(put_afpOutputFlags)(int  newVal);

 

 

pdfOutputFlags

Specifies options for generating PDF output. Default value is "0", that is, system wide options configured in the Management Console will be used. A detailed description of each flag can be found here.

 

 

       STDMETHOD(put_pdfOutputFlags)(int  newVal);

 

 

pdfOutputPermissionFlags

Specifies permission options for generating encrypted PDF output. Default value is "0", that is, system wide options configured in the Management Console will be used. A detailed description of each flag can be found here.

 

 

       STDMETHOD(put_pdfOutputPermissionFlags)(int  newVal);

 

 

pdfEncryptionStrength

Password encryption strength for encrypted PDF output. Valid values are "128" and "40". Default is "40".

 

 

       STDMETHOD(put_pdfEncryptionStrength)(int  newVal);

 

 

baseURL

Base URL for relative paths.

 

 

       STDMETHOD(put_baseUrl)(BSTR   newVal);

 

 

inputBytesID

This string identifies the stream of input bytes and is logged into the server log files. It is not used by the engine in any way during processing and does not affect the output. By default, it is set to the name of the current input file, for troubleshooting purposes, and it is highly recommended that it will be used as mentioned.

 

 

       STDMETHOD(put_inputBytesID)(BSTR   newVal);

 

 

inputFormat

The input format. A detailed description of the possible values can be found here.

 

 

       STDMETHOD(put_inputFormat)(InputFormat newVal);

 

 

outputBytesID

This string identifies the stream of output bytes and is logged into the server log files. It is not used by the engine in any way during processing and does not affect the output. By default, it is set to the name of the current output file for troubleshooting purposes and it highly recommended that it will used be as mentioned.

 

 

       STDMETHOD(put_outputBytesID)(BSTR   newVal);

 

 

outputFormat

The output format. A detailed description of the possible values can be found here.

 

 

       STDMETHOD(put_outputFormat)(OutputFormat  newVal);

 

 

serverPort

The server port used by XF Rendering Server 2013 service to listen for requests. Default value is "1099".

 

 

       STDMETHOD(put_serverPort)(int newVal);

 

 

xResolution

Horizontal resolution for raster (BMP, JPEG, etc.) and AFP output. Default value is "0", that is, the resolution will have the default value for the specified output format. For AFP output, the default value for horizontal and vertical resolutions is "144" (1440 DPI).

 

 

       STDMETHOD(put_xResolution)(int  newVal);

 

 

yResolution

Vertical resolution for raster (BMP, JPEG, etc.) and AFP output. Default value is "0", that is, the resolution will have the default value for the specified output format. For AFP output, the default value for horizontal and vertical resolutions is "144" (1440 DPI).

 

 

       STDMETHOD(put_yResolution)(int  newVal);

 

 

useResolverThread

Specifies whether or not to use the reference resolver thread for XSL-FO documents. The default value is "true", but the user can set it to "false" if the documents do not have elements  such as fo:retrieve-marker or fo:page-number-citation that require the engine to lookup certain elements. In this case, not using the resolver thread will improve processing speed.

 

 

       STDMETHOD(put_useResolverThread)(VARIANT_BOOL  newVal);

 

 

userName

The username used for authenticating the request. If it is left blank, the default "Guest" account will be used.

 

 

       STDMETHOD(put_userName)(BSTR newVal);

 

 

password

The password used for authenticating the request. If it is left blank, the default "Guest" account will be used and no password is required.

 

 

       STDMETHOD(put_password)(BSTR newVal);

 

 

pdfUserPassword

The user password set for the encrypted PDF output. Opening the document with the correct user password (or opening a document that does not have a user password) allows additional operations to be performed according to the access permissions specified in the document’s encryption dictionary.

 

 

       STDMETHOD(put_pdfUserPassword)(BSTR  newVal);

 

 

pdfOwnerPassword

The owner password set for the encrypted PDF output. Opening the document with the correct owner password allows full (owner) access to the document. This unlimited access includes the ability to change the document’s passwords and access permissions.

 

 

       STDMETHOD(put_pdfOwnerPassword)(BSTR  newVal);

 

 

imageErrorsHandlingMode

Controls how the engine should react when an image is not found. The possible values and their meanings can be found here.

 

 

       STDMETHOD(put_imageErrorsHandlingMode)(ImageErrorsHandlingMode  newVal);

 

 

autoLayoutRowCount

When performing automatic tables layout, the engine will, by default, look only at a limited number of rows.

To set all table rows, the value must be set to "-1". However, this action may drastically affect the performance if the document has large tables. The default value is "100".

 

 

       STDMETHOD(put_autoLayoutRowCount)(int  newVal);

 

 

compressionAlgorithm

Specifies the compression algorithm to use for TIFF images. The possible values and their meanings can be found here.

 

 

       STDMETHOD(put_compressionAlgorithm)(CompressionAlgorithm  newVal);

 

 

zoomFactor

Specifies the scaling factor that will be applied to the raster output. The value has to be greater than "0". Default value is "100". Values between "0" and "100" will scale the image down (zoom out), while values above "100" will zoom in. For example, a value of "50" is equivalent to a 50% zoom, while "200" is equivalent to a 200% zoom.

 

 

       STDMETHOD(put_zoomFactor)(int  newVal);

 

 

printerName

A string specifying the name of the printer.

 

 

       STDMETHOD(put_printerName)(BSTR  newVal);

 

 

mergeContextID

Merge context identifier. Use this when the rendering operation is part of a larger merge operation. To obtain a new merge context identifier use the method shown here.

 

 

       STDMETHOD(put_mergeContextID)(BSTR  newVal);

 

 

isLastDocumentInMergeContext

Specifies whether this is the last document in the merge context. If set to "true", the merge context will be closed after this rendering operation.

 

 

       STDMETHOD(put_isLastDocumentInMergeContext)(VARIANT_BOOL  newVal);

 

 

maxMergeContextInactivityTTL

The TTL (Time To Live) for an inactive merge context, in seconds. The merge context will be automatically discarded by the server after the specified period of inactivity. Default value is "120" seconds.

 

 

       STDMETHOD(put_maxMergeContextInactivityTTL)(int  newVal);

 

 

retryFailedRequests

Specifies whether to retry the requests that have failed. The default value is "false".

 

 

       STDMETHOD(put_retryFailedRequests)(VARIANT_BOOL  newVal);

 

 

requestTimeout

Specifies the timeout for a request, in seconds. The default value is "0".

 

 

       STDMETHOD(put_requestTimeout)(int  newVal);

 

 

preloadDocument

Preload the document before rendering. With this flag enabled, the whole document will be loaded in memory and the XSL-FO engine will be more permissive with static contents placement. The default is "false".

 

 

       STDMETHOD(put_preloadDocument)(VARIANT_BOOL  newVal);

 

 

smoothingMode

Specifies the type of smoothing (antialiasing) that is applied to images. This parameter affects image output formats. Possible values are "Default" (system settings), "None" and "AntiAlias".

 

 

       STDMETHOD(put_smoothingMode)(SmoothingMode  newVal);

 

 

pageIdx

Default value is "-1", indicating that for SVG output all pages are rendered. For JPEG / GIF / PNG/ BMP outputs only the first page is rendered.

 

 

       STDMETHOD(put_pageIdx)(int  newVal);

 

 

pdfImageCompression

Specifies the compression type for PDF images. The possible values are PIC_FLAT (indicating FLAT compression) and PIC_JPEG (indicating JPEG compression).

 

 

       STDMETHOD(put_pdfImageCompression)(PDFImageCompression  newVal);

 

 

outputPrintFile

Specifies the name of a PCL output file. If this parameter is empty, the output will be sent direct to the printer. The default value is an empty string.

 

 

       STDMETHOD(put_outputPrintFile)(BSTR  newVal);

 

 

htmlInputSettings

Specifies various settings for HTML input. HtmlInputSettings is available for more information.

 

 

       STDMETHOD(put_htmlInputSettings)(VARIANT newVal);

 

 

htmlOutputSettings

Specifies various settings for HTML output. HtmlOutputSettings is available for more information.

 

 

       STDMETHOD(put_htmlOutputSettings)(VARIANT newVal);

 

 

dasAddress

Specifies the address of the server hosting the Data Aggregation Service. The default value is "127.0.0.1".

 

 

       STDMETHOD(put_dasAddress)(BSTR  newVal);

 

 

dasPort

Specifies the port of the server hosting the Data Aggregation Service. The default value is "50000".

 

 

       STDMETHOD(put_dasPort)(int  newVal);

 

 

licenseKey

Specifies the license key.

 

 

       STDMETHOD(put_licenseKey)(BSTR  newVal);

 

 

 

 

docTemplate

 

Specifies the layout template that will apply to XML data. This parameter must be specified when InputFormat is Engine.InputFormat.XML

Can be an instance of either a ServerDocumentTemplate or LocalDocumentTemplate.

 

 

       STDMETHOD(put_docTemplate)(VARIANT newVal);

 

 

 

 

serverAddress

 

The server name or IP address used to perform the conversion. XF Rendering Server 2013 must be installed and listening on the port specified by. Default value is "127.0.0.1", that is, the local computer.

 

 

       STDMETHOD(put_serverAddress)(BSTR newVal);