|
Class Ecrion::Ultrascale::RenderingParameters |
|
|
Class Ecrion::Ultrascale::RenderingParameters |
|
The RenderingParameters object encapsulates all customizable parameters that can override the settings specified in the Management Console.
Members
Name |
Description |
Specifies options for generating AFP output. |
|
Specifies options for generating PDF output. |
|
Specifies permission options for generating encrypted PDF output. |
|
Password encryption strength for encrypted PDF output. |
|
Base URL for relative paths. |
|
This string identifies the stream of input bytes and is logged into the server log files. |
|
The input format. |
|
This string identifies the stream of output bytes and is logged into the server log files. |
|
The output format. |
|
The serverAddress name or IP address used to perform the conversion. |
|
The server port used by XF Ultrascale 2011 service to listen for requests. |
|
Horizontal resolution for raster (BMP, JPEG, etc.) and AFP output. |
|
Vertical resolution for raster (BMP, JPEG, etc.) and AFP output. |
|
Specifies whether or not to use the reference resolver thread for XSL-FO documents. (obsolete) |
|
Specifies options for resolving references(page-number-citation, page-number etc.). |
|
A string that uniquely identifies a server template that will be used to format the input provided as IF_XML. |
|
An XSLT or XFD template that will be used to format the input provided as IF_XML. |
|
The XSLT engine used to transform the input provided as IF_XML. |
|
The user name used to authenticate this request. |
|
The password used to authenticate this request. |
|
The user password for encrypted PDF output. |
|
The owner password for encrypted PDF output. |
|
Controls the engine's behaviour whenever an image is not found. |
|
Sets the number of rows to be used for determining column widths when performing automatic table layout. |
|
Specifies the compression algorithm to be used for TIFF images. |
|
The scaling factor that will be applied to the raster output. |
|
Merge context identifier. |
|
Used to specify whether this document is the last one in the specified merge context. |
|
The TTL (Time To Live) for an inactive merge context, in seconds. |
|
Specifies whether to retry the requests that have failed. |
|
Sets the timeout for a request. |
|
Preload the document before rendering. Useful to avoid strict validation errors in XSL-FO documents. |
|
Antialiasing mode for images. |
|
The page index to render. Meaningful only for JPEG / GIF / PNG / SVG output. |
|
The image compression for PDF (FLAT or JPEG). |
|
Settings for HTML input. |
|
Settings for HTML output. |
|
Specifies settings for printer. |
|
DAS server address. |
|
DAS server port. |
|
Specifies the language used for XFD translation. |
|
Specifies the language that must be used by the server to translate the XFD template. |
|
Specifies the paramters for XSL transformations. |
|
Enables/disables layout when resolving compatibility issues between XSLFO input format and HTML/EPUB/WordML output format. Layout will improve quality but will decrease rendering speed. Default is true(layout enabled). |
|
Compute and get page count based on input stream; no output will be rendered but <see cref="OutputInformation"/> will contain the number of pages for this document. Default value is false. |
|
The license key used to initialize the engine. Only the first call to render() will initialize the engine. |
|
Specifies settings for txt output. |
|
This value will be a combination of elements in RenderingFeedback enumeration e.g. renderingFeedback = RF_SendLog | RF_SendProgress. |
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.
int afpOutputFlags
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.
int pdfOutputFlags
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.
int pdfPermissionOutputFlags
Password encryption strength for encrypted PDF output. Valid values are 128 and 40. Default is 40.
int pdfEncryptionStrength
Base URL for relative paths.
String baseUrl
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 we highly recommend that it be used this way.
String inputBytesID
The input format. A detailed description of the possible values can be found here.
InputFormat inputFormat
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 we highly recommend that it be used this way.
String outputBytesID
The output format. A detailed description of the possible values can be found here.
OutputFormat outputFormat
The server name or IP address used to perform the conversion. XF Ultrascale 2011 must be installed and listening on the port specified by. Default value is "127.0.0.1", that is, the local computer.
String server
The server port used by the XF Ultrascale 2011 service to listen for requests. Default value is 1099.
int serverPort
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).
int xResolution
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).
int yResolution
Specifies whether or not to use the reference resolver thread for XSL-FO documents. The default value is true, but you can set it to false if your documents don't have elements like 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.
bool useResolverThread
Some FO documents have elements like fo:retrieve-marker or fo:page-number-citation that require the engine to lookup certain elements. The ReferenceResolverType parameter specifies options for resolving references.
A detailed description of the possible values can be found here.
ReferenceResolverType referenceResolverType;
A string that uniquely identifies a server template. It must be specified as "ApplicationName:TemplateName", where template name includes the file extension (usually xfd, xsl, xslt). This parameter will be used only when inputFormat is IF_XML. Also note that it is mutually exclusive with templateStream.
String serverTemplateID
An XSLT or XFD template that will be used by the server to format the input provided as IF_XML. Mutually exclusive with serverTemplateID.
Stream* templateStream
The engine to use when applying XSL transformations to an input provided as IF_XML. A detailed description of the possible values can be found here. Default is XE_MSXML.
XsltEngine xsltEngine
The user name used to authenticate this request. Leave blank if you want to run under the Guest account.
String userName
The password used to authenticate this request. Leave blank if you want to run under the Guest account.
String password
The user password for 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 user access permissions specified in the document’s encryption dictionary.
String pdfUserPassword
The owner password for encrypted PDF output. Opening the document with the correct owner password (assuming it is not the same as the user password) allows full (owner) access to the document. This unlimited access includes the ability to change the document’s passwords and access permissions.
String pdfOwnerPassword
Controls how the engine should react when an image is not found. The possible values and their meanings can be found here.
ImageErrorsHandlingMode imageErrorsHandlingMode
When performing automatic tables layout, the engine will by default look only at a limited number of rows. You can set this to -1 to use all table rows, however this may drastically affect the performance if your document has very large tables. The default value is 100.
int autoLayoutRowCount
Specifies the compression algorithm to use for TIFF images. The possible values and their meanings can be found here.
CompressionAlgorithm compressionAlgorithm
Specifies the scaling factor that will be applied to the raster output. The value has to be greater than 0. Default value is 1. Values between 0 and 1 will scale the image down (zoom out), while values above 1 will zoom in. For example. a value of 0.5 is equivalent to a 50% zoom, while 2 is equivalent to a 200% zoom.
float zoomFactor
A string specifying the name of the printer.
String printerName
Merge context identifier. Use this when the rendering operation is part of a larger merge operation. To obtain a new merge context identifier use Engine::createNewMergeContextID.
String mergeContextID
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.
bool isLastDocumentInMergeContext
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.
int maxMergeContextInactivityTTL
Specifies whether to retry the requests that have failed. The default value is false.
bool retryFailedRequests
Specifies the timeout for a request, in seconds. The default value is 0.
int requestTimeout
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.
bool preloadDocument
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.
int smoothingMode
The page index to render. It's only meaningful for JPEG / GIF / PNG / SVG output. Default value is -1, indicating that all pages should be rendered.
int pageIdx
Specifies the compression type for PDF images. The possible values are PIC_FLAT (indicating FLAT compression) and PIC_JPEG (indicating JPEG compression).
PDFImageCompression PDFImageCompression
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.
String OutputPrintFile
Specifies various settings for HTML input. See HtmlInputSettings for more information.
HtmlInputSettings htmlInputSettings
Specifies various settings for HTML output. See HtmlOutputSettings for more information.
HtmlOutputSettings htmlOutputSettings
Specifies settings for printer. See PrinterSettings for more information.
PrinterSettings printerSettings
Specifies the address of the server hosting the Data Aggregation Service. The default value is 127.0.0.1.
String dasAddress
Specifies the port of the server hosting the Data Aggregation Service. The default value is 50000.
int dasPort
Specifies the language used for XFD translation. The default value is an empty string.
String printerName
Specifies the language for the server to load to translate the XFD template. The default value is null.
Stream* templateStream
Specifies the parameters for XSL transformations in [name, value] pairs. Default value is an empty string. The format is: (param1,value1)(param2,value2)...
String xsltParameters;
Enables/disables layout when resolving compatibility issues between XSLFO input format and HTML/EPUB/WordML output format. Layout will improve quality but will decrease rendering speed. Default is true(layout enabled).
bool performLayout;
Compute and get page count based on input stream; no output will be rendered but <see cref="OutputInformation"/> will contain the number of pages for this document. Default value is false.
bool computePageCountOnly;
The license key used to initialize the engine. Only the first call to render() will initialize the engine.
String licenseKey;
Specifies settings for txt output.
TxtOutputSettings txtOutputSettings;
This value will be a combination of elements in RenderingFeedback enumeration e.g. renderingFeedback = RF_SendLog | RF_SendProgress
int renderingFeedback;