PDFreactor Perl API Documentation

Java | .NET | JavaScript | Node.js | PHP | Python | Ruby | Perl | Web Service Client | SOAP Client

PDFreactor

The PDFreactor object handles all interaction with the PDFreactor Web Service. Only one instance per web service is required and the instance is reusable for subsequent conversions. The following describes the methods that can be called on the PDFreactor instance.

PDFreactor()

Creates a new PDFreactor client instance. The PDFreactor Web Service URL http://localhost:9423/service/rest will be used.

PDFreactor(serviceUrl)

Creates a new PDFreactor client instance. The specified URL will be used as PDFreactor Web Service URL.

Parameters

serviceUrl → String
The URL to the PDFreactor Web Service.

convert(configuration) → Result

Converts the specified configuration into PDF or image.

Parameters

configuration → Configuration
The configuration.

Errors

Reasons:

  • No input document was specified in the configuration.
  • The supplied configuration was not valid for some reason. See the error message for details.
  • The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
  • No configuration was supplied to the operation.
  • The configuration could not be processed and should be re-checked.
  • The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

convertAsBinary(configuration) → Binary

Converts the specified configuration into PDF or image.

Parameters

configuration → Configuration
The configuration.

Errors

Reasons:

  • No input document was specified in the configuration.
  • The supplied configuration was not valid for some reason. See the error message for details.
  • The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
  • No configuration was supplied to the operation.
  • The configuration could not be processed and should be re-checked.
  • The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

convertAsync(configuration) → String

Parameters

configuration → Configuration
The configuration.

Errors

Reasons:

  • No input document was specified in the configuration.
  • The supplied configuration was not valid for some reason. See the error message for details.
  • The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
  • No configuration was supplied to the operation.
  • The configuration could not be processed and should be re-checked.
  • The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
  • Asynchronous conversions are unavailable.
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

getProgress(documentId) → Progress

Gets the current progress of the conversion of the document with the given documentId.

Parameters

documentId → String
The documentId.

Errors

Reasons:

  • Conversion does not exist
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

getDocument(documentId) → Result

Retrieves the document with the given documentId from the PDFreactor service.

Parameters

documentId → String
The document ID.

Errors

Reasons:

  • Conversion does not exist
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

getDocumentAsBinary(documentId) → Binary

Retrieves the document with the given documentId from the PDFreactor service. The document is returned as raw binary data.

Parameters

documentId → String
The document ID.

Errors

Reasons:

  • Conversion does not exist
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

deleteDocument(documentId)

Deletes the document with the given documentId from the PDFreactor service.

Parameters

documentId → String
The document ID.

Errors

Reasons:

  • Conversion does not exist
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

getStatus()

Checks if the PDFreactor Web Service is responsive and is able to convert documents.

Errors

Reasons:

  • The PDFreactor Web Service is running but not functional.
  • A response was received but it could not be identified as a response from the PDFreactor Web Service.
  • The PDFreactor Web Service could not be reached.

getVersion() → Version

Gets the version of the PDFreactor Web Service.

getDocumentUrl(documentId) → String

Returns the URL where the document with the given ID can be accessed.

Parameters

documentId → String
The document ID.

getProgressUrl(documentId) → String

Returns the URL where the progress of the document with the given ID can be accessed.

Parameters

documentId → String
The document ID.

headers → Hash

A collection of key-value-pairs representing the request headers that will be added to the HTTP request to the PDFreactor Web Service. This property is empty by default and additional headers can be added as required. Headers should only be added in special environments where it is necessary.

cookies → Hash

A collection of key-value-pairs representing the cookies that will be added to the HTTP request to the PDFreactor Web Service. This property is empty by default and additional cookies can be added as required. Cookies should only be added in special environments where it is necessary, e.g. when using a load balancer.

Models

Configuration

This class contains all options related to the PDF or image conversion. Only document is required, all other configuration settings are optional.

addAttachments → Boolean

Enables or disables attachments specified in style sheets.

The default value is false.

addBookmarks → Boolean

Enables or disables bookmarks in the PDF document.

The default value is false.

addComments → Boolean

Enables or disables comments in the PDF document.

The default value is false.

Enables or disables links in the PDF document.

The default value is false.

addOverprint → Boolean

Enables or disables overprinting.

The default value is false.

addPreviewImages → Boolean

Enables or disables embedding of image previews per page in the PDF document.

The default value is false.

addTags → Boolean

Enables or disables tagging of the PDF document.

The default value is false.

allowAnnotations → Boolean

Enables or disables the 'annotations' restriction in the PDF document.

The default value is false.

allowAssembly → Boolean

Enables or disables the 'assembly' restriction in the PDF document.

The default value is false.

allowCopy → Boolean

Enables or disables the 'copy' restriction in the PDF document.

The default value is false.

allowDegradedPrinting → Boolean

Enables or disables the 'degraded printing' restriction in the PDF document.

The default value is false.

allowFillIn → Boolean

Enables or disables the 'fill in' restriction in the PDF document.

The default value is false.

allowModifyContents → Boolean

Enables or disables the 'modify contents' restriction in the PDF document.

The default value is false.

allowPrinting → Boolean

Enables or disables the 'printing' restriction in the PDF document.

The default value is false.

allowScreenReaders → Boolean

Enables or disables the 'screen readers' restriction in the PDF document.

The default value is false.

appendLog → Boolean

Specifies whether or not the log data should be added to the PDF document.

The default value is false.

attachments → Array(Attachment)

Adds a file attachment to PDF document.

authenticationCredentials → KeyValuePair

Enables access to resources that are secured via Basic or Digest authentication.

author → String

Sets the value of the author field of the PDF document.

baseURL → String

Sets the base URL of the document.

To resolve relative URLs to absolute URLs a reference (base) URL is required. This reference URL is usually the system id of the document.

This method can be used to specify another reference URL. If this URL is not null then it will be used instead of the system id.

The default value is null.

bookletMode → BookletMode

Convenience method to set pages-per-sheet properties and page order in one step to create a booklet.

cleanupTool → Cleanup

Sets the cleanup tool to use for documents with unparsable content.

The Cleanup constants can be used as value. The default value specified is Cleanup->CYBERNEKO.

The cleanup tool is only used for Doctype->XHTML. HTML5 utilizes an internal cleanup.

conformance → Conformance

Sets the conformance of the PDF.

The Conformance constants can be used as value. The default value specified is Conformance->PDF.

continuousOutput → ContinuousOutput
Enables the conversion of the input document into one image.
conversionName → String

Sets a name for the conversion. If a name is set, it will be logged at level "info". The name can be an arbitrary string but should be unique for every conversion or application so that the log output can be matched to a specific conversion or application later.

cookies → Array(KeyValuePair)

Adds a cookie to all outgoing HTTP connections. The parameters are URL encoded (see rawCookies). If the key already exists, the pair is overwritten.

creator → String

Sets the value of creator field of the PDF document.

customDocumentProperties → Array(KeyValuePair)

Adds a custom property to the PDF document. An existing property of the same name will be replaced.

defaultColorSpace → ColorSpace

Sets whether to convert color key words to CMYK instead of RGB.

The ColorSpace constants can be used as value. The default value specified is ColorSpace->RGB.

disableFontEmbedding → Boolean

Sets whether fonts will not be embedded into the resulting PDF. Setting this to true will reduce the file size of the output document. However, the resulting PDF documents are no longer guaranteed to look identical on all systems.

The default value is false.

document → String
The input document. This can either be an URL, XML or HTML source code or a binary.
documentDefaultLanguage → String

Sets the language used for documents having no explicit language attribute set.

The language code is used to resolve the lang() selector correct and to determine the correct language used for hyphenation.
documentType → Doctype

Sets the document type.

The Doctype constants can be used to specify the document type. The default value specified is Doctype->AUTODETECT.

enableDebugMode → Boolean
Enables debug mode, which adds additional information to the output.
encoding → String

Sets the encoding of the document.

If this value is set to null or it is empty then the encoding will be detected automatically.

The default value is null.

encryption → Encryption

Sets the encryption.

Use one of the Encryption constants to specify the encryption. The default value is Encryption->NONE.

fontAliases → Array(Font)

Registers an alias font family for an existing font.

This function is limited to fonts loaded automatically from system folders.

fontFallback → Array(String)

Sets a list of fallback font families used for character substitution. This list is iterated for characters that can not be displayed with any of the fonts specified via the CSS property font-family.

fonts → Array(Font)

Loads a font from a URL which can be used via the CSS property font-family.

fullCompression → Boolean

Enables or disables full compression of the PDF document.

The default value is false.

httpsMode → HttpsMode

Sets the HTTPS mode. In closed environment lenient can be the preferred setting to avoid HTTPS issues that are not security critical

The default value specified is HttpsMode->STRICT.

ignoreAlpha → Boolean
Sets whether the alpha value of CSS RGBA colors is ignored. This can be used to avoid conformance issues in PDF/A-1.
integrationStyleSheets → Array(Resource)

Adds an integration style sheet to the document.

There are two ways to specify the style sheet:

  1. Specifying the style sheet only using an URI.
  2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.
javaScriptMode → JavaScriptMode

Sets the JavaScript Mode.

The default value specified is JavaScriptMode->DISABLED.

keepDocument → Boolean
If set to true prevents the document from being deleted from the PDFreactor Web Service after it has been accessed. This only works for asynchronous conversions.
keywords → String

Sets the value of the keywords field of the PDF document.

licenseKey → String
Sets the license key using a string. If the license key is set to null then PDFreactor looks for a 'licensekey.xml' file in the same directory where the 'PDFreactor.jar' file is located. If no license key could be found then PDFreactor runs in evaluation mode.

The default value is null.

logExceedingContent → LogExceedingContent

Whether to log content exceeding the page.

Use ExceedingContentAnalyze constants to specify which kind of content should be observed for exceeding content logging. The default value is ExceedingContentAnalyze->NONE.

Use ExceedingContentAgainst constants to specify that exceeding this content starts exceeding content logging. The default value is ExceedingContentAgainst->NONE.

logLevel → LogLevel

Sets the log level.

Use one of the LogLevel constants to specify the log level.

The default value is LogLevel->NONE.

mediaFeatureValues → Array(MediaFeatureValue)
Defines the value of a Media Feature which is used to resolve CSS3 media queries.
mediaTypes → Array(String)

Sets the media types that are used to resolve CSS3 media queries.

Please note that this overrides the default media types of PDFreactor, which are:

print, paged, visual, bitmap, static, -ro-pdfreactor

mergeByteArray → Base64

This method sets a byte array containing an external PDF document which will be merged with the PDF document generated by the XML source.

mergeByteArrays → Array(Base64)

This method sets an array of byte arrays that contain multiple external PDFs which will be merged with the PDF document generated by the XML source.

mergeMode → MergeMode

Sets the merge mode.

The following merge methods can be used:

The default value is MergeMode->APPEND.

mergeURL → String

This method sets a URL of an external PDF document which will be merged with the PDF document generated by the XML source.

mergeURLs → Array(String)

This method sets an array of URLs of external PDF documents which will be merged with the PDF document generated by the XML source.

outputFormat → OutputFormat
Sets the output format. The default value is PDF. For image formats the width or height in pixels must be specified. When either dimension is <1 it is computed based on the other dimension and the aspect ratio of the input document.
outputIntent → OutputIntent

Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.

Set either the profile URL or the profile data, not both. Certain PDF/X formats require neither, just a known identifier.

overlayRepeat → OverlayRepeat

If one of the documents of an overlay process is shorter than the other, this method allows repeating either its last page or all of its pages in order to overlay all pages of the longer document.

Use one of the OBERLAY_REPEAT_ constants to specify the overlay repeat. The default value is OverlayRepeat->NONE.

ownerPassword → String

Sets the owner password of the PDF document.

The default value is null.

pageOrder → String | PageOrder

Sets the page order of the direct result of the conversion.

If mergeMode is set to MergeMode->ARRANGE, this method is also used to specify the position of inserted pages from an existing PDF.

A description of the syntax can be found in the manual.

pagesPerSheetProperties → PagesPerSheetProperties

Sets the properties of a sheet on which multiple pages are being arranged.

If cols or rows is less than 1, no pages-per-sheet processing is done. This is the case by default.

Use one of the PagesPerSheetDirection constants to specify the the direction. The default value is PagesPerSheetDirection->RIGHT_DOWN.

pdfScriptAction → Array(PdfScriptAction)

Sets a pair of trigger event and PDF script. The script is triggered on the specified event.

A PDF script is JavaScript that is executed by a PDF viewer (e.g. Adobe Reader). Note that most viewers do not support this feature.

PDF Scripts can also be set by using the proprietary CSS property pdf-script-action. More information on this property can be found in the manual.

Please note, that scripts set via CSS have a higher priority. If two scripts are registered on the same event, but one via API and the other via the CSS property, the script set in the CSS will override the other one.

pixelsPerInch → Integer

Sets the pixels per inch.

Changing this value changes the physical length of sizes specified in px (including those specified via HTML attributes).

The default value is 96ppi.

pixelsPerInchShrinkToFit → Boolean

Whether the pixels per inch should be adapted automatically to avoid content exceeding pages.

postTransformationDocumentType → Doctype

Sets the document type after the XSL-Transformations have been applied.

The Doctype constants can be used to specify the document type. The default value specified is Doctype->AUTODETECT.

printDialogPrompt → Boolean

Enables or disables a print dialog to be shown upon opening the generated PDF document by a PDF viewer.

The default value is false.

processingPreferences → Array(ProcessingPreferences)

Preferences that influence the conversion process without changing the output

Use the ProcessingPreferences constants to specify the processing preferences. By default no processing preference is set.

rawCookies → Array(KeyValuePair)

Adds a cookie to all outgoing HTTP connections. The parameters are not URL encoded (see cookies). If the key already exists, the pair is overwritten.

requestHeaders → Array(KeyValuePair)

Adds a request header to all outgoing HTTP connections. If the key already exists, the pair is overwritten.

resourceRequestTimeout → Integer

Sets a timeout in milliseconds for requests to resources, such as HTTP requests to style sheets, images etc. If the server does not respond until the timeout, the request will be aborted and the resource will not be loaded.

A timeout of 0 means that the request will not time out. A negative value means that no timeout will be set. The default value is 60000 (1min).

signPDF → SignPDF

Sets a digital certificate to sign the newly created PDF.

Requires a keystore file. The included certificate may be self-signed.

Use the KeystoreType constants to specify the keystore type.

Use the SigningMode constants to specify the signing mode.

subject → String

Sets the value of the subject field of the PDF document.

throwLicenseExceptions → Boolean

Whether an exception should be thrown when no legal full license key is set. This allows to programmatically ensure that documents are not altered due to license issues.

The default value is false.

title → String

Sets the value of the title field of the PDF document.

userPassword → String

Sets the user password of the PDF document.

The default value is null.

userScripts → Array(ScriptResource)

Adds an user script to the document.

There are two ways to specify the script:

  1. Specifying the script only by an URI.
  2. Specifying the script by the content of the script and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.
userStyleSheets → Array(Resource)

Adds a user style sheet to the document.

There are two ways to specify the style sheet:

  1. Specifying the style sheet only using an URI.
  2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.
viewerPreferences → Array(ViewerPreferences)

Sets the page layout and page mode preferences of the PDF.

Use the ViewerPreferences constants to specify the viewer preferences. By default no viewer preference is set.

xmp → Xmp

Sets custom XMP to be embedded into the PDF document.

If both content and URI are set to null no custom XMP is embedded. If priority is also set to XmpPriority->HIGH automatic generation of required XMP is also suppressed. This may cause output PDFs to not archive a specified conformance.
xsltMode → Boolean

Enables or disables XSLT transformations.

Set this value to true to enable XSLT transformations or to false to disable XSLT transformations.

The default value is false.

xsltStyleSheets → Array(Resource)

Adds an XSLT style sheet to the document.

There are two ways to specify the style sheet:

  1. Specifying the style sheet only by an URI.
  2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

ExceedingContent

bottom → Boolean
Returns whether the content exceeds the page at the bottom.
box → Boolean
Returns whether the exceeding content is a box instead of text or image content.
containerBottom → Integer
Returns the bottom coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page
containerLeft → Integer
Returns the left coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page
containerRight → Integer
Returns the right coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page
containerTop → Integer
Returns the top coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page
description → String
Returns a description of the content. In case of text content, the text is returned. In case of images the URL is returned if available.
exceedingBoxBottom → Integer
Returns the bottom coordinate of the the exceeding box in the page in pixels.
exceedingBoxLeft → Integer
Returns the left coordinate of the the exceeding box in the page in pixels.
exceedingBoxRight → Integer
Returns the right coordinate of the the exceeding box in the page in pixels.
exceedingBoxTop → Integer
Returns the top coordinate of the the exceeding box in the page in pixels.
html → String
Returns the HTML of the box that contains the exceeding content.
left → Boolean
Returns whether the content exceeds the page to the left.
pageBottom → Integer
Returns the bottom coordinate of the the page in pixels.
pageLeft → Integer
Returns the left coordinate of the the page in pixels.
pageNumber → Integer
Returns the number of the page that contains the exceeding content.
pageRight → Integer
Returns the right coordinate of the the page in pixels.
pageTop → Integer
Returns the top coordinate of the the page in pixels.
path → Array(Integer)
Returns an array of integers denoting the indexes of the ancestors of the DOM node corresponding to the box containing the exceeding content, starting from below the root node down to the element itself.
right → Boolean
Returns whether the content exceeds the page to the right.
summary → String
Returns a summary of this exceeding content object.
top → Boolean
Returns whether the content exceeds the page at the top.

Log

records → Array(Record)
The log records.

Progress

finished → Boolean
Indicated whether the conversion is finished yet.
log → Log
The log of the conversion.
progress → Integer
The current progress of the conversion. The value is between 0 and 100.

Record

level → Integer
The level of the record.
message → String
The logged message.
timestamp → Integer
The timestamp.

Result

The result of a PDF or image conversion.
document → Base64

The resulting PDF or image as base64 encoded String.

documentArray → Array(Base64)

The resulting PDF or image as an array of base64 encoded Strings. This property is only present if the configuration option "asArray" was set to true

error → String

Returns the error messages that might have been generated during rendering.

exceedingContents → Array(ExceedingContent)

Provides information about content exceeding its page or parent. Depends on the mode set via "logExceedingContents".

log → Log

Returns the log messages generated during rendering based on the log level.

numberOfPages → Integer

Returns the number of pages of the document after conversion.

numberOfPagesLiteral → Integer

Returns the number of pages of the resulting PDF (including, e.g., merge operations), otherwise it will return the number pages of the laid out input document.

Version

build → Integer
The build number
major → Integer
The major version.
micro → Integer
The micro version
minor → Integer
The minor version
revision → String
The revision number

Attachment

data → Base64
The binary content of the attachment. May be null.
url → String
If data is null, the attachment will be retrieved from this URL. If this is "#" the input document URL is used instead.
name → String
The file name associated with the attachment. It is recommended to specify the correct file extension. If this is null the name is derived from the URL.
description → String
The description of the attachment. If this is null the name is used.

BookletMode

sheetSize → String
The size of the sheet as CSS value, e.g. A3, letter landscape, 15in 20in, 20cm 30cm.
sheetMargin → String
The sheet margin as CSS margin value, e.g. 1in, 1cm 1.5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.
rtl → Boolean
Whether or not the reading order of the booklet should be right-to-left.

ContinuousOutput

width → Integer
Equivalent to the width of a browser window (view port). Values <1 enable paginated output.
height → Integer
Equivalent to the height of a browser window (view port). For values <1 the entire height of the document is used.

Font

source → String
The name of an existing font family.
family → String
The alias name for that font.
bold → Boolean
Whether the alias will be labeled bold.
italic → Boolean
Whether the alias will be labeled italic.

KeyValuePair

key → String
The key
value → String
The value

LogExceedingContent

logExceedingContentAnalyze → ExceedingContentAnalyze
Enables logging of exceeding content and optionally of boxes.
logExceedingContentAgainst → ExceedingContentAgainst
Enables logging of exceeding content either against the page edges, page content areas or containers.

MediaFeatureValue

mediaFeature → MediaFeature
The media feature.
value → String
The value that is associated with the given media feature.

OutputFormat

type → OutputType
the output format. See OutputType constants
width → Integer
The with of the output in pixels (image formats only). Values <1 will be computed based on the specified height and the aspect ratio of the input document.
height → Integer
The height of the output in pixels (image formats only). Values <1 will be computed based on the specified width and the aspect ratio of the input document.
multiImage → Boolean
Indicates whether the image output will be paginated into multiple images.

OutputIntent

identifier → String | OutputIntentDefaultProfile
The identifier
data → Base64
The profile data
url → String
The profile URL

PagesPerSheetProperties

cols → Integer
The number of columns per sheet.
rows → Integer
The number of rows per sheet.
sheetSize → String
The sheet size as CSS size, e.g. A4, letter landscape, 15in 20in, 20cm 30cm.
sheetMargin → String
The sheet margin as CSS margin, e.g. 1in, 1cm 1.5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.
spacing → String
The horizontal and vertical space between pages on a sheet as CSS value, e.g. 0.1in, 5mm 2mm. null is interpreted as 0mm.
direction → PagesPerSheetDirection
The direction in which the pages are ordered on a sheet.

PdfScriptAction

triggerEvent → PdfScriptTriggerEvent
The event on which the script is executed. Value is a PdfScriptTriggerEvent constant.
script → String
The script source that should be executed.

Resource

content → String
The content of the style sheet.
uri → String
The URI of the style sheet.

ScriptResource

content → String
The content of the script.
uri → String
The URI of the script.
beforeDocumentScripts → Boolean
Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.

SignPDF

keystoreURL → String
The URL to the keystore file.
keyAlias → String
The alias of the certificate included in the keystore to be used to sign the PDF.
keystorePassword → String
The password of the keystore.
keystoreType → KeystoreType
The format of the keystore, i.e. pkcs12 or jks. Use one of the KeystoreType constants as value.
signinMode → SigningMode
The mode that is used to sign the PDF, i.e. self-signed, Windows certificate or VeriSign. Use one of the SigningMode constants as value.

Xmp

content → String
XMP, as an XML string, to be embedded into the PDF document.
uri → String
URI to XMP to be embedded into the PDF document, if content is null.
priority → XmpPriority
Priority of this XMP over XMP generated automaticaly for the conformance requirements of certain output formats.

Cleanup

CYBERNEKO
Indicates that the CyberNeko HTML parser will be used to perform a cleanup when loading a non-well-formed document.
JTIDY
Indicates that JTidy will be used to perform a cleanup when loading a non-well-formed document.
NONE
Indicates that no cleanup will be performed when loading a document. If the loaded document is not well-formed, an exception will be thrown.
TAGSOUP
Indicates that tagsoup will be used to perform a cleanup when loading a non-well-formed document.

ColorSpace

CMYK
The color space CMYK
RGB
The color space RGB

Conformance

PDF
PDF with no additional restrictions (default)
PDFA1A
PDF/A-1a (ISO 19005-1:2005 Level A)
PDFA1A_PDFUA1
PDF/A-1a + PDF/UA-1 ....
PDFA1B
PDF/A-1b (ISO 19005-1:2005 Level B)
PDFA2A
PDF/A-2a (ISO 19005-2:2011 Level A)
PDFA2A_PDFUA1
PDF/A-2a + PDF/UA-1 ....
PDFA2B
PDF/A-2b (ISO 19005-2:2011 Level B)
PDFA2U
PDF/A-2u (ISO 19005-2:2011 Level U)
PDFA3A
PDF/A-3a (ISO 19005-3:2012 Level A)
PDFA3A_PDFUA1
PDF/A-3a + PDF/UA-1 ....
PDFA3B
PDF/A-3b (ISO 19005-3:2012 Level B)
PDFA3U
PDF/A-3u (ISO 19005-3:2012 Level U)
PDFUA1
PDF/UA-1 (ISO ...)
PDFX1A_2001
PDF/X-1a:2001 (ISO 15930-1:2001)
PDFX1A_2003
PDF/X-1a:2003 (ISO 15930-4:2003)
PDFX3_2002
PDF/X-3:2002 (ISO 15930-3:2002)
PDFX3_2003
PDF/X-3:2003 (ISO 15930-6:2003)
PDFX4
PDF/X-4 (ISO 15930-7:2008)
PDFX4P
PDF/X-4p (ISO 15930-7:2008)

Doctype

AUTODETECT
Indicates that the document type will be detected automatically. A document has the type Doctype->HTML5 if the name of the root element is "html" (ignoring case considerations). In all other cases the document type is Doctype->XML.
HTML5
Indicates that the document type will be set to HTML5. The HTML default style sheet is used and the document is loaded regarding style elements, style attributes and link stylesheets.
XHTML
Indicates that the document type will be set to XHTML. The HTML default style sheet is used and the document is loaded regarding style elements, style attributes and link stylesheets.
XML
Indicates that the document type will be set to generic XML. No default style sheet is used and the document is loaded as is without regards to style elements or attributes.

Encryption

NONE
Indicates that the document will not be encrypted. If encryption is disabled then no user password and no owner password can be used.
TYPE_128
Indicates that the document will be encrypted using RC4 128 bit encryption. For normal purposes this value should be used.
TYPE_40
Indicates that the document will be encrypted using RC4 40 bit encryption.

ExceedingContentAgainst

NONE
Do not log exceeding content
PAGE_BORDERS
Log content exceeding the edges of its page
PAGE_CONTENT
Log content exceeding its page content area (overlaps the page margin)
PARENT
Log content exceeding its container

ExceedingContentAnalyze

CONTENT
Log exceeding content
CONTENT_AND_BOXES
Log exceeding content and all boxes
CONTENT_AND_STATIC_BOXES
Log exceeding content and boxes without absolute positioning
NONE
Do not log exceeding content

HttpsMode

LENIENT
Indicates lenient HTTPS behavior. This means that many certificate issues are ignored.
STRICT
Indicates strict HTTPS behavior. This matches the default behavior of Java.

JavaScriptMode

DISABLED
Indicates that JavaScript is disabled.
ENABLED
Indicates that JavaScript is enabled.
ENABLED_NO_LAYOUT
Indicates that JavaScript is enabled, without access to layout data.
ENABLED_REAL_TIME
Indicates that JavaScript is enabled, without converter-specific optimizations to timeouts and intervals. This mode is significantly more time consuming and should only be used when no other mode provides the expected results.
ENABLED_TIME_LAPSE
Indicates that JavaScript is enabled, with time stamps increasing more quickly. This makes some kinds of JS based animations (e.g. when using jQuery) finish immediately, which has the same effect as JavaScriptMode->ENABLED_REAL_TIME, but is significantly faster. Only Date.getTime() is affected by this.

KeystoreType

JKS
Keystore type "jks"
PKCS12
Keystore type "pkcs12"

LogLevel

DEBUG
Indicates that debug, info, warn and fatal log events will be logged.
FATAL
Indicates that only fatal log events will be logged.
INFO
Indicates that info, warn and fatal log events will be logged.
NONE
Indicates that no log events will be logged.
PERFORMANCE
Indicates that all log events will be logged.
WARN
Indicates that warn and fatal log events will be logged.

MediaFeature

ASPECT_RATIO

CSS 3 Media Feature describing the aspect ratio of the page content.

By default, this value is computed using the values of MediaFeature->WIDTH and MediaFeature->HEIGHT. Setting a specific value does override the computed value.

COLOR

CSS 3 Media Feature describing the number of bits per color component.

Default value is 8.

COLOR_INDEX

CSS 3 Media Feature describing the number of entries in the color lookup table.

Default value is 0, as there is no color lookup table.

DEVICE_ASPECT_RATIO

CSS 3 Media Feature describing the aspect ratio of the page.

By default, this value is computed using the values of MediaFeature->DEVICE_WIDTH and MediaFeature->DEVICE_HEIGHT. Setting a specific value does override the computed value.

DEVICE_HEIGHT

CSS 3 Media Feature describing the height of the page.

The default height is that of a DIN A4 page (297mm).

DEVICE_WIDTH

CSS 3 Media Feature describing the width of the page.

The default width is that of a DIN A4 page (210mm).

GRID

CSS 3 Media Feature defining whether the output is grid-based.

Default value 0, as PDFs are not grid-based.

HEIGHT

CSS 3 Media Feature height of page content.

The default height is that of a DIN A4 page with 1cm margin (277mm).

MONOCHROME

CSS 3 Media Feature describing the number of bits per pixel in a monochrome frame buffer.

Default value is 0, as the device is not monochrome.

ORIENTATION

CSS 3 Media Feature describing the page orientation.

By default, this value is computed using the values of MediaFeature->WIDTH and MediaFeature->HEIGHT. Setting a specific value does override the computed value.

Valid values are "portrait" or "landscape"

RESOLUTION

CSS 3 Media Feature describing the resolution of the output device.

This also defines the value of the window.devicePixelRatio property available from JavaScript.

Default value is 2dppx.

WIDTH

CSS 3 Media Feature width of page content.

The default width is that of a DIN A4 page with 1cm margin (190mm).

MergeMode

APPEND
Default merge mode: Append converted document to existing PDF
ARRANGE
Advanced merge mode: Allows to insert specific pages from existing PDFs into the converted document. This is done via a special syntax of pageOrder.
OVERLAY
Alternate merge mode (overlay): Adding converted document above the existing PDF
OVERLAY_BELOW
Alternate merge mode (overlay): Adding converted document below the existing PDF
PREPEND
Alternate merge mode: Prepend converted document to existing PDF

OutputIntentDefaultProfile

FOGRA39
"Coated FOGRA39" output intent default profile
GRACOL
"Coated GRACoL 2006" output intent default profile
IFRA
"ISO News print 26% (IFRA)" output intent default profile
JAPAN
"Japan Color 2001 Coated" output intent default profile
JAPAN_NEWSPAPER
"Japan Color 2001 Newspaper" output intent default profile
JAPAN_UNCOATED
"Japan Color 2001 Uncoated" output intent default profile
JAPAN_WEB
"Japan Web Coated (Ad)" output intent default profile
SWOP
"US Web Coated (SWOP) v2" output intent default profile
SWOP_3
"Web Coated SWOP 2006 Grade 3 Paper" output intent default profile

OutputType

BMP
BMP output format
GIF
GIF output format
JPEG
JPEG output format
PDF
PDF output format
PNG
PNG output format (using Java Image I/O)
PNG_AI
PNG output format (using Apache Imaging)
PNG_TRANSPARENT
Transparent PNG output format (using Java Image I/O)
PNG_TRANSPARENT_AI
Transparent PNG output format (using Apache Imaging)
TIFF_CCITT_1D
Monochrome CCITT 1D compressed TIFF output format
TIFF_CCITT_GROUP_3
Monochrome CCITT Group 3 compressed TIFF output format
TIFF_CCITT_GROUP_4
Monochrome CCITT Group 4 compressed TIFF output format
TIFF_LZW
LZW compressed TIFF output format
TIFF_PACKBITS
PackBits compressed TIFF output format
TIFF_UNCOMPRESSED
Uncompressed TIFF output format

OverlayRepeat

ALL_PAGES
All pages of the shorter document are repeated, to overlay all pages of the longer document
LAST_PAGE
Last page of the shorter document is repeated, to overlay all pages of the longer document
NONE
No pages of the shorter document are repeated, leaving some pages of the longer document without overlay
TRIM
The resulting PDF is trimmed to the number of pages of the shorter document

PageOrder

BOOKLET
Page order mode to arrange all pages in booklet order
BOOKLET_RTL
Page order mode to arrange all pages in right-to-left booklet order
EVEN
Page order mode to keep even pages only
ODD
Page order mode to keep odd pages only
REVERSE
Page order mode to reverse the page order

PagesPerSheetDirection

DOWN_LEFT
Arranges the pages on a sheet from top to bottom and right to left.
DOWN_RIGHT
Arranges the pages on a sheet from top to bottom and left to right.
LEFT_DOWN
Arranges the pages on a sheet from right to left and top to bottom.
LEFT_UP
Arranges the pages on a sheet from right to left and bottom to top.
RIGHT_DOWN
Arranges the pages on a sheet from left to right and top to bottom.
RIGHT_UP
Arranges the pages on a sheet from left to right and bottom to top.
UP_LEFT
Arranges the pages on a sheet from bottom to top and right to left.
UP_RIGHT
Arranges the pages on a sheet from bottom to top and left to right.

PdfScriptTriggerEvent

AFTER_PRINT
This event is triggered after the PDF has been printed by the viewer application.
AFTER_SAVE
This event is triggered after the PDF has been saved by the viewer application.
BEFORE_PRINT
This event is triggered before the PDF is printed by the viewer application.
BEFORE_SAVE
This event is triggered before the PDF is saved by the viewer application.
CLOSE
This event is triggered when the PDF is closed by the viewer application.
OPEN
This event is triggered when the PDF is opened in the viewer application.

ProcessingPreferences

SAVE_MEMORY_IMAGES
Processing preferences flag for the memory saving mode for images.

SigningMode

SELF_SIGNED
Signing mode for self-signed certificates.
VERISIGN_SIGNED
Signing mode for VeriSign certificates.
WINCER_SIGNED
Signing mode for Windows certificates.

ViewerPreferences

CENTER_WINDOW
Position the document's window in the center of the screen.
DIRECTION_L2R
Position pages in ascending order from left to right.
DIRECTION_R2L
Position pages in ascending order from right to left.
DISPLAY_DOC_TITLE
Display the document's title in the top bar.
DUPLEX_FLIP_LONG_EDGE
Print dialog default setting: duplex (long edge)
DUPLEX_FLIP_SHORT_EDGE
Print dialog default setting: duplex (short edge)
DUPLEX_SIMPLEX
Print dialog default setting: simplex
FIT_WINDOW
Resize the document's window to fit the size of the first displayed page.
HIDE_MENUBAR
Hide the viewer application's menu bar when the document is active.
HIDE_TOOLBAR
Hide the viewer application's tool bars when the document is active.
HIDE_WINDOW_UI
Hide user interface elements in the document's window.
NON_FULLSCREEN_PAGE_MODE_USE_NONE
Show no panel on exiting full-screen mode. Has to be combined with ViewerPreferences->PAGE_MODE_FULLSCREEN.
NON_FULLSCREEN_PAGE_MODE_USE_OC
Show optional content group panel on exiting full-screen mode. Has to be combined with ViewerPreferences->PAGE_MODE_FULLSCREEN.
NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES
Show bookmarks panel on exiting full-screen mode. Has to be combined with ViewerPreferences->PAGE_MODE_FULLSCREEN.
NON_FULLSCREEN_PAGE_MODE_USE_THUMBS
Show thumbnail images panel on exiting full-screen mode. Has to be combined with ViewerPreferences->PAGE_MODE_FULLSCREEN.
PAGE_LAYOUT_ONE_COLUMN
Display the pages in one column.
PAGE_LAYOUT_SINGLE_PAGE
Display one page at a time. (default)
PAGE_LAYOUT_TWO_COLUMN_LEFT
Display the pages in two columns, with odd numbered pages on the left.
PAGE_LAYOUT_TWO_COLUMN_RIGHT
Display the pages in two columns, with odd numbered pages on the right.
PAGE_LAYOUT_TWO_PAGE_LEFT
Display two pages at a time, with odd numbered pages on the left.
PAGE_LAYOUT_TWO_PAGE_RIGHT
Display two pages at a time, with odd numbered pages on the right.
PAGE_MODE_FULLSCREEN
Switch to fullscreen mode on startup.
PAGE_MODE_USE_ATTACHMENTS
Show attachments panel on startup.
PAGE_MODE_USE_NONE
Show no panel on startup.
PAGE_MODE_USE_OC
Show optional content group panel on startup.
PAGE_MODE_USE_OUTLINES
Show bookmarks panel on startup.
PAGE_MODE_USE_THUMBS
Show thumbnail images panel on startup.
PICKTRAYBYPDFSIZE_FALSE
Print dialog default setting: do not pick tray by PDF size
PICKTRAYBYPDFSIZE_TRUE
Print dialog default setting: pick tray by PDF size
PRINTSCALING_APPDEFAULT
Print dialog default setting: set scaling to application default value.
PRINTSCALING_NONE
Print dialog default setting: disabled scaling

XmpPriority

HIGH
Embed XMP ignoring requirments of the output format. This may cause output PDFs to not archive a specified conformance.
LOW
Embed XMP if the output format does not have XMP requirments.
NONE
Do not embed XMP.