PDFreactor SOAP Client API Documentation

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

Server Parameters

REST

Models

<web:Configuration xmlns:web="http://webservice.pdfreactor.realobjects.com">

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

<web:addAttachments xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables attachments specified in style sheets.

The default value is false.

<web:addBookmarks xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.disableBookmarks instead.

<web:addComments xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables comments in the PDF document.

The default value is false.

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.disableLinks instead.

<web:addOverprint xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables overprinting.

The default value is false.

<web:addPreviewImages xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:addTags xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables tagging of the PDF document.

The default value is false.

<web:allowAnnotations xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowAssembly xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowCopy xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowDegradedPrinting xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowFillIn xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowModifyContents xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowPrinting xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:allowScreenReaders xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:appendLog xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:attachments xmlns:web="http://webservice.pdfreactor.realobjects.com">
Attachment0Unbounded

Adds a file attachment to PDF document.

<web:authenticationCredentials xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair01

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

<web:author xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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

<web:baseURL xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Deprecated

Deprecated as of PDFreactor 11. Use Configuration.baseUrl instead.

<web:baseUrl xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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.

<web:bookletMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
BookletMode01

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

<web:callbacks xmlns:web="http://webservice.pdfreactor.realobjects.com">
Callback0Unbounded

Adds callbacks to the conversion which will be called at specific times. All callbacks perform a POST request to the specified URL with the specified content type and a certain model which depends on the callback event.

For each callback, you can specify a timeout. If no timeout is specified, the server's default timeout for callbacks is used. A value of zero or negative values indicate an infinite timeout, however the PDFreactor server may have a maximum timeout configured, in which case that will be the used value.

Some callbacks might be called regularly during the course of a conversion. For these callbacks you can specify an interval to control how frequently they are called.

<web:cleanupTool xmlns:web="http://webservice.pdfreactor.realobjects.com">
Cleanup01

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 Configuration.documentType Doctype.XHTML. HTML5 utilizes an internal cleanup.

<web:colorSpaceSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
ColorSpaceSettings01

Specifies color space related settings.

<web:conformance xmlns:web="http://webservice.pdfreactor.realobjects.com">
Conformance01

Sets the conformance of the PDF.

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

<web:contentObserver xmlns:web="http://webservice.pdfreactor.realobjects.com">
ContentObserver01

Specifies parts of the document's content that should be observed and logged in greater detail. Data logged this way can be programmatically retrieved after the conversion has finished. The following can be observed:

<web:continuousOutput xmlns:web="http://webservice.pdfreactor.realobjects.com">
ContinuousOutput01

Enables the conversion of the input document into one image.

<web:conversionName xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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.

<web:conversionTimeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Sets a timeout in seconds for the whole document conversion. If the timeout is exceeded, the conversion will be aborted.

A timeout of 0 or negative values mean that the conversion will never time out. This is also the default behavior if no timeout is specified.

<web:cookies xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

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

<web:creator xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Sets the value of creator field of the PDF document.

<web:cssSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
CssSettings01

Specifies the behavior of PDFreactor regarding the support and validation of CSS properties and their declaration. The following modes can be set:

  • Do not validate at all, consider all declared style as valid. See CssPropertySupport.ALL
  • Validate all declared styles for properties only supported by PDFreactor. Properties only supported by third party products are not supported/taken as invalid. See CssPropertySupport.HTML
  • Validate all declared styles for properties supported by PDFreactor. Properties only supported by third party products are supported/taken as valid. See CssPropertySupport.HTML_THIRD_PARTY
  • All properties supported by third party products are supported/taken as valid. All declared styles for properties not supported by third party products but supported by PDFreactor will be validated. See CssPropertySupport.HTML_THIRD_PARTY_LENIENT
<web:customDocumentProperties xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

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

<web:debugSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
DebugSettings01

Enables and configures debug settings, which add additional information to the output.

If enabled, exceptions during the conversion will not be thrown. In such a case, instead of a document a string containing the log and exception will be returned.

<web:defaultColorSpace xmlns:web="http://webservice.pdfreactor.realobjects.com">
ColorSpace01

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.colorSpaceSettings and ColorSpaceSettings.targetColorSpace instead.

<web:disableBookmarks xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Disables bookmarks in the PDF document.

The default value is false.

<web:disableFontEmbedding xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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.

Disables links in the PDF document.

The default value is false.

<web:document xmlns:web="http://webservice.pdfreactor.realobjects.com">
[Binary, String]1

The input document. This can either be a URL string, XML or HTML source code string.

Alternatively, the input document can be specified directly as Binary or as Base64-encoded string.
<web:documentDefaultLanguage xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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.

<web:documentType xmlns:web="http://webservice.pdfreactor.realobjects.com">
Doctype01

Sets the document type.

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

<web:enableDebugMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.debugSettings instead.

<web:encoding xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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.

<web:encryption xmlns:web="http://webservice.pdfreactor.realobjects.com">
Encryption01

Sets the encryption.

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

<web:errorPolicies xmlns:web="http://webservice.pdfreactor.realobjects.com">
ErrorPolicy0Unbounded

Specifies error policies that will be used for the conversion. Depending on the policy, the conversion will fail if the appropriate criteria are not met.

<web:fontAliases xmlns:web="http://webservice.pdfreactor.realobjects.com">
Font0Unbounded

Registers an alias font family for an existing font.

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

<web:fontFallback xmlns:web="http://webservice.pdfreactor.realobjects.com">
String0Unbounded

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.

<web:fonts xmlns:web="http://webservice.pdfreactor.realobjects.com">
Font0Unbounded

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

<web:forceGrayscaleImage xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

If the output format is an image format, this setting controls whether a grayscale image should be returned. This can not be combined with transparency.

<web:fullCompression xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables full compression of the PDF document.

The default value is false.

<web:httpsMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
HttpsMode01

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.

<web:ignoreAlpha xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Sets whether the alpha value of CSS RGBA colors is ignored. This can be used to avoid conformance issues in PDF/A-1.

<web:inspectableSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
InspectableSettings01

When enabled, makes the converted document inspectable with the PDFreactor Development Tools.

Only works with OutputType.PDF output and requires a license key.

<web:integrationStyleSheets xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource0Unbounded

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.
<web:javaScriptMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
JavaScriptMode01

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.javaScriptSettings instead.

<web:javaScriptSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
JavaScriptSettings01

Specifies JavaScript related settings.

<web:keepDocument xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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.

<web:keywords xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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

<web:licenseKey xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Sets the license key either as content or URL. If the license key is set to null then PDFreactor looks for a license key file 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.

<web:logExceedingContent xmlns:web="http://webservice.pdfreactor.realobjects.com">
LogExceedingContent01

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.contentObserver instead.

<web:logLevel xmlns:web="http://webservice.pdfreactor.realobjects.com">
LogLevel01

Sets the log level for the conversion log.

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

The default value is LogLevel.INFO.

<web:logMaxLines xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Sets the maximum amount of log entries that will be retained by the PDFreactor logs.

The default value is 100000.

A capacity of 0 is equivalent to the default value. A negative value means that the capacity will be unlimited.

<web:mediaFeatureValues xmlns:web="http://webservice.pdfreactor.realobjects.com">
MediaFeatureValue0Unbounded

Defines the value of a Media Feature which is used to resolve CSS3 media queries.

<web:mediaTypes xmlns:web="http://webservice.pdfreactor.realobjects.com">
String0Unbounded

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"

<web:mergeByteArray xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary01

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

<web:mergeByteArrays xmlns:web="http://webservice.pdfreactor.realobjects.com">
byte[]0Unbounded

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

<web:mergeDocuments xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource0Unbounded

This method sets external PDF documents which will be merged with the PDF document generated by the HTML source.

<web:mergeMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
MergeMode01

Sets the merge mode.

The following merge methods can be used:

The default value is MergeMode.APPEND.

<web:mergeURL xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

<web:mergeURLs xmlns:web="http://webservice.pdfreactor.realobjects.com">
String0Unbounded

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

<web:outputFormat xmlns:web="http://webservice.pdfreactor.realobjects.com">
OutputFormat01

Sets the OutputFormat. The default value is OutputFormat.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.

<web:outputIntent xmlns:web="http://webservice.pdfreactor.realobjects.com">
OutputIntent01

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.

<web:overlayRepeat xmlns:web="http://webservice.pdfreactor.realobjects.com">
OverlayRepeat01

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 OverlayRepeat constants to specify the overlay repeat. The default value is OverlayRepeat.NONE.

<web:ownerPassword xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Sets the owner password of the PDF document.

The default value is null.

<web:pageOrder xmlns:web="http://webservice.pdfreactor.realobjects.com">
[PageOrder, String]01

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

If Configuration.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.

<web:pagesPerSheetProperties xmlns:web="http://webservice.pdfreactor.realobjects.com">
PagesPerSheetProperties01

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

If PagesPerSheetProperties.cols or PagesPerSheetProperties.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.

<web:pdfScriptAction xmlns:web="http://webservice.pdfreactor.realobjects.com">
PdfScriptAction0Unbounded

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.

<web:pixelsPerInch xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

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 96 ppi.

<web:pixelsPerInchShrinkToFit xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

<web:postTransformationDocumentType xmlns:web="http://webservice.pdfreactor.realobjects.com">
Doctype01

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.

<web:printDialogPrompt xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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

The default value is false.

<web:processingPreferences xmlns:web="http://webservice.pdfreactor.realobjects.com">
ProcessingPreferences0Unbounded

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.

<web:quirksSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
QuirksSettings01

Allows to enable or disable behaviors that are otherwise depend on the doctype of the input document.

<web:rawCookies xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

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

<web:requestHeaders xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

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

<web:requestPriority xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the priority of the conversion request. A higher priority means that the web service will adjust the conversion's position in the queue appropriately, so that it is converted before others with lower priority.

By default, asynchronous conversions have a priority of 0, synchronous conversions have a priority of 10.

<web:resourceConnectTimeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Sets a timeout in milliseconds for connecting to resources, such as HTTP requests to style sheets, images etc. If the connection could not be established until the timeout expires, the request will be aborted and the resource will not be loaded.

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

<web:resourceReadTimeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

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

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

<web:resourceRequestTimeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.resourceConnectTimeout and Configuration.resourceReadTimeout instead.

<web:segmentationSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
SegmentationSettings01

This property configures segmentation of the conversion, which helps with very large documents.

<web:signPDF xmlns:web="http://webservice.pdfreactor.realobjects.com">
SignPDF01

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 cryptographic filter that is used for signing.

<web:subject xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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

<web:throwLicenseExceptions xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.errorPolicies instead.

<web:title xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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

<web:urlRewriteSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">
UrlRewriteSettings01

Specifies settings for URL rewrites, which will transform URLs into others according to certain rules.

<web:userPassword xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Sets the user password of the PDF document.

The default value is null.

<web:userScripts xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource0Unbounded

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.
<web:userStyleSheets xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource0Unbounded

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.
<web:validateConformance xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables PDFreactor to validate the generated PDF against the Conformance specified via Configuration.conformance.

Currently only PDF/A and PDF/UA validation is supported.

Please note that validation might take several minutes for larger documents.

<web:viewerPreferences xmlns:web="http://webservice.pdfreactor.realobjects.com">
ViewerPreferences0Unbounded

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.

<web:xmp xmlns:web="http://webservice.pdfreactor.realobjects.com">
Xmp01

Sets custom XMP to be embedded into the PDF document.

If both Xmp.content and Xmp.uri are not set or null no custom XMP is embedded. If XmpPriority is also set to XmpPriority.HIGH automatic generation of required XMP is also suppressed. This may cause output PDFs to not achieve a specified conformance.

<web:xsltMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

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.

<web:xsltStyleSheets xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource0Unbounded

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.

<web:Attachment xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing attachment data.

<web:data xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary01

The binary content of the attachment. May be null.

<web:description xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The description of the attachment. If this is not set or null the value of Attachment.name is used.

<web:name xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The file name associated with the attachment. It is recommended to specify the correct file extension. If this is not set or null the name is derived from Attachment.url.

<web:url xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

If Attachment.data is not set or set to null, the attachment will be retrieved from this URL.

If this is "#" the input document URL is used instead.

<web:BookletMode xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing booklet mode data.

<web:rtl xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Whether or not the reading order of the booklet should be right-to-left.

<web:sheetMargin xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The sheet margin as CSS margin value, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "0mm".

<web:sheetSize xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The size of the sheet as CSS value, for example "A3", "letter landscape", "15in 20in" or "20cm 30cm".

<web:Bundle xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing a bundle of documents.
<web:documents xmlns:web="http://webservice.pdfreactor.realobjects.com">
Document0Unbounded
An array of documents requests.

<web:Callback xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing callback data.

<web:contentType xmlns:web="http://webservice.pdfreactor.realobjects.com">
ContentType01

The content type of the payload that is posted.

<web:interval xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The interval in seconds at which to trigger repeating callbacks.

Only applies CallbackType.PROGRESS.

<web:timeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

An optional timeout for the callback in milliseconds. A value of zero or negative values are treated as an infinite timeout.

<web:type xmlns:web="http://webservice.pdfreactor.realobjects.com">
CallbackType01

The event to trigger the callback.

<web:url xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The URL to call back.

<web:ColorSpaceSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing settings for the potential conversion of CSS colors and images into the target color space.

<web:cmykIccProfile xmlns:web="http://webservice.pdfreactor.realobjects.com">
Resource01

Specifies the ICC profile which defines the CMYK color space into or from which CSS colors and images are converted, if ColorSpaceSettings.conversionEnabled.

<web:conversionEnabled xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables the conversion of CSS colors and images to the ColorSpaceSettings.targetColorSpace using the ColorSpaceSettings.cmykIccProfileUrl or naively if there is none.

<web:targetColorSpace xmlns:web="http://webservice.pdfreactor.realobjects.com">
ColorSpace01

Specifies the target color-space of the PDF.

This is the color space, CSS keyword based colors are converted to, as well as, if ColorSpaceSettings.conversionEnabled, other CSS colors and images.

It also is the color space for PDF/A and PDF/X documents.

Defaults to ColorSpace.RGB RGB.

<web:Connection xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type that describes a URL connection attempt of PDFreactor during a conversion.

<web:cached xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Whether the response was retrieved from a cache.

<web:connected xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Whether a URL connection could be established by PDFreactor. If this is false, see Connection.error for details.

<web:contentSize xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The amount of content bytes downloaded or read from this connection.

<web:duration xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The duration in milliseconds how long this connection remained open.

<web:error xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The error message if the connection could not be established.

<web:method xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The request method used by the underlying HTTP request (like "GET", "POST", etc.) or null if this is not an HTTP connection or the connection could not be established.

<web:protocol xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The protocol of the URL connection.

<web:requestContentSize xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The amount of content bytes uploaded or written to this connection.

<web:requestHeaders xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

The request headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

<web:resourceType xmlns:web="http://webservice.pdfreactor.realobjects.com">
ResourceType01

The type of resource (style sheet, image, etc.) transferred over this connection.

<web:responseHeaders xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeyValuePair0Unbounded

The response headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

<web:statusCode xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The response code for HTTP connections or 0 for all other connections.

<web:statusMessage xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The response message for the response code or null if the response code is 0 or the message could not be determined.

<web:timestamp xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The time stamp of this connection.

<web:url xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The URL.

<web:ContentObserver xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing specifications on which content should be observed.

<web:connections xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables observation of URL connections done by PDFreactor.

<web:exceedingContentAgainst xmlns:web="http://webservice.pdfreactor.realobjects.com">
ExceedingContentAgainst01

Enables observation of exceeding content either against the page edges, page content areas or containers.

<web:exceedingContentAnalyze xmlns:web="http://webservice.pdfreactor.realobjects.com">
ExceedingContentAnalyze01

Enables observation of exceeding content and optionally of boxes.

<web:missingResources xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables observation of resources that could not be loaded.

<web:ContinuousOutput xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing continuous output data.

<web:height xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Equivalent to the height of a browser window (view port). For values <1 the entire height of the document is used.

<web:width xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Equivalent to the width of a browser window (view port). Values <1 enable paginated output.

<web:CssSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing settings of how CSS properties are supported.

<web:supportQueryMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
CssPropertySupport01

Adjusts the CSS property support behavior.

<web:validationMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
CssPropertySupport01

Adjusts the CSS property validation behavior.

<web:DebugSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing various options for debugging.

<web:all xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

This is a convenience property that enables the following DebugSettings:

<web:appendLogs xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether the logs will be appended to the resulting PDF.

<web:attachConfiguration xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether the configuration will be attached to the generated PDF.

<web:attachDocuments xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether all debug files belonging to the group "documents" will be attached to the generated PDF. Please see the manual for more information.

<web:attachLogs xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether all debug files belonging to the group "logs" will be attached to the generated PDF. Please see the manual for more information.

<web:attachResources xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether all debug files belonging to the group "resources" will be attached to the generated PDF. Please see the manual for more information.

<web:forceResult xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Forces PDFreactor to return a result, regardless of any exceptions or errors that may have occurred during the conversion.

If an exception or error occurred during the conversion, its stack trace and the PDFreactor log is written as-is into the result data stream. This means that the resulting document will not be a valid PDF but can be opened with an appropriate text editor to view the log and errors.

<web:Document xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing a document request
<web:id xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The document ID.
<web:name xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The file name representing the document in the ZIP. If the document is a multi-image, you can use the '#' character in the file name as a placeholder for the page number.

<web:ExceedingContent xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type that describes one instance of content exceeding its page or parent.

<web:bottom xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Returns whether the content exceeds the page at the bottom.

<web:box xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Returns whether the exceeding content is a box instead of text or image content.

<web:containerBottom xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the bottom coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

<web:containerLeft xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the left coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

<web:containerRight xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the right coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

<web:containerTop xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the top coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

<web:description xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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.

<web:exceedingBoxBottom xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the bottom coordinate of the the exceeding box in the page in pixels.

<web:exceedingBoxLeft xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the left coordinate of the the exceeding box in the page in pixels.

<web:exceedingBoxRight xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the right coordinate of the the exceeding box in the page in pixels.

<web:exceedingBoxTop xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the top coordinate of the the exceeding box in the page in pixels.

<web:html xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Returns the HTML of the box that contains the exceeding content.

<web:left xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Returns whether the content exceeds the page to the left.

<web:pageBottom xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the bottom coordinate of the the page in pixels.

<web:pageLeft xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the left coordinate of the the page in pixels.

<web:pageNumber xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the number of the page that contains the exceeding content.

<web:pageRight xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the right coordinate of the the page in pixels.

<web:pageTop xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the top coordinate of the the page in pixels.

<web:path xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer0Unbounded

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.

<web:right xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Returns whether the content exceeds the page to the right.

<web:summary xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Returns a summary of this exceeding content object.

<web:top xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Returns whether the content exceeds the page at the top.

<web:Font xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing font data.

<web:bold xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Whether the alias will be labeled bold.

<web:family xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The alias name for that font.

<web:italic xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Whether the alias will be labeled italic.

<web:source xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The source URL of the font (when adding new fonts) or the name of an existing font family (when creating an alias).

<web:InspectableSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing settings related to inspectable documents.

<web:enabled xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether to make the document inspectable.

<web:endPage xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies an optional page number below which the DOM is not inspected.

Page numbers start at 1. The default 0 goes up the last page. Other values are inclusive.

<web:startPage xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies an optional page number below which the DOM is not inspected.

Page numbers start at 1. The default 0 starts at the first page.

<web:JavaScriptSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing settings related to JavaScript.

<web:debugIndentation xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the amount of spaces per indentation level when using JavaScript debugging.

The default value is 0.

<web:debugMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
JavaScriptDebugMode01

Specifies the debug mode.

Any other value than the default JavaScriptDebugMode.NONE impacts performance significantly and should not be used in production.

<web:enabled xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether to process JavaScript.

<web:ignoreScriptElements xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether to ignore <script> elements in the document, only executing user scripts.

<web:maxQueuedTasks xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the maximum amount of tasks to be queued before ending JavaScript processing.

Values smaller than 1 default to 1,000,000.

<web:maxScriptElements xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the maximum amount of script elements in the document to process.

Values smaller than 1 default to 1,000,000.

<web:maxTasksWithoutDomChange xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the maximum amount of tasks to be allowed to be queued, while the DOM does not change, before ending JavaScript processing.

Values smaller than 1 default to 1,000.

<web:maxVirtualTimeOffset xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Specifies the maximum amount of virtual time in seconds to let pass before ending JavaScript processing.

Values smaller than 1 default to 3600 (1h).

<web:noLayout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether to process JavaScript without causing document layouts or updates.

This can speed up conversions, but will break a significant amount of functionality and libraries.

<web:noVirtualTime xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether not to use virtual time for JavaScript.

Only use if required for a specific library.

<web:timeLapse xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Specifies whether to fast-forward the virtual time of JavaScript every time it is retrieved.

Only use if required for a specific library.

<web:timeout xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Sets a timeout in seconds for JavaScript processing If the timeout is exceeded, the conversion will be aborted.

A timeout of 0 or negative values mean that the conversion will never time out. This is also the default behavior if no timeout is specified.

<web:KeyValuePair xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing a key-value-pair.

<web:key xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The key.

<web:value xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The value.

<web:Log xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing the log of a conversion.
<web:records xmlns:web="http://webservice.pdfreactor.realobjects.com">
Record0Unbounded
The log records of the main PDFreactor log.
<web:recordsCss xmlns:web="http://webservice.pdfreactor.realobjects.com">
Record0Unbounded
The log records of the PDFreactor CSS log.
<web:recordsJavaScript xmlns:web="http://webservice.pdfreactor.realobjects.com">
Record0Unbounded
The log records of the PDFreactor JavaScript log.

<web:LogExceedingContent xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing data for logging exceeding content.

<web:logExceedingContentAgainst xmlns:web="http://webservice.pdfreactor.realobjects.com">
ExceedingContentAgainst01

Enables logging of exceeding content either against the page edges, page content areas or containers.

<web:logExceedingContentAnalyze xmlns:web="http://webservice.pdfreactor.realobjects.com">
ExceedingContentAnalyze01

Enables logging of exceeding content and optionally of boxes.

<web:MediaFeatureValue xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing media feature data.

<web:mediaFeature xmlns:web="http://webservice.pdfreactor.realobjects.com">
MediaFeature01

The media feature.

<web:value xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The value that is associated with the given media feature.

<web:MissingResource xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type that describes a missing resource.

<web:message xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The message indicating why the resource could not be found.

<web:resource xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The resource identifier. Usually a URL string.

<web:type xmlns:web="http://webservice.pdfreactor.realobjects.com">
ResourceType01

The type of resource (style sheet, image, etc.).

<web:OutputFormat xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing output data.

<web:height xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

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.

<web:multiImage xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Indicates whether the image output will be paginated into multiple images.

<web:pixelDensity xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The pixel density of the output (image formats only). When neither 'width' nor 'height' is specified this is used to determine the dimensions of the image from the page size. Values <1 default to 96dpi.

<web:pixelDensityUnit xmlns:web="http://webservice.pdfreactor.realobjects.com">
ResolutionUnit01

The unit of the pixel density. Defaults to dpi.

<web:type xmlns:web="http://webservice.pdfreactor.realobjects.com">
OutputType01

The output format. See OutputType constants.

<web:width xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

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.

<web:OutputIntent xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing data for an output intents.

<web:data xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary01

The profile data.

<web:identifier xmlns:web="http://webservice.pdfreactor.realobjects.com">
[OutputIntentDefaultProfile, String]01

The identifier.

<web:url xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The profile URL.

<web:PagesPerSheetProperties xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing data for pages per sheet properties.

<web:cols xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The number of columns per sheet.

<web:direction xmlns:web="http://webservice.pdfreactor.realobjects.com">
PagesPerSheetDirection01

The direction in which the pages are ordered on a sheet.

<web:rows xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The number of rows per sheet.

<web:sheetMargin xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The sheet margin as CSS margin, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "0mm".

<web:sheetSize xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The sheet size as CSS size, for example "A4", "letter landscape", "15in 20in" or "20cm 30cm".

<web:spacing xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The horizontal and vertical space between pages on a sheet as CSS value, for example "0.1in" or "5mm 2mm". null is interpreted as "0mm".

<web:PdfScriptAction xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing PDF script data.

<web:script xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The script source that should be executed.

<web:triggerEvent xmlns:web="http://webservice.pdfreactor.realobjects.com">
PdfScriptTriggerEvent01

The event on which the script is executed. Value is a PdfScriptTriggerEvent constant.

<web:Progress xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing the progress of an asynchronous conversion.
<web:callbackUrl xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
If this object was created for a callback, this property indicates the callback's URL.
<web:contentType xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The content type of the resulting document as a MIME type string. Depends on what OutputType was set in the Configuration. If none was set, the content type defaults to "application/pdf".
<web:conversionName xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
Returns the name of the conversion if it was specified via Configuration.conversionName.
<web:documentId xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The document ID of the conversion. This ID can be used to poll the progress or retrieve the result.
<web:documentUrl xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The relative URL to the location where you can download the generated document once it is finished.
<web:documentUrls xmlns:web="http://webservice.pdfreactor.realobjects.com">
String0Unbounded
The relative URLs to the locations where you can download the generated documents once they are finished.
<web:finished xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01
Indicates whether the conversion is finished yet.
<web:log xmlns:web="http://webservice.pdfreactor.realobjects.com">
Log01
The log of the conversion.
<web:progress xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The current progress of the conversion. The value is between 0 and 100.
<web:startDate xmlns:web="http://webservice.pdfreactor.realobjects.com">
Date01
The date and time when the conversion was started on the server.

<web:QuirksSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing quirks settings.

<web:caseSensitiveClassSelectors xmlns:web="http://webservice.pdfreactor.realobjects.com">
QuirksMode01

By default in HTML CSS class selectors are case sensitive.

In the default QuirksMode.DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode.STANDARDS or QuirksMode.QUIRKS respectively.

<web:minLineHeightFromContainer xmlns:web="http://webservice.pdfreactor.realobjects.com">
QuirksMode01

By default the line-height of text containers, e.g. paragraph elements, is used as the minimum line-height of their lines.

In the default QuirksMode.DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode.STANDARDS or QuirksMode.QUIRKS respectively.

<web:Record xmlns:web="http://webservice.pdfreactor.realobjects.com">

A log record.
<web:level xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The level of the record.
<web:levelName xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The textual representation of the level.
<web:message xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The logged message.
<web:timestamp xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The timestamp.

<web:Resource xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing data for external resources such as style sheets.

<web:beforeDocumentScripts xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.

Only supported for JavaScript-type resources.

<web:content xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The content of the resource. Only supported for Style Sheet- and Script-type resources.

<web:data xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary01

The binary data of the resource.

<web:uri xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The URI of the resource.

<web:Result xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing the result of a conversion.
<web:callbackUrl xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
If this object was created for a callback, this property indicates the callback's URL.
<web:connections xmlns:web="http://webservice.pdfreactor.realobjects.com">
Connection0Unbounded

Provides a log about all URL connections attempted by PDFreactor, including information about HTTP request and result, should the connection be an HTTP or HTTPS connection. Depends on the mode set via Configuration.contentObserver.

<web:contentType xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The content type of the resulting document as a MIME type string. Depends on what OutputType was set in the Configuration. If none was set, the content type defaults to "application/pdf".
<web:conversionName xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
Returns the name of the conversion if it was specified via Configuration.conversionName.
<web:document xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary1

The resulting PDF or image.

This is not present if only the document's metadata was retrieved.

Alternatively, the input document can be specified directly as Binary or as Base64-encoded string.
<web:documentArray xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary0Unbounded

The resulting image as a collection of separate images, each representing a single page. This property is only present if the configuration option "multiImage" was set to true.

This is also not present if only the document's metadata was retrieved.

<web:documentId xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The document ID of the conversion. This ID can be used to poll the progress or retrieve the result.
<web:documentUrl xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The relative URL to the location where you can download the generated document once it is finished.
<web:documentUrls xmlns:web="http://webservice.pdfreactor.realobjects.com">
String0Unbounded
The relative URLs to the locations where you can download the generated documents once they are finished.
<web:endDate xmlns:web="http://webservice.pdfreactor.realobjects.com">
Date01

The date and time when the conversion was finished on the server.

<web:error xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

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

<web:exceedingContents xmlns:web="http://webservice.pdfreactor.realobjects.com">
ExceedingContent0Unbounded

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

<web:javaScriptExports xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

Returns data that has been exported from document JavaScript via ro.exports if set, null otherwise. If the JavaScript data is not a string, it will be converted to JSON. If the data can't be converted, a generic string representation is used or null if none is available.

<web:keepDocument xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Indicates whether or not the keepDocument property was set in the Configuration of this conversion. If true, additional requests can be made to retrieve this document.

<web:log xmlns:web="http://webservice.pdfreactor.realobjects.com">
Log01

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

<web:missingResources xmlns:web="http://webservice.pdfreactor.realobjects.com">
MissingResource0Unbounded

Provides information about resources that could not be loaded during the conversion. Depends on the mode set via Configuration.contentObserver.

<web:numberOfPages xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

Returns the number of pages of the document after conversion.

<web:numberOfPagesLiteral xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

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.

<web:startDate xmlns:web="http://webservice.pdfreactor.realobjects.com">
Date01
The date and time when the conversion was started on the server.

<web:ScriptResource xmlns:web="http://webservice.pdfreactor.realobjects.com">

Deprecated as of PDFreactor 9. Use Resource instead.

<web:beforeDocumentScripts xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.

Only supported for JavaScript-type resources.

<web:content xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The content of the resource. Only supported for Style Sheet- and Script-type resources.

<web:data xmlns:web="http://webservice.pdfreactor.realobjects.com">
Binary01

The binary data of the resource.

<web:uri xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The URI of the resource.

<web:SegmentationSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing settings for segmenting input documents.

<web:enabled xmlns:web="http://webservice.pdfreactor.realobjects.com">
Boolean01

Enables or disables segmentation.

<web:segmentSize xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01

The preferred size (in number of pages) of the segments into which the conversion will be split.

Valid values range from 10 to 1000. Values smaller than 1 default to 1000.

<web:SignPDF xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing data for signing the PDF.

<web:keyAlias xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The alias of the certificate included in the keystore to be used to sign the PDF.

<web:keyPassword xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The password for the certificate included in the keystore to be used to sign the PDF.

If none is provided, the keystore password will be used for the certificate.

<web:keystorePassword xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The password of the keystore.

<web:keystoreType xmlns:web="http://webservice.pdfreactor.realobjects.com">
KeystoreType01

The format of the keystore, for example PKCS #12 or JKS. Use one of the KeystoreType constants as value.

<web:keystoreURL xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The URL to the keystore file.

<web:signingMode xmlns:web="http://webservice.pdfreactor.realobjects.com">
SigningMode01

The cryptographic filter mode that is used to sign the PDF, like SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED.

Use one of the SigningMode constants as value.

<web:UrlRewriteRule xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing various options for debugging.

<web:pattern xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

The regular expression pattern which is matched against each URL.

Note that the URLs are always absolute. If they are initially relative in the document or other resources, they are resolved.

<web:substitution xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

If a URL matches the UrlRewriteRule.pattern, it is replaced by this substitution. Since the pattern is a regular expression, the substitution can include group identifiers or back references.

<web:UrlRewriteSettings xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing various options for URL rewrites.

<web:rules xmlns:web="http://webservice.pdfreactor.realobjects.com">
UrlRewriteRule0Unbounded

The rules according to which URLs are rewritten.

<web:Version xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type representing the version of PDFreactor.
<web:build xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The build number.
<web:label xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The label of the version.
<web:major xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The major version.
<web:micro xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The micro version.
<web:minor xmlns:web="http://webservice.pdfreactor.realobjects.com">
Integer01
The minor version.
<web:revision xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The revision number.
<web:text xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01
The version as text.

<web:Xmp xmlns:web="http://webservice.pdfreactor.realobjects.com">

A type containing XMP data.

<web:content xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

XMP, as an XML string, to be embedded into the PDF document.

<web:priority xmlns:web="http://webservice.pdfreactor.realobjects.com">
XmpPriority01

Priority of this XMP over XMP generated automatically for the conformance requirements of certain output formats.

<web:uri xmlns:web="http://webservice.pdfreactor.realobjects.com">
String01

URI to XMP to be embedded into the PDF document, if Xmp.content is not set or null.

Constants

<web:AddressType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing IP address types.

Link-local addresses or auto-IPs.

LOCAL

Localhost addresses, including "localhost" or "0.0.0.0".

PRIVATE

Private network addresses.

PUBLIC

Public internet addresses.

<web:CallbackType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing callback type constants.

FINISH

This callback is called when the conversion is finished.

PROGRESS

This callback is called regularly to inform on the progress of the conversion.

START

This callback is called when the conversion is started.

<web:Cleanup xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing cleanup constants.

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.

<web:ColorSpace xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing color space constants.

CMYK

The color space CMYK.

RGB

The color space RGB.

<web:Conformance xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing conformance constants.

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 (ISO 19005-1:2005 Level A + ISO 14289-1:2014)

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 (ISO 19005-2:2011 Level A + ISO 14289-1:2014)

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 (ISO 19005-3:2012 Level A + ISO 14289-1:2014)

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 14289-1:2014)

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)

<web:ConnectionRuleAction xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing security rule action constants.

ALLOW

Allows connections to resources matching the rule.

DENY

Denies connections to resources matching the rule.

<web:ContentType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing content type constants.

BINARY

Content type BINARY, corresponds with "application/octet-stream" MIME type.

BMP

Content type BMP, corresponds with "image/bmp" MIME type.

GIF

Content type GIF, corresponds with "image/gif" MIME type.

HTML

Content type HTML, corresponds with "text/html" MIME type.

JPEG

Content type JPEG, corresponds with "image/jpeg" MIME type.

JSON

Content type JSON, corresponds with "application/json" MIME type.

NONE

Content type NONE, i.e. no content.

PDF

Content type PDF, corresponds with "application/pdf" MIME type.

PNG

Content type PNG, corresponds with "image/png" MIME type.

TEXT

Content type TEXT, corresponds with "text/plain" MIME type.

TIFF

Content type TIFF, corresponds with "image/tiff" MIME type.

XML

Content type XML, corresponds with "application/xml" MIME type.

<web:CssPropertySupport xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing CSS property support mode constants.

ALL

Indicates that all style declarations are considered valid disregarding the possibility of improper rendering.

Valid values may be overwritten by invalid style declarations.

HTML

Indicates that all values set in style declarations will be validated as long as PDFreactor supports the corresponding property.

Style declarations for properties not supported by PDFreactor are taken as invalid.

HTML_THIRD_PARTY

Indicates that all values set in style declarations will be validated as long as PDFreactor supports the corresponding property.

Style declarations for properties not supported by PDFreactor but by third party products are taken as valid.

HTML_THIRD_PARTY_LENIENT

Indicates that all values set in style declarations will be taken as valid if a third party product supports the corresponding property.

Style declarations for properties not supported by any third party product but supported by PDFreactor will be validated.

<web:Doctype xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing document type constants.

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.

<web:Encryption xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing encryption constants.

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.

<web:ErrorPolicy xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing error policies.

CONFORMANCE_VALIDATION_UNAVAILABLE

Whether an exception should be thrown when the PDF's conformance was not validated even though Configuration.validateConformance was enabled. Now exceptions will be thrown if the validation module is not available or the conformance format is not fully supported for validation.

Use this policy only if you exclusively convert documents where validation is supported and strictly required.

LICENSE

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.

MISSING_RESOURCE

Whether an exception should be thrown when resources could not be loaded.

UNCAUGHT_JAVASCRIPT_EXCEPTION

Whether an exception should be thrown when there are uncaught exceptions in the input document JavaScript, including syntax error.

<web:ExceedingContentAgainst xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing constants for logging exceeding content against.

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.

<web:ExceedingContentAnalyze xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing constants for analyzing exceeding content.

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.

<web:HttpsMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing HTTPS mode constants.

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.

<web:JavaScriptDebugMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing JavaScript debug mode constants.

EXCEPTIONS

Indicates that all exceptions thrown during JavaScript processing are logged in addition to the effects of POSITIONS.

FUNCTIONS

Indicates that all JavaScript functions entered or exited are logged in addition to the effects of POSITIONS and EXCEPTIONS.

LINES

Indicates that every line of executed JavaScript is logged in addition to the effects of POSITIONS, EXCEPTIONS and FUNCTIONS.

NONE

Indicates that debugging is disabled.

POSITIONS

Indicates that the filenames and line numbers that caused output (e.g. via console.log) are logged.

<web:JavaScriptMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

Deprecated as of PDFreactor 10. Use JavaScriptSettings instead.

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.

<web:KeystoreType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing keystore type constants.

JKS

Keystore type "jks".

PKCS12

Keystore type "pkcs12".

<web:LogLevel xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing log level constants.

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.

<web:MediaFeature xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing media feature constants.

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).

<web:MergeMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing merge mode constants.

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 Configuration.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.

<web:OutputIntentDefaultProfile xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing default profiles for output intents.

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.

<web:OutputType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing output format constants.

BMP

BMP output format.

GIF

GIF output format.

GIF_DITHERED

JPEG output format, with dithering applied.

JPEG

JPEG output format.

PDF

PDF output format.

PNG

PNG output format.

PNG_AI

Deprecated

PNG output format (deprecated alternative name).

PNG_TRANSPARENT

Transparent PNG output format.

PNG_TRANSPARENT_AI

Deprecated

Transparent PNG output format (deprecated alternative name).

TIFF_CCITT_1D

Monochrome CCITT 1D/RLE compressed TIFF output format.

TIFF_CCITT_1D_DITHERED

Monochrome CCITT 1D/RLE compressed TIFF output format, with dithering applied.

TIFF_CCITT_GROUP_3

Monochrome CCITT Group 3/T.4 compressed TIFF output format.

TIFF_CCITT_GROUP_3_DITHERED

Monochrome CCITT Group 3/T.4 compressed TIFF output format, with dithering applied.

TIFF_CCITT_GROUP_4

Monochrome CCITT Group 4/T.6 compressed TIFF output format.

TIFF_CCITT_GROUP_4_DITHERED

Monochrome CCITT Group 4/T.6 compressed TIFF output format, with dithering applied.

TIFF_LZW

LZW compressed TIFF output format.

TIFF_PACKBITS

PackBits compressed TIFF output format.

TIFF_UNCOMPRESSED

Uncompressed TIFF output format.

<web:OverlayRepeat xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing data for repeating overlays.

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.

<web:PageOrder xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing pre-defined page orders.

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.

<web:PagesPerSheetDirection xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing constants for pages per sheet directions.

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.

<web:PdfScriptTriggerEvent xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing trigger events for PDF scripts.

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.

<web:ProcessingPreferences xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing constants for processing preferences.

SAVE_MEMORY_IMAGES

Processing preferences flag for the memory saving mode for images.

<web:QuirksMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing modes for Quirks.

DETECT

Doctype dependent behavior.

QUIRKS

Forced quirks behavior.

STANDARDS

Forced no-quirks behavior.

<web:ResolutionUnit xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing resolution units.

DPCM

Dots per inch. The default 1dppx/96dpi in this unit is about 38.

DPI

Dots per Inch. The default 1dppx/96dpi in this unit is 96.

DPPX

Dots per 'px' unit. The default 1dppx/96dpi in this unit is 1.

TDPCM

Thousand dots per centimeter. The default 1dppx/96dpi in this unit is about 37795.

TDPI

Thousand dots per inch. The default 1dppx/96dpi in this unit is 96000.

TDPPX

Thousand dots per 'px' unit. The default 1dppx/96dpi in this unit is 1000.

<web:ResourceType xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

Indicates the type of resource.

ATTACHMENT

An attachment.

DOCUMENT
The main HTML or XML document.
FONT

A font.

ICC_PROFILE

An ICC profile.

IFRAME

An iframe.

IMAGE

An image.

LICENSEKEY

The license key.

MERGE_DOCUMENT

A merge document.

OBJECT

An embedded object.

RUNNING_DOCUMENT

A running document.

SCRIPT

A script.

STYLESHEET

A style sheet.

UNKNOWN

An unknown resource type.

XHR
An XMLHttpRequest.

<web:SigningMode xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing the cryptographic filter type that is used for signing.

SELF_SIGNED

The self signed filter: PDFreactor creates a signature with the adbe.x509.rsa_sha1 (PKCS#1) filter type.

VERISIGN_SIGNED

The VeriSign filter. PDFreactor creates a signature with VeriSign filter type.

WINCER_SIGNED

The Windows Certificate Security: PDFreactor creates a signature with the adbe.pkcs7.sha1 (PKCS#7) filter type.

<web:ViewerPreferences xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing constants for viewer preferences.

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.

<web:XmpPriority xmlns:web="http://webservice.pdfreactor.realobjects.com"> String

An enum containing the priority for XMP.

HIGH

Embed XMP ignoring requirements of the output format.

This may cause output PDFs to not achieve a specified conformance.

LOW

Embed XMP if the output format does not have XMP requirements.

NONE

Do not embed XMP.