This is the PDFreactor 7.0 .NET API

RealObjects(R) PDFreactor(R) is a powerful formatting processor for converting HTML and XML documents into PDF.

The library assembly PDFreactor.dll offers you a large subset of the Java-API and takes care of all communication with the service.

The simplest sample for the PDFreactor .NET API: 
<%@ Page Language="C#" Debug="false" %>
<%
    PDFreactor pdfReactor = new PDFreactor();
    pdfReactor.SetAddLinks(true);
    byte[] PDF = pdfReactor.RenderDocumentFromURL("http://www.pdfreactor.com/");
    Response.ContentType = "application/pdf";
    Response.BinaryWrite(PDF);
%>

This API requires the PDFreactor SOAP service to be running on your system.

List of all members.

Public Member Functions

 PDFreactor ()
 Constructs an instance of the PDFreactor.
 PDFreactor (String host)
 Constructs an instance of the PDFreactor using the specified host.

Parameters:
host The host name.

 PDFreactor (int port)
 Constructs an instance of the PDFreactor using the specified port.

Parameters:
port The port.

 PDFreactor (String host, int port)
 Constructs an instance of the PDFreactor using the specified host and port.

Parameters:
host The host name.
port The port.

byte[] RenderDocumentFromURL (String URL)
 Generates a PDF document from an XML document at a URL.

Parameters:
URL A URL pointing to the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromByteArray, RenderDocumentFromContent


byte[] RenderDocumentFromContent (String content)
 Generates a PDF document from an XML document inside a string.

Parameters:
content A string containing the content of the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromURL, RenderDocumentFromByteArray, RenderDocumentFromContentAsArray


byte[] RenderDocumentFromByteArray (byte[] byteArray)
 Generates a PDF document from an XML document inside a byte array.

Parameters:
byteArray An array containing the content of the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromURL, RenderDocumentFromContent, RenderDocumentFromByteArrayAsArray


byte[][] RenderDocumentFromURLAsArray (String URL)
 Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document at a URL.

Parameters:
url A URL pointing to the input document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromURL, RenderDocumentFromByteArrayAsArray, RenderDocumentFromContentAsArray


byte[][] RenderDocumentFromContentAsArray (String content)
 Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document inside a String.

Parameters:
content A String containing the content of the HTML or XML document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromContent, RenderDocumentFromByteArrayAsArray, RenderDocumentFromURLAsArray


byte[][] RenderDocumentFromByteArrayAsArray (byte[] byteArray)
 Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document inside a byte-array.

Parameters:
byteArray An array containing the content of the HTML or XML document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromContentAsArray, RenderDocumentFromByteArray, RenderDocumentFromURLAsArray


String GetError ()
 Returns the error messages generated during rendering.

Returns:
The message string.

String GetLog ()
 Returns the log messages generated during rendering based on the log level.

Returns:
The log string.
See also:
SetLogLevel


ExceedingContent[] GetExceedingContents ()
 Provides information about content exceeding its page or parent. Depends on the mode set via setLogExceedingContent(int, int).

See also:
SetLogExceedingContent


int GetNumberOfPages (bool pdf)
 Returns the number of pages of the document after conversion.

The result returned by this method will only be correct if the document has already been laid out by one of the render methods:

  1. renderDocument(InputSource, OutputStream)
  2. renderDocumentFromByteArray(byte[])
  3. renderDocumentFromContent(String)
  4. renderDocumentFromURL(String)

void SetAddBookmarks (bool val)
 Enables or disables bookmarks in the PDF document.

The default value is false

Parameters:
val Use true to enable bookmarks in the document and false to disable bookmarks.

void SetAddLinks (bool val)
 Enables or disables links in the PDF document.

The default value is false

Parameters:
val Use true to enable links in the document and false to disable links.

void SetAddComments (bool val)
 Enables or disables comments in the PDF document.

The default value is false

Parameters:
val Use true to enable comments in the document and false to disable comments.

void SetAddPreviewImages (bool val)
 Enables or disables embedding of image previews per page in the PDF document.

The default value is false

Parameters:
val Use true to enable embedding of image previews per page in the document and false to disable embedding of image previews per page.

void SetAddTags (bool val)
 Enables or disables tagging of the PDF document.

The default value is false

Parameters:
val Use true to enable tagging of the document and false to disable tagging.

void SetAddAttachments (bool val)
 Enables or disables attachments specified in style sheets.

The default value is false.

Parameters:
val Whether to enable CSS based attachments.

void SetAddOverprint (bool val)
 Enables or disables overprinting.

The default value is false

Parameters:
val Whether to enable overprinting.

void SetAllowAnnotations (bool val)
 Enables or disables the 'annotations' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'annotations' in the document and false to disable 'annotations'.
See also:
SetEncryption


void SetAllowAssembly (bool val)
 Enables or disables the 'assembly' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'assembly' in the document and false to disable 'assembly'.
See also:
SetEncryption


void SetAllowCopy (bool val)
 Enables or disables the 'copy' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'copy' in the document and false to disable 'copy'.
See also:
SetEncryption


void SetAllowDegradedPrinting (bool val)
 Enables or disables the 'degraded printing' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'degraded printing' in the document and false to disable 'degraded printing'.
See also:
SetEncryption


void SetAllowFillIn (bool val)
 Enables or disables the 'fill in' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'fill in' in the document and false to disable 'fill in'.
See also:
SetEncryption


void SetAllowModifyContents (bool val)
 Enables or disables the 'modify contents' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'modify contents' in the document and false to disable 'modify contents'.
See also:
SetEncryption


void SetAllowPrinting (bool val)
 Enables or disables the 'printing' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'printing' in the document and false to disable 'printing'.
See also:
SetEncryption


void SetAllowScreenReaders (bool val)
 Enables or disables the 'screen readers' restriction in the PDF document.

The default value is false

Parameters:
val Use true to enable 'screen readers' in the document and false to disable 'screen readers'.
See also:
SetEncryption


void SetAppendLog (bool val)
 Specifies whether or not the log data should be added to the PDF document.

The default value is false

Parameters:
val Use true to add the log data to the document and false if the log data should not be added.

void SetAuthor (String val)
 Sets the value of the author field of the PDF document.

Parameters:
val The author of the document.

void SetBaseURL (String val)
 Sets the base URL of the XML 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

Parameters:
val The base URL for the document.

void SetCacheFonts (bool val)
 Enables or disables caching of font information.

During the PDF creation PDFreactor requires information about fonts in the system The process to get this information takes a long time. Thus PDFreactor offers an option to cache the collected information about fonts. A font cache can be reused by PDFreactor on every PDF creation process but only if font registration is enabled. If font registration is disabled then the font cache will be ignored. (See setDisableFontRegistration(bool) for more information).

The default value is true

Parameters:
val The new value of the cache fonts setting.
See also:
SetDisableFontRegistration, SetFontCachePath, AddFontDirectory


void SetCleanupTool (int val)
 Sets the cleanup tool to use for documents with unparsable content. Use one of the following CLEANUP_ constants to specify the cleanup tool: CLEANUP_NONE CLEANUP_JTIDY CLEANUP_CYBERNEKO CLEANUP_TAGSOUP CLEANUP_DEFAULT

The default value specified by CLEANUP_DEFAULT is CLEANUP_CYBERNEKO.

HTML5 utilizes an internal cleanup.

Parameters:
val The new cleanup tool.

void SetConformance (int val)
 Sets the conformance of the PDF.

The CONFORMANCE_ constants can be used as value. The default value specified is CONFORMANCE_PDF.

Parameters:
val The conformance.

void SetContinuousOutput (int width, int height)
 Enables the conversion of the input document into one image.

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

void SetCreator (String val)
 Sets the value of creator field of the PDF document.

Parameters:
val The creator of the document.

void SetDisableFontRegistration (bool val)
 Enables or disables the font registration. If font registration is enabled and a valid font cache exists then this font cache will be used. If font registration is disabled then an existing font cache will be ignored and the font directories will be scanned for font information.

The default value is false

Parameters:
val The new value of the font registration setting.
See also:
SetCacheFonts, SetFontCachePath, AddFontDirectory


void SetDisableSystemFonts (bool val)
 Enables or disables system fonts. If system fonts are disabled, PDFreactor will neither scan for system fonts nor use the respective font cache.

The default value is false

Parameters:
val The new value of the font registration setting.
See also:
SetDisableFontRegistration, AddFontDirectory


void SetDocumentType (int val)
 Sets the document type. Use one of the following DOCTYPE_ constants to specify the document type: DOCTYPE_AUTODETECT DOCTYPE_XML DOCTYPE_XHTML DOCTYPE_HTML5 DOCTYPE_DEFAULT

The default value specified by DOCTYPE_DEFAULT is DOCTYPE_AUTODETECT.

Parameters:
val The new document type setting.

void SetDocumentDefaultLanguage (String val)
 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.

Parameters:
val The default ISO 639 language code used for documents.

void SetEncoding (String val)
 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

Parameters:
val The encoding of the document or null for autodetection.

void SetEncryption (int val)
 Sets the encryption. Use one of the following ENCRYPTION_ constants to specify the encryption: ENCRYPTION_NONE ENCRYPTION_40 ENCRYPTION_128 ENCRYPTION_DEFAULT

The default value specified by ENCRYPTION_DEFAULT is ENCRYPTION_NONE.

Parameters:
val The new encryption setting.
See also:
SetOwnerPassword, SetUserPassword, SetAllowAnnotations, SetAllowAssembly, SetAllowCopy, SetAllowDegradedPrinting, SetAllowFillIn, SetAllowModifyContents, SetAllowPrinting, SetAllowScreenReaders


void SetFontCachePath (String val)
 Sets the path of the font cache. This path will be used to read and write the font cache. If the font cache path is set to null then the "user.home" directory will be used

The default value is null

Parameters:
val location The path of the font cache.
See also:
SetDisableFontRegistration, SetCacheFonts, AddFontDirectory


void AddFont (String source, String family, Boolean bold, Boolean italic)
 Loads a font from a URL which can be used via the CSS property font-family.

Parameters:
source The URL to load the font from.
family The font family name the loaded font will be labeled as.
bold Whether the font will be labeled bold.
italic Whether the font will be labeled italic.

void AddFontAlias (String source, String family, Boolean bold, Boolean italic)
 Registers an alias font family for an existing font.

Parameters:
source The name of an existing font family.
family The alias name for that font.
bold Whether the alias will be labeled bold.
italic Whether the alias will be labeled italic.

void SetFontDirectory (String val)
 Deprecated! As of PDFreactor 6.0, replaced by AddFontDirectory.
void AddFontDirectory (String val)
 Registers an additional font directory to load fonts from.

Parameters:
val The path of the font directory.

void SetFullCompression (bool val)
 Enables or disables full compression of the PDF document.

The default value is false

Parameters:
val Use true to enable full compression of the document and false to disable full compression.

void SetKeywords (String val)
 Sets the value of the keywords field of the PDF document.

Parameters:
val The keywords of the document.

void SetLicenseKey (String val)
 Sets the license key by 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

Parameters:
val content The content of the license key as a string.

void SetLogLevel (int val)
 Sets the log level.

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

The default value is LOG_LEVEL_NONE.

Parameters:
val The new log level setting.
See also:
LOG_LEVEL_NONE, LOG_LEVEL_FATAL, LOG_LEVEL_WARN, LOG_LEVEL_INFO, LOG_LEVEL_DEBUG, LOG_LEVEL_PERFORMANCE, GetLog


void SetLogExceedingContent (int logExceedingContentAnalyze, int logExceedingContentAgainst)
 Whether to log content exceeding the page.

Use EXCEEDING_CONTENT_ANALYZE_ constants to specify which kind of content should be observed for exceeding content logging. The default value is EXCEEDING_CONTENT_ANALYZE_NONE.

Use EXCEEDING_CONTENT_AGAINST_ constants to specify that exceeding this content starts exceeding content logging. The default value is EXCEEDING_CONTENT_AGAINST_NONE.

Parameters:
logExceedingContentAnalyze Enables logging of exceeding content and optionally of boxes.
logExceedingContentAgainst Enables logging of exceeding content either against the page edges, page content areas or containers.
See also:
EXCEEDING_CONTENT_ANALYZE_NONE, EXCEEDING_CONTENT_ANALYZE_CONTENT, EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_BOXES, EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_STATIC_BOXES, EXCEEDING_CONTENT_AGAINST_NONE, EXCEEDING_CONTENT_AGAINST_PARENT, EXCEEDING_CONTENT_AGAINST_PAGE_CONTENT, EXCEEDING_CONTENT_AGAINST_PAGE_BORDERS


void SetThrowLicenseExceptions (bool throwLicenseExceptions)
 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.
void SetDisableFontEmbedding (bool disableFontEmbedding)
 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.
void SetFontFallback (String[] fontFallback)
 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.
Parameters:
fontFallback an array of font family names.
.
void SetPixelsPerInch (int ppi)
 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.
void SetPixelsPerInchShrinkToFit (bool pixelsPerInchShrinkToFit)
 Whether the pixels per inch should be adapted automatically to avoid content exceeding pages.
void SetMergeMode (int mode)
 Sets the merge mode.

The following merge methods can be used:

  1. MERGE_MODE_APPEND
  2. MERGE_MODE_PREPEND
  3. MERGE_MODE_OVERLAY: overlay above the content of the generated PDF
  4. MERGE_MODE_OVERLAY_BELOW: overlay below the content of the generated PDF

The default value is MERGE_MODE_APPEND.

Parameters:
mode The merge Mode.
See also:
MERGE_MODE_APPEND, MERGE_MODE_PREPEND, MERGE_MODE_OVERLAY, MERGE_MODE_OVERLAY_BELOW


void SetMergeByteArray (byte[] val)
 This method sets a byte array containing an external PDF document which will be merged with the PDF document generated by the XML source.

SetMergeURL

See also:
SetMergeURLs, SetMergeByteArrays, SetMergeMode


void SetMergeByteArrays (byte[][] arrays)
 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. SetMergeByteArray
See also:
SetMergeURL, SetMergeURLs, SetMergeMode

.
void SetMergeURL (String val)
 This method sets a URL of an external PDF document which will be merged with the PDF document generated by the XML source.

SetMergeURLs

See also:
SetMergeByteArray, SetMergeByteArrays


void SetMergeURLs (String[] urls)
 This method sets an array of URLs of external PDF documents which will be merged with the PDF document generated by the XML source.
void SetMergeBeforePDF (bool val)
 Deprecated! As of PDFreactor 5.0, replaced by SetMergeMode. SetMergeMode.
void SetPostTransformationDocumentType (int documentType)
 Sets the document type after XSL-Transformations have been applied.

The 'DOCTYPE_' constants can be used to specify the document type. The default value specified is 'DOCTYPE_AUTODETECT'.

Parameters:
documentType The new document type setting.

void SetOutputFormat (int outputFormat, int outputWidth, int outputHeight)
 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.

Parameters:
outputFormat The output format. See OUTPUT_FORMAT_ constants
outputWidth The width 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.
outputHeight 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.
See also:
OUTPUT_FORMAT_PDF, OUTPUT_FORMAT_JPEG, OUTPUT_FORMAT_PNG, OUTPUT_FORMAT_PNG_TRANSPARENT, OUTPUT_FORMAT_BMP, OUTPUT_FORMAT_PNG_AI, OUTPUT_FORMAT_PNG_TRANSPARENT_AI, OUTPUT_FORMAT_TIFF_LZW, OUTPUT_FORMAT_TIFF_PACKBITS, OUTPUT_FORMAT_TIFF_UNCOMPRESSED, OUTPUT_FORMAT_TIFF_CCITT_1D, OUTPUT_FORMAT_TIFF_CCITT_GROUP_3, OUTPUT_FORMAT_TIFF_CCITT_GROUP_4


void SetOverlayRepeat (int 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 OVERLAY_REPEAT_NONE.

See also:
OVERLAY_REPEAT_NONE, OVERLAY_REPEAT_LAST_PAGE, OVERLAY_REPEAT_ALL_PAGES


void SetPageOrder (String order)
 Sets the page order of the direct result of the conversion.

Parameters:
order A comma-separated list of page numbers and ranges is intended as parameter. Alternatively, PAGE_ORDER_ constants can be used.
See also:
PAGE_ORDER_EVEN, PAGE_ORDER_ODD, PAGE_ORDER_BOOKLET, PAGE_ORDER_BOOKLET_RTL


void SetPagesPerSheetProperties (int cols, int rows, String sheetSize, String sheetMargin, String spacing, int direction)
 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.
Parameters:
cols The number of columns per sheet.
rows The number of rows per sheet.
sheetSize The sheet size as CSS size, e.g. A4, letter landscape, 15in 20in, 20cm 30cm.
sheetMargin The sheet margin as CSS margin, e.g. 1in, 1cm 1.5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.
spacing 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 The direction in which the pages are ordered on a sheet.
See also:
PAGES_PER_SHEET_DIRECTION_DOWN_LEFT, PAGES_PER_SHEET_DIRECTION_DOWN_RIGHT, PAGES_PER_SHEET_DIRECTION_LEFT_DOWN, PAGES_PER_SHEET_DIRECTION_LEFT_UP, PAGES_PER_SHEET_DIRECTION_RIGHT_DOWN, PAGES_PER_SHEET_DIRECTION_RIGHT_UP, PAGES_PER_SHEET_DIRECTION_UP_LEFT, PAGES_PER_SHEET_DIRECTION_UP_RIGHT

.
void SetBookletMode (String sheetSize, String sheetMargin, bool rtl)
 Convenience method to set pages-per-sheet properties and page order in one step to create a booklet.
Parameters:
sheetSize The size of the sheet as CSS value, e.g. A3, letter landscape, 15in 20in, 20cm 30cm.
sheetMargin The sheet margin as CSS margin, e.g. 1in, 1cm 1.5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.
rtl Whether or not the reading order of the booklet should be right-to-left .
.
void SetOwnerPassword (String val)
 Sets the owner password of the PDF document.

The default value is null

Parameters:
val The new owner password.
See also:
SetEncryption, SetUserPassword


void SetSubject (String val)
 Sets the value of the subject field of the PDF document.

Parameters:
val The subject of the document.

void SetTitle (String val)
 Sets the value of the title field of the PDF document.

Parameters:
val The title of the document.

void AddCustomDocumentProperty (String key, String value)
 Adds a custom property to the PDF document. An existing property of the same name will be replaced.

Parameters:
key The key of the custom document property.
value The value of the custom document property.

void AddAttachment (byte[] data, String url, String name, String description)
 
Parameters:
data The attachment.
url The url of the attachment.
name The name of the attachment.
description The description of the attachment.

void SetUserPassword (String val)
 Sets the user password of the PDF document.

The default value is null

Parameters:
val The new user password.
See also:
SetEncryption, SetOwnerPassword


void SetAuthenticationCredentials (String username, String password)
 Enables access to resources that are secured via Basic or Digest authentication.
Parameters:
username The user name for the secured realm.
password The password for the secured realm.
.
void SetXSLTMode (bool val)
 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

Parameters:
val The new XSLT mode.

void SetJavaScriptMode (int val)
 Sets the JavaScript Mode. By default JavaScript is disabled

Parameters:
val The JavaScript mode.
See also:
JAVASCRIPT_MODE_DISABLED, JAVASCRIPT_MODE_ENABLED, JAVASCRIPT_MODE_ENABLED_NO_LAYOUT, JAVASCRIPT_MODE_ENABLED_REAL_TIME, JAVASCRIPT_MODE_ENABLED_TIME_LAPSE


void SetHTTPSMode (int val)
 Sets the HTTPS mode. By default strict mode is set.

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

Parameters:
val The HTTPS mode.
See also:
HTTPS_MODE_STRICT, HTTPS_MODE_LENIENT


void SetOutputIntentFromURL (String identifier, String profileUrl)
 Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.

Parameters:
identifier the OutputConditionIdentifier
profileUrl the DestOutputProfile

void SetOutputIntentFromByteArray (String identifier, byte[] profileData)
 Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.

Parameters:
identifier the OutputConditionIdentifier
profileData the DestOutputProfile

void SetDefaultColorSpace (int colorspace)
 Sets whether to convert color key words into other color spaces.

Parameters:
colorspace The color space to which color key words are converted to
See also:
COLOR_SPACE_CMYK, COLOR_SPACE_RGB


void SetPrintDialogPrompt (bool val)
 Enables or disables a print dialog to be shown upon opening the generated PDF document by a PDF viewer.

The default value is false

Parameters:
val Use true to enable a print dialog to be shown upon document opening by a PDF viewer and false to disable the print dialog prompt.

void SetRequestHeader (String key, String value)
 Adds a request header to all outgoing HTTP connections. If the key already exists, the pair is overwritten.
Parameters:
key The key of the header.
value The value of the header.
.
void SetCookie (String key, String value)
 Adds a cookie to all outgoing HTTP connections. If the key already exists, the pair is overwritten.
Parameters:
key The key of the cookie.
value The value of the cookie.
.
void SetSignPDF (String keystoreURL, String keyAlias, String keystorePassword, String keystoreType, int signingMode)
 Sets a digital certificate to sign the newly created PDF.

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

Use the KEYSTORE_TYPE_ constants to specify the keystore type.

Use the SIGNING_MODE_ constants to specify the signing mode.

void SetProcessingPreferences (int processingPreferences)
 Preferences that influence the conversion process without changing the output

Parameters:
processingPreferences processing preferences flags

void SetViewerPreferences (int val)
 Sets the page layout and page mode preferences of the PDF.

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

Parameters:
val ORed ViewerPrefernces_ constants.
See also:
VIEWER_PREFERENCES_CENTER_WINDOW, VIEWER_PREFERENCES_DIRECTION_L2R, VIEWER_PREFERENCES_DIRECTION_R2L, VIEWER_PREFERENCES_DISPLAY_DOC_TITLE, VIEWER_PREFERENCES_DUPLEX_FLIP_LONG_EDGE, VIEWER_PREFERENCES_DUPLEX_FLIP_SHORT_EDGE, VIEWER_PREFERENCES_DUPLEX_SIMPLEX, VIEWER_PREFERENCES_FIT_WINDOW, VIEWER_PREFERENCES_HIDE_MENUBAR, VIEWER_PREFERENCES_HIDE_TOOLBAR, VIEWER_PREFERENCES_HIDE_WINDOW_UI, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_NONE, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OC, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_THUMBS, VIEWER_PREFERENCES_PAGE_LAYOUT_ONE_COLUMN, VIEWER_PREFERENCES_PAGE_LAYOUT_SINGLE_PAGE, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_LEFT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_RIGHT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_LEFT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_RIGHT, VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN, VIEWER_PREFERENCES_PAGE_MODE_USE_NONE, VIEWER_PREFERENCES_PAGE_MODE_USE_OC, VIEWER_PREFERENCES_PAGE_MODE_USE_OUTLINES, VIEWER_PREFERENCES_PAGE_MODE_USE_THUMBS, VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_FALSE, VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_TRUE, VIEWER_PREFERENCES_PRINTSCALING_APPDEFAULT, VIEWER_PREFERENCES_PRINTSCALING_NONE


void AddUserStyleSheet (String content, String media, String title, String URI)
 Adds a user style sheet to the document. There are two ways to specify the style sheet:
  1. Specifing the stylesheet only by an URI.
  2. Specifing the stylesheet by the content of the stylesheet 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.

Parameters:
content The content of the style sheet.
media The media type of the style sheet.
title The title of the style sheet.
URI The URI of the style sheet.
See also:
AddUserStyleSheet, RemoveAllUserStyleSheets


void AddXSLTStyleSheet (String content, String URI)
 Adds an XSL style sheet to the document. There are two ways to specify the style sheet:
  1. Specifing the stylesheet only by an URI.
  2. Specifing the stylesheet by the content of the stylesheet 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.

Parameters:
content The content of the style sheet.
URI The URI of the style sheet.
See also:
AddXSLTStyleSheet, RemoveAllXSLTStyleSheets


void AddUserScript (String content, String URI, Boolean beforeDocumentScripts)
 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.

Parameters:
content The content of the script.
URI The URI of the script.
beforeDocumentScripts Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.
See also:
AddXSLTStyleSheet, RemoveAllXSLTStyleSheets


void RemoveAllUserStyleSheets ()
 Removes all user style sheets.

See also:
AddUserStyleSheet, AddUserStyleSheet


void RemoveAllXSLTStyleSheets ()
 Removes all XSLT style sheets.

See also:
AddXSLTStyleSheet, AddXSLTStyleSheet


void RemoveAllUserScripts ()
 Removes all user scripts.

See also:
AddUserScript


void EnableDebugMode ()
 Enables debug mode, which adds additional information to the output.
void SetTimeout (int timeout)
 Indicates the time the PDFrector .NET wrapper waits for the PDFreactor service to complete the conversion process (in milliseconds). The default is 100000 milliseconds.

Setting this property to -1 indicates that the request does not time out.

Parameters:
timeout The time out, in milliseconds.


Public Attributes

const int CLEANUP_NONE = 0
 Indicates that no cleanup will be performed when loading a document. SetCleanupTool.
const int CLEANUP_JTIDY = 1
 Indicates that Tidy will be used to perform a cleanup when loading a document. SetCleanupTool.
const int CLEANUP_CYBERNEKO = 2
 Indicates that the CyberNeko HTML parser will be used to perform a cleanup when loading a document. SetCleanupTool.
const int CLEANUP_TAGSOUP = 3
 Indicates that Tagsoup will be used to perform a cleanup when loading a document. SetCleanupTool.
const int CLEANUP_DEFAULT = CLEANUP_CYBERNEKO
 The default cleanup setting. It is set to CLEANUP_CYBERNEKO. SetCleanupTool.
const int CONFORMANCE_PDF = 0
 PDF with no additional restrictions (default) SetConformance.
const int CONFORMANCE_PDFA1A = 1
 PDF/A-1a (ISO 19005-1 Level A) SetConformance.
const int CONFORMANCE_PDFA3A = 2
 PDF/A-3a (ISO 19005-3 Level A) SetConformance.
const int CONFORMANCE_PDFA = CONFORMANCE_PDFA1A
 Deprecated! As of PDFreactor 7.0, replaced by CONFORMANCE_PDFA1A.
const int CONFORMANCE_DEFAULT = CONFORMANCE_PDF
 The default value of the conformance property which is CONFORMANCE_PDF. SetConformance.
const int COLOR_SPACE_RGB = 0
 Color space RGB (default).
const int COLOR_SPACE_CMYK = 1
 Color space CMYK.
const int EXCEEDING_CONTENT_ANALYZE_NONE = 0
 Do not log exceeding content SetLogExceedingContent.
const int EXCEEDING_CONTENT_ANALYZE_CONTENT = 1
 Log exceeding content SetLogExceedingContent.
const int EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_STATIC_BOXES = 2
 Log exceeding content and boxes without absolute positioning SetLogExceedingContent.
const int EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_BOXES = 3
 Log exceeding content and all boxes SetLogExceedingContent.
const int EXCEEDING_CONTENT_AGAINST_NONE = 0
 Do not log exceeding content SetLogExceedingContent.
const int EXCEEDING_CONTENT_AGAINST_PAGE_BORDERS = 1
 Log content exceeding the edges of the page SetLogExceedingContent.
const int EXCEEDING_CONTENT_AGAINST_PAGE_CONTENT = 2
 Log content exceeding its page content area (overlaps the page margin) SetLogExceedingContent.
const int EXCEEDING_CONTENT_AGAINST_PARENT = 3
 Log content exceeding its container SetLogExceedingContent.
const String DOCUMENT_DEFAULT_LANGUAGE_DEFAULT = "en"
 The default document language. Indicates which is the default language for the document.
const int DOCTYPE_AUTODETECT = 0
 Indicates that the document type will be detected automatically. SetDocumentType.
const int DOCTYPE_XML = 1
 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. SetDocumentType.
const int DOCTYPE_XHTML = 2
 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. SetDocumentType.
const int DOCTYPE_HTML5 = 3
 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. SetDocumentType.
const int DOCTYPE_DEFAULT = DOCTYPE_AUTODETECT
 The default document type setting. It is set to DOCTYPE_AUTODETECT. SetDocumentType.
const int ENCRYPTION_NONE = 0
 Indicates that the document will not be encrypted. SetEncryption.
const int ENCRYPTION_40 = 1
 Indicates that the document will be encrypted using 40 bit encryption. SetEncryption.
const int ENCRYPTION_128 = 2
 Indicates that the document will be encrypted using 128 bit encryption. For normal purposes this value should be used. SetEncryption.
const int ENCRYPTION_DEFAULT = ENCRYPTION_NONE
 The default encryption setting. It is set to ENCRYPTION_NONE. SetEncryption.
const String KEYSTORE_TYPE_PKCS12 = "pkcs12"
 Keystore type "pkcs12" SetSignPDF.
const String KEYSTORE_TYPE_JKS = "jks"
 Keystore type "jks" SetSignPDF.
const int SIGNING_MODE_SELF_SIGNED = 1
 Signing mode for self-signed certificates SetSignPDF.
const int SIGNING_MODE_VERISIGN_SIGNED = 2
 Signing mode for VeriSign certificates SetSignPDF.
const int SIGNING_MODE_WINCER_SIGNED = 3
 Signing mode for Windows certificates SetSignPDF.
const int LOG_LEVEL_NONE = 4
 Indicates that no log events will be logged. SetLogLevel.
const int LOG_LEVEL_FATAL = 3
 Indicates that only fatal log events will be logged. SetLogLevel.
const int LOG_LEVEL_WARN = 2
 Indicates that warn and fatal log events will be logged. SetLogLevel.
const int LOG_LEVEL_INFO = 1
 Indicates that info, warn and fatal log events will be logged. SetLogLevel.
const int LOG_LEVEL_DEBUG = 0
 Indicates that debug, info, warn and fatal log events will be logged. SetLogLevel.
const int LOG_LEVEL_PERFORMANCE = -1
 Indicates that all log events will be logged. SetLogLevel.
const int LOG_LEVEL_DEFAULT = LOG_LEVEL_NONE
 The default log level setting. It is set to LOG_LEVEL_NONE. SetLogLevel.
const String PAGE_ORDER_REVERSE = "REVERSE"
 Page order mode to reverse the page order SetPageOrder.
const String PAGE_ORDER_ODD = "ODD"
 Page order mode to keep odd pages only SetPageOrder.
const String PAGE_ORDER_EVEN = "EVEN"
 Page order mode to keep even pages only SetPageOrder.
const String PAGE_ORDER_BOOKLET = "BOOKLET"
 Page order mode to arrange all pages in booklet order SetPageOrder.
const String PAGE_ORDER_BOOKLET_RTL = "BOOKLET_RTL"
 Page order mode to arrange all pages in right-to-left booklet order SetPageOrder.
const int PAGES_PER_SHEET_DIRECTION_RIGHT_DOWN = 0
 Arranges the pages on a sheet from left to right and top to bottom SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_LEFT_DOWN = 1
 Arranges the pages on a sheet from right to left and top to bottom SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_RIGHT_UP = 2
 Arranges the pages on a sheet from left to right and bottom to top SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_LEFT_UP = 3
 Arranges the pages on a sheet from right to left and bottom to top SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_DOWN_RIGHT = 4
 Arranges the pages on a sheet from top to bottom and left to right SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_DOWN_LEFT = 5
 Arranges the pages on a sheet from top to bottom and right to left SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_UP_RIGHT = 6
 Arranges the pages on a sheet from bottom to top and left to right SetPagesPerSheetProperties.
const int PAGES_PER_SHEET_DIRECTION_UP_LEFT = 7
 Arranges the pages on a sheet from bottom to top and right to left SetPagesPerSheetProperties.
const int MERGE_MODE_APPEND = 1
 Default merge mode: Append converted document to existing PDF SetMergeMode.
const int MERGE_MODE_PREPEND = 2
 Alternate merge mode: Prepend converted document to existing PDF SetMergeMode.
const int MERGE_MODE_OVERLAY = 3
 Alternate merge mode (overlay): Adding converted document above the existing PDF SetMergeMode.
const int MERGE_MODE_OVERLAY_BELOW = 4
 Alternate merge mode (overlay): Adding converted document below the existing PDF SetMergeMode.
const int OUTPUT_FORMAT_PDF = 0
 PDF output format SetOutputFormat.
const int OUTPUT_FORMAT_JPEG = 1
 JPEG output format SetOutputFormat.
const int OUTPUT_FORMAT_PNG = 2
 PNG output format SetOutputFormat.
const int OUTPUT_FORMAT_PNG_TRANSPARENT = 3
 Transparent PNG output format SetOutputFormat.
const int OUTPUT_FORMAT_BMP = 4
 BMP output format SetOutputFormat.
const int OUTPUT_FORMAT_GIF = 5
 GIF output format SetOutputFormat.
const int OUTPUT_FORMAT_PNG_AI = 6
 PNG output format (using Apache Imaging) SetOutputFormat.
const int OUTPUT_FORMAT_PNG_TRANSPARENT_AI = 7
 Transparent PNG output format (using Apache Imaging) SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_LZW = 8
 LZW compressed TIFF output format SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_PACKBITS = 9
 PackBits compressed TIFF output format SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_UNCOMPRESSED = 10
 Uncompressed TIFF output format SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_CCITT_1D = 11
 Monochrome CCITT 1D compressed TIFF output format SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_CCITT_GROUP_3 = 12
 Monochrome CCITT Group 3 compressed output format SetOutputFormat.
const int OUTPUT_FORMAT_TIFF_CCITT_GROUP_4 = 13
 Monochrome CCITT Group 4 compressed output format SetOutputFormat.
const int OVERLAY_REPEAT_NONE = 0
 No pages of the shorter document are repeated, leaving some pages of the longer document without overlay SetOverlayRepeat.
const int OVERLAY_REPEAT_LAST_PAGE = 1
 Last page of the shorter document is repeated, to overlay all pages of the longer document SetOverlayRepeat.
const int OVERLAY_REPEAT_ALL_PAGES = 2
 All pages of the shorter document are repeated, to overlay all pages of the longer document SetOverlayRepeat.
const int PROCESSING_PREFERENCES_SAVE_MEMORY_IMAGES = 1
 Processing preferences flag for the memory saving mode for images SetProcessingPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_SINGLE_PAGE = 1
 Display one page at a time. (default) SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_ONE_COLUMN = 2
 Display the pages in one column. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_LEFT = 4
 Display the pages in two columns, with odd numbered pages on the left. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_RIGHT = 8
 Display the pages in two columns, with odd numbered pages on the right. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_LEFT = 16
 Display two pages at a time, with odd numbered pages on the left. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_RIGHT = 32
 Display two pages at a time, with odd numbered pages on the right. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_USE_NONE = 64
 Show no panel on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_USE_OUTLINES = 128
 Show document outline panel on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_USE_THUMBS = 256
 Show thumbnail images panel on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN = 512
 Switch to fullscreen mode on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_USE_OC = 1024
 Show optional content group panel on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_PAGE_MODE_USE_ATTACHMENTS = 2048
 Show attachments panel on startup. SetViewerPreferences.
const int VIEWER_PREFERENCES_HIDE_TOOLBAR = 1 << 12
 Hide the viewer application's tool bars when the document is active. SetViewerPreferences.
const int VIEWER_PREFERENCES_HIDE_MENUBAR = 1 << 13
 Hide the viewer application's menu bar when the document is active. SetViewerPreferences.
const int VIEWER_PREFERENCES_HIDE_WINDOW_UI = 1 << 14
 Hide user interface elements in the document's window. SetViewerPreferences.
const int VIEWER_PREFERENCES_FIT_WINDOW = 1 << 15
 Resize the document's window to fit the size of the first displayed page SetViewerPreferences.
const int VIEWER_PREFERENCES_CENTER_WINDOW = 1 << 16
 Position the document's window in the center of the screen. SetViewerPreferences.
const int VIEWER_PREFERENCES_DISPLAY_DOC_TITLE = 1 << 17
 Display the document's title in the top bar. SetViewerPreferences.
const int VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_NONE = 1 << 18
 Show document outline panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.
const int VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES = 1 << 19
 Show thumbnail images panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.
const int VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_THUMBS = 1 << 20
 Show optional content group panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.
const int VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OC = 1 << 21
 Show attachments panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.
const int VIEWER_PREFERENCES_DIRECTION_L2R = 1 << 22
 Position pages in ascending order from left to right. SetViewerPreferences.
const int VIEWER_PREFERENCES_DIRECTION_R2L = 1 << 23
 Position pages in ascending order from right to left. SetViewerPreferences.
const int VIEWER_PREFERENCES_PRINTSCALING_NONE = 1 << 24
 Print dialog default setting: disabled scaling. SetViewerPreferences.
const int VIEWER_PREFERENCES_PRINTSCALING_APPDEFAULT = 1 << 25
 Print dialog default setting: set scaling to application default value. SetViewerPreferences.
const int VIEWER_PREFERENCES_DUPLEX_SIMPLEX = 1 << 26
 Print dialog default setting: simplex. SetViewerPreferences.
const int VIEWER_PREFERENCES_DUPLEX_FLIP_SHORT_EDGE = 1 << 27
 Print dialog default setting: duplex (short edge). SetViewerPreferences.
const int VIEWER_PREFERENCES_DUPLEX_FLIP_LONG_EDGE = 1 << 28
 Print dialog default setting: duplex (long edge). SetViewerPreferences.
const int VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_FALSE = 1 << 29
 Print dialog default setting: do not pick tray by PDF size. SetViewerPreferences.
const int VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_TRUE = 1 << 30
 Print dialog default setting: pick tray by PDF size. SetViewerPreferences.
const int JAVASCRIPT_MODE_DISABLED = 0
 Indicates that JavaScript is disabled. SetJavaScriptMode.
const int JAVASCRIPT_MODE_ENABLED = 1
 Indicates that JavaScript is enabled, without access to layout data. SetJavaScriptMode.
const int JAVASCRIPT_MODE_ENABLED_NO_LAYOUT = 2
 Indicates that JavaScript is enabled. SetJavaScriptMode.
const int JAVASCRIPT_MODE_ENABLED_REAL_TIME = 3
 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. SetJavaScriptMode.
const int JAVASCRIPT_MODE_ENABLED_TIME_LAPSE = 4
 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 JAVASCRIPT_MODE_ENABLED_REAL_TIME, but is significantly faster. Only Date.getTime() is affected by this. SetJavaScriptMode.
const int JAVASCRIPT_MODE_DEFAULT = JAVASCRIPT_MODE_DISABLED
 The default JavaScript mode. It is set to JAVASCRIPT_MODE_DISABLED. SetJavaScriptMode.
const int HTTPS_MODE_STRICT = 0
 Indicates strict HTTPS behavior. This matches the default behavior of Java. SetHTTPSMode.
const int HTTPS_MODE_LENIENT = 1
 Indicates lenient HTTPS behavior. This means that many certificate issues are ignored. SetHTTPSMode.
const int HTTPS_MODE_DEFAULT = HTTPS_MODE_STRICT
 The default HTTPS mode. It is set to HTTPS_MODE_STRICT. SetHTTPSMode.

Detailed Description

This class is the PDFreactor .NET API.

Constructor & Destructor Documentation

PDFreactor::PDFreactor (  )  [inline]

Constructs an instance of the PDFreactor.

PDFreactor::PDFreactor ( String  host  )  [inline]

Constructs an instance of the PDFreactor using the specified host.

Parameters:
host The host name.

PDFreactor::PDFreactor ( int  port  )  [inline]

Constructs an instance of the PDFreactor using the specified port.

Parameters:
port The port.

PDFreactor::PDFreactor ( String  host,
int  port 
) [inline]

Constructs an instance of the PDFreactor using the specified host and port.

Parameters:
host The host name.
port The port.

Member Function Documentation

byte [] PDFreactor::RenderDocumentFromURL ( String  URL  )  [inline]

Generates a PDF document from an XML document at a URL.

Parameters:
URL A URL pointing to the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromByteArray, RenderDocumentFromContent

byte [] PDFreactor::RenderDocumentFromContent ( String  content  )  [inline]

Generates a PDF document from an XML document inside a string.

Parameters:
content A string containing the content of the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromURL, RenderDocumentFromByteArray, RenderDocumentFromContentAsArray

byte [] PDFreactor::RenderDocumentFromByteArray ( byte[]  byteArray  )  [inline]

Generates a PDF document from an XML document inside a byte array.

Parameters:
byteArray An array containing the content of the XML document.
Returns:
The PDF document as PDF RAW data.
See also:
RenderDocumentFromURL, RenderDocumentFromContent, RenderDocumentFromByteArrayAsArray

byte [][] PDFreactor::RenderDocumentFromURLAsArray ( String  URL  )  [inline]

Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document at a URL.

Parameters:
url A URL pointing to the input document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromURL, RenderDocumentFromByteArrayAsArray, RenderDocumentFromContentAsArray

byte [][] PDFreactor::RenderDocumentFromContentAsArray ( String  content  )  [inline]

Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document inside a String.

Parameters:
content A String containing the content of the HTML or XML document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromContent, RenderDocumentFromByteArrayAsArray, RenderDocumentFromURLAsArray

byte [][] PDFreactor::RenderDocumentFromByteArrayAsArray ( byte[]  byteArray  )  [inline]

Generates an array of byte-arrays each containing an image representing one page of the document from an HTML or XML document inside a byte-array.

Parameters:
byteArray An array containing the content of the HTML or XML document.
Returns:
An array of byte-arrays each containing an image representing one page of the document.
See also:
RenderDocumentFromContentAsArray, RenderDocumentFromByteArray, RenderDocumentFromURLAsArray

String PDFreactor::GetError (  )  [inline]

Returns the error messages generated during rendering.

Returns:
The message string.

String PDFreactor::GetLog (  )  [inline]

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

Returns:
The log string.
See also:
SetLogLevel

ExceedingContent [] PDFreactor::GetExceedingContents (  )  [inline]

Provides information about content exceeding its page or parent. Depends on the mode set via setLogExceedingContent(int, int).

See also:
SetLogExceedingContent

int PDFreactor::GetNumberOfPages ( bool  pdf  )  [inline]

Returns the number of pages of the document after conversion.

The result returned by this method will only be correct if the document has already been laid out by one of the render methods:

  1. renderDocument(InputSource, OutputStream)
  2. renderDocumentFromByteArray(byte[])
  3. renderDocumentFromContent(String)
  4. renderDocumentFromURL(String)

Parameters:
pdf If true, return 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.
Returns:
the number of pages of the document

void PDFreactor::SetAddBookmarks ( bool  val  )  [inline]

Enables or disables bookmarks in the PDF document.

The default value is false

Parameters:
val Use true to enable bookmarks in the document and false to disable bookmarks.

void PDFreactor::SetAddLinks ( bool  val  )  [inline]

Enables or disables links in the PDF document.

The default value is false

Parameters:
val Use true to enable links in the document and false to disable links.

void PDFreactor::SetAddComments ( bool  val  )  [inline]

Enables or disables comments in the PDF document.

The default value is false

Parameters:
val Use true to enable comments in the document and false to disable comments.

void PDFreactor::SetAddPreviewImages ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable embedding of image previews per page in the document and false to disable embedding of image previews per page.

void PDFreactor::SetAddTags ( bool  val  )  [inline]

Enables or disables tagging of the PDF document.

The default value is false

Parameters:
val Use true to enable tagging of the document and false to disable tagging.

void PDFreactor::SetAddAttachments ( bool  val  )  [inline]

Enables or disables attachments specified in style sheets.

The default value is false.

Parameters:
val Whether to enable CSS based attachments.

void PDFreactor::SetAddOverprint ( bool  val  )  [inline]

Enables or disables overprinting.

The default value is false

Parameters:
val Whether to enable overprinting.

void PDFreactor::SetAllowAnnotations ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'annotations' in the document and false to disable 'annotations'.
See also:
SetEncryption

void PDFreactor::SetAllowAssembly ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'assembly' in the document and false to disable 'assembly'.
See also:
SetEncryption

void PDFreactor::SetAllowCopy ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'copy' in the document and false to disable 'copy'.
See also:
SetEncryption

void PDFreactor::SetAllowDegradedPrinting ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'degraded printing' in the document and false to disable 'degraded printing'.
See also:
SetEncryption

void PDFreactor::SetAllowFillIn ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'fill in' in the document and false to disable 'fill in'.
See also:
SetEncryption

void PDFreactor::SetAllowModifyContents ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'modify contents' in the document and false to disable 'modify contents'.
See also:
SetEncryption

void PDFreactor::SetAllowPrinting ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'printing' in the document and false to disable 'printing'.
See also:
SetEncryption

void PDFreactor::SetAllowScreenReaders ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable 'screen readers' in the document and false to disable 'screen readers'.
See also:
SetEncryption

void PDFreactor::SetAppendLog ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to add the log data to the document and false if the log data should not be added.

void PDFreactor::SetAuthor ( String  val  )  [inline]

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

Parameters:
val The author of the document.

void PDFreactor::SetBaseURL ( String  val  )  [inline]

Sets the base URL of the XML 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

Parameters:
val The base URL for the document.

void PDFreactor::SetCacheFonts ( bool  val  )  [inline]

Enables or disables caching of font information.

During the PDF creation PDFreactor requires information about fonts in the system The process to get this information takes a long time. Thus PDFreactor offers an option to cache the collected information about fonts. A font cache can be reused by PDFreactor on every PDF creation process but only if font registration is enabled. If font registration is disabled then the font cache will be ignored. (See setDisableFontRegistration(bool) for more information).

The default value is true

Parameters:
val The new value of the cache fonts setting.
See also:
SetDisableFontRegistration, SetFontCachePath, AddFontDirectory

void PDFreactor::SetCleanupTool ( int  val  )  [inline]

Sets the cleanup tool to use for documents with unparsable content. Use one of the following CLEANUP_ constants to specify the cleanup tool: CLEANUP_NONE CLEANUP_JTIDY CLEANUP_CYBERNEKO CLEANUP_TAGSOUP CLEANUP_DEFAULT

The default value specified by CLEANUP_DEFAULT is CLEANUP_CYBERNEKO.

HTML5 utilizes an internal cleanup.

Parameters:
val The new cleanup tool.

void PDFreactor::SetConformance ( int  val  )  [inline]

Sets the conformance of the PDF.

The CONFORMANCE_ constants can be used as value. The default value specified is CONFORMANCE_PDF.

Parameters:
val The conformance.

void PDFreactor::SetContinuousOutput ( int  width,
int  height 
) [inline]

Enables the conversion of the input document into one image.

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

void PDFreactor::SetCreator ( String  val  )  [inline]

Sets the value of creator field of the PDF document.

Parameters:
val The creator of the document.

void PDFreactor::SetDisableFontRegistration ( bool  val  )  [inline]

Enables or disables the font registration. If font registration is enabled and a valid font cache exists then this font cache will be used. If font registration is disabled then an existing font cache will be ignored and the font directories will be scanned for font information.

The default value is false

Parameters:
val The new value of the font registration setting.
See also:
SetCacheFonts, SetFontCachePath, AddFontDirectory

void PDFreactor::SetDisableSystemFonts ( bool  val  )  [inline]

Enables or disables system fonts. If system fonts are disabled, PDFreactor will neither scan for system fonts nor use the respective font cache.

The default value is false

Parameters:
val The new value of the font registration setting.
See also:
SetDisableFontRegistration, AddFontDirectory

void PDFreactor::SetDocumentType ( int  val  )  [inline]

Sets the document type. Use one of the following DOCTYPE_ constants to specify the document type: DOCTYPE_AUTODETECT DOCTYPE_XML DOCTYPE_XHTML DOCTYPE_HTML5 DOCTYPE_DEFAULT

The default value specified by DOCTYPE_DEFAULT is DOCTYPE_AUTODETECT.

Parameters:
val The new document type setting.

void PDFreactor::SetDocumentDefaultLanguage ( String  val  )  [inline]

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.

Parameters:
val The default ISO 639 language code used for documents.

void PDFreactor::SetEncoding ( String  val  )  [inline]

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

Parameters:
val The encoding of the document or null for autodetection.

void PDFreactor::SetEncryption ( int  val  )  [inline]

Sets the encryption. Use one of the following ENCRYPTION_ constants to specify the encryption: ENCRYPTION_NONE ENCRYPTION_40 ENCRYPTION_128 ENCRYPTION_DEFAULT

The default value specified by ENCRYPTION_DEFAULT is ENCRYPTION_NONE.

Parameters:
val The new encryption setting.
See also:
SetOwnerPassword, SetUserPassword, SetAllowAnnotations, SetAllowAssembly, SetAllowCopy, SetAllowDegradedPrinting, SetAllowFillIn, SetAllowModifyContents, SetAllowPrinting, SetAllowScreenReaders

void PDFreactor::SetFontCachePath ( String  val  )  [inline]

Sets the path of the font cache. This path will be used to read and write the font cache. If the font cache path is set to null then the "user.home" directory will be used

The default value is null

Parameters:
val location The path of the font cache.
See also:
SetDisableFontRegistration, SetCacheFonts, AddFontDirectory

void PDFreactor::AddFont ( String  source,
String  family,
Boolean  bold,
Boolean  italic 
) [inline]

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

Parameters:
source The URL to load the font from.
family The font family name the loaded font will be labeled as.
bold Whether the font will be labeled bold.
italic Whether the font will be labeled italic.

void PDFreactor::AddFontAlias ( String  source,
String  family,
Boolean  bold,
Boolean  italic 
) [inline]

Registers an alias font family for an existing font.

Parameters:
source The name of an existing font family.
family The alias name for that font.
bold Whether the alias will be labeled bold.
italic Whether the alias will be labeled italic.

void PDFreactor::SetFontDirectory ( String  val  )  [inline]

Deprecated! As of PDFreactor 6.0, replaced by AddFontDirectory.

AddFontDirectory

void PDFreactor::AddFontDirectory ( String  val  )  [inline]

Registers an additional font directory to load fonts from.

Parameters:
val The path of the font directory.

void PDFreactor::SetFullCompression ( bool  val  )  [inline]

Enables or disables full compression of the PDF document.

The default value is false

Parameters:
val Use true to enable full compression of the document and false to disable full compression.

void PDFreactor::SetKeywords ( String  val  )  [inline]

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

Parameters:
val The keywords of the document.

void PDFreactor::SetLicenseKey ( String  val  )  [inline]

Sets the license key by 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

Parameters:
val content The content of the license key as a string.

void PDFreactor::SetLogLevel ( int  val  )  [inline]

Sets the log level.

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

The default value is LOG_LEVEL_NONE.

Parameters:
val The new log level setting.
See also:
LOG_LEVEL_NONE, LOG_LEVEL_FATAL, LOG_LEVEL_WARN, LOG_LEVEL_INFO, LOG_LEVEL_DEBUG, LOG_LEVEL_PERFORMANCE, GetLog

void PDFreactor::SetLogExceedingContent ( int  logExceedingContentAnalyze,
int  logExceedingContentAgainst 
) [inline]

Whether to log content exceeding the page.

Use EXCEEDING_CONTENT_ANALYZE_ constants to specify which kind of content should be observed for exceeding content logging. The default value is EXCEEDING_CONTENT_ANALYZE_NONE.

Use EXCEEDING_CONTENT_AGAINST_ constants to specify that exceeding this content starts exceeding content logging. The default value is EXCEEDING_CONTENT_AGAINST_NONE.

Parameters:
logExceedingContentAnalyze Enables logging of exceeding content and optionally of boxes.
logExceedingContentAgainst Enables logging of exceeding content either against the page edges, page content areas or containers.
See also:
EXCEEDING_CONTENT_ANALYZE_NONE, EXCEEDING_CONTENT_ANALYZE_CONTENT, EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_BOXES, EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_STATIC_BOXES, EXCEEDING_CONTENT_AGAINST_NONE, EXCEEDING_CONTENT_AGAINST_PARENT, EXCEEDING_CONTENT_AGAINST_PAGE_CONTENT, EXCEEDING_CONTENT_AGAINST_PAGE_BORDERS

void PDFreactor::SetThrowLicenseExceptions ( bool  throwLicenseExceptions  )  [inline]

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.

void PDFreactor::SetDisableFontEmbedding ( bool  disableFontEmbedding  )  [inline]

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.

void PDFreactor::SetFontFallback ( String[]  fontFallback  )  [inline]

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.

Parameters:
fontFallback an array of font family names.
.

void PDFreactor::SetPixelsPerInch ( int  ppi  )  [inline]

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.

void PDFreactor::SetPixelsPerInchShrinkToFit ( bool  pixelsPerInchShrinkToFit  )  [inline]

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

void PDFreactor::SetMergeMode ( int  mode  )  [inline]

Sets the merge mode.

The following merge methods can be used:

  1. MERGE_MODE_APPEND
  2. MERGE_MODE_PREPEND
  3. MERGE_MODE_OVERLAY: overlay above the content of the generated PDF
  4. MERGE_MODE_OVERLAY_BELOW: overlay below the content of the generated PDF

The default value is MERGE_MODE_APPEND.

Parameters:
mode The merge Mode.
See also:
MERGE_MODE_APPEND, MERGE_MODE_PREPEND, MERGE_MODE_OVERLAY, MERGE_MODE_OVERLAY_BELOW

void PDFreactor::SetMergeByteArray ( byte[]  val  )  [inline]

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

SetMergeURL

See also:
SetMergeURLs, SetMergeByteArrays, SetMergeMode

void PDFreactor::SetMergeByteArrays ( byte  arrays[][]  )  [inline]

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

See also:
SetMergeURL, SetMergeURLs, SetMergeMode

.

void PDFreactor::SetMergeURL ( String  val  )  [inline]

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

SetMergeURLs

See also:
SetMergeByteArray, SetMergeByteArrays

void PDFreactor::SetMergeURLs ( String[]  urls  )  [inline]

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

void PDFreactor::SetMergeBeforePDF ( bool  val  )  [inline]

Deprecated! As of PDFreactor 5.0, replaced by SetMergeMode. SetMergeMode.

void PDFreactor::SetPostTransformationDocumentType ( int  documentType  )  [inline]

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

The 'DOCTYPE_' constants can be used to specify the document type. The default value specified is 'DOCTYPE_AUTODETECT'.

Parameters:
documentType The new document type setting.

See also:
DOCTYPE_AUTODETECT, DOCTYPE_XML, DOCTYPE_XHTML, DOCTYPE_HTML5

void PDFreactor::SetOverlayRepeat ( int  overlayRepeat  )  [inline]

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

See also:
OVERLAY_REPEAT_NONE, OVERLAY_REPEAT_LAST_PAGE, OVERLAY_REPEAT_ALL_PAGES

void PDFreactor::SetPageOrder ( String  order  )  [inline]

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

Parameters:
order A comma-separated list of page numbers and ranges is intended as parameter. Alternatively, PAGE_ORDER_ constants can be used.
See also:
PAGE_ORDER_EVEN, PAGE_ORDER_ODD, PAGE_ORDER_BOOKLET, PAGE_ORDER_BOOKLET_RTL

void PDFreactor::SetPagesPerSheetProperties ( int  cols,
int  rows,
String  sheetSize,
String  sheetMargin,
String  spacing,
int  direction 
) [inline]

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.

Parameters:
cols The number of columns per sheet.
rows The number of rows per sheet.
sheetSize The sheet size as CSS size, e.g. A4, letter landscape, 15in 20in, 20cm 30cm.
sheetMargin The sheet margin as CSS margin, e.g. 1in, 1cm 1.5cm, 10mm 20mm 10mm 30mm. null is interpreted as 0mm.
spacing 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 The direction in which the pages are ordered on a sheet.
See also:
PAGES_PER_SHEET_DIRECTION_DOWN_LEFT, PAGES_PER_SHEET_DIRECTION_DOWN_RIGHT, PAGES_PER_SHEET_DIRECTION_LEFT_DOWN, PAGES_PER_SHEET_DIRECTION_LEFT_UP, PAGES_PER_SHEET_DIRECTION_RIGHT_DOWN, PAGES_PER_SHEET_DIRECTION_RIGHT_UP, PAGES_PER_SHEET_DIRECTION_UP_LEFT, PAGES_PER_SHEET_DIRECTION_UP_RIGHT

.

void PDFreactor::SetBookletMode ( String  sheetSize,
String  sheetMargin,
bool  rtl 
) [inline]

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

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

void PDFreactor::SetOwnerPassword ( String  val  )  [inline]

Sets the owner password of the PDF document.

The default value is null

Parameters:
val The new owner password.
See also:
SetEncryption, SetUserPassword

void PDFreactor::SetSubject ( String  val  )  [inline]

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

Parameters:
val The subject of the document.

void PDFreactor::SetTitle ( String  val  )  [inline]

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

Parameters:
val The title of the document.

void PDFreactor::AddCustomDocumentProperty ( String  key,
String  value 
) [inline]

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

Parameters:
key The key of the custom document property.
value The value of the custom document property.

void PDFreactor::AddAttachment ( byte[]  data,
String  url,
String  name,
String  description 
) [inline]

Parameters:
data The attachment.
url The url of the attachment.
name The name of the attachment.
description The description of the attachment.

void PDFreactor::SetUserPassword ( String  val  )  [inline]

Sets the user password of the PDF document.

The default value is null

Parameters:
val The new user password.
See also:
SetEncryption, SetOwnerPassword

void PDFreactor::SetAuthenticationCredentials ( String  username,
String  password 
) [inline]

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

Parameters:
username The user name for the secured realm.
password The password for the secured realm.
.

void PDFreactor::SetXSLTMode ( bool  val  )  [inline]

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

Parameters:
val The new XSLT mode.

void PDFreactor::SetJavaScriptMode ( int  val  )  [inline]

Sets the JavaScript Mode. By default JavaScript is disabled

Parameters:
val The JavaScript mode.
See also:
JAVASCRIPT_MODE_DISABLED, JAVASCRIPT_MODE_ENABLED, JAVASCRIPT_MODE_ENABLED_NO_LAYOUT, JAVASCRIPT_MODE_ENABLED_REAL_TIME, JAVASCRIPT_MODE_ENABLED_TIME_LAPSE

void PDFreactor::SetHTTPSMode ( int  val  )  [inline]

Sets the HTTPS mode. By default strict mode is set.

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

Parameters:
val The HTTPS mode.
See also:
HTTPS_MODE_STRICT, HTTPS_MODE_LENIENT

void PDFreactor::SetOutputIntentFromURL ( String  identifier,
String  profileUrl 
) [inline]

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

Parameters:
identifier the OutputConditionIdentifier
profileUrl the DestOutputProfile

void PDFreactor::SetOutputIntentFromByteArray ( String  identifier,
byte[]  profileData 
) [inline]

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

Parameters:
identifier the OutputConditionIdentifier
profileData the DestOutputProfile

void PDFreactor::SetDefaultColorSpace ( int  colorspace  )  [inline]

Sets whether to convert color key words into other color spaces.

Parameters:
colorspace The color space to which color key words are converted to
See also:
COLOR_SPACE_CMYK, COLOR_SPACE_RGB

void PDFreactor::SetPrintDialogPrompt ( bool  val  )  [inline]

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

The default value is false

Parameters:
val Use true to enable a print dialog to be shown upon document opening by a PDF viewer and false to disable the print dialog prompt.

void PDFreactor::SetRequestHeader ( String  key,
String  value 
) [inline]

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

Parameters:
key The key of the header.
value The value of the header.
.

void PDFreactor::SetCookie ( String  key,
String  value 
) [inline]

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

Parameters:
key The key of the cookie.
value The value of the cookie.
.

void PDFreactor::SetSignPDF ( String  keystoreURL,
String  keyAlias,
String  keystorePassword,
String  keystoreType,
int  signingMode 
) [inline]

Sets a digital certificate to sign the newly created PDF.

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

Use the KEYSTORE_TYPE_ constants to specify the keystore type.

Use the SIGNING_MODE_ constants to specify the signing mode.

Parameters:
keystoreURL The URL to the keystore file.
keyAlias The alias of the certificate included in the keystore to be used to sign the PDF.
keystorePassword The password of the keystore.
keystoreType The format of the keystore, i.e. pkcs12 or jks.
signingMode The mode that is used to sign the PDF, i.e. self-signed, Windows certificate or VeriSign.
See also:
KEYSTORE_TYPE_JKS, KEYSTORE_TYPE_PKCS12, SIGNING_MODE_SELF_SIGNED, SIGNING_MODE_VERISIGN_SIGNED, SIGNING_MODE_WINCER_SIGNED

void PDFreactor::SetProcessingPreferences ( int  processingPreferences  )  [inline]

Preferences that influence the conversion process without changing the output

Parameters:
processingPreferences processing preferences flags

void PDFreactor::SetViewerPreferences ( int  val  )  [inline]

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

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

Parameters:
val ORed ViewerPrefernces_ constants.
See also:
VIEWER_PREFERENCES_CENTER_WINDOW, VIEWER_PREFERENCES_DIRECTION_L2R, VIEWER_PREFERENCES_DIRECTION_R2L, VIEWER_PREFERENCES_DISPLAY_DOC_TITLE, VIEWER_PREFERENCES_DUPLEX_FLIP_LONG_EDGE, VIEWER_PREFERENCES_DUPLEX_FLIP_SHORT_EDGE, VIEWER_PREFERENCES_DUPLEX_SIMPLEX, VIEWER_PREFERENCES_FIT_WINDOW, VIEWER_PREFERENCES_HIDE_MENUBAR, VIEWER_PREFERENCES_HIDE_TOOLBAR, VIEWER_PREFERENCES_HIDE_WINDOW_UI, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_NONE, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OC, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES, VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_THUMBS, VIEWER_PREFERENCES_PAGE_LAYOUT_ONE_COLUMN, VIEWER_PREFERENCES_PAGE_LAYOUT_SINGLE_PAGE, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_LEFT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_RIGHT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_LEFT, VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_RIGHT, VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN, VIEWER_PREFERENCES_PAGE_MODE_USE_NONE, VIEWER_PREFERENCES_PAGE_MODE_USE_OC, VIEWER_PREFERENCES_PAGE_MODE_USE_OUTLINES, VIEWER_PREFERENCES_PAGE_MODE_USE_THUMBS, VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_FALSE, VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_TRUE, VIEWER_PREFERENCES_PRINTSCALING_APPDEFAULT, VIEWER_PREFERENCES_PRINTSCALING_NONE

void PDFreactor::AddUserStyleSheet ( String  content,
String  media,
String  title,
String  URI 
) [inline]

Adds a user style sheet to the document. There are two ways to specify the style sheet:

  1. Specifing the stylesheet only by an URI.
  2. Specifing the stylesheet by the content of the stylesheet 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.

Parameters:
content The content of the style sheet.
media The media type of the style sheet.
title The title of the style sheet.
URI The URI of the style sheet.
See also:
AddUserStyleSheet, RemoveAllUserStyleSheets

void PDFreactor::AddXSLTStyleSheet ( String  content,
String  URI 
) [inline]

Adds an XSL style sheet to the document. There are two ways to specify the style sheet:

  1. Specifing the stylesheet only by an URI.
  2. Specifing the stylesheet by the content of the stylesheet 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.

Parameters:
content The content of the style sheet.
URI The URI of the style sheet.
See also:
AddXSLTStyleSheet, RemoveAllXSLTStyleSheets

void PDFreactor::AddUserScript ( String  content,
String  URI,
Boolean  beforeDocumentScripts 
) [inline]

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.

Parameters:
content The content of the script.
URI The URI of the script.
beforeDocumentScripts Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.
See also:
AddXSLTStyleSheet, RemoveAllXSLTStyleSheets

void PDFreactor::RemoveAllUserStyleSheets (  )  [inline]

Removes all user style sheets.

See also:
AddUserStyleSheet, AddUserStyleSheet

void PDFreactor::RemoveAllXSLTStyleSheets (  )  [inline]

Removes all XSLT style sheets.

See also:
AddXSLTStyleSheet, AddXSLTStyleSheet

void PDFreactor::RemoveAllUserScripts (  )  [inline]

Removes all user scripts.

See also:
AddUserScript

void PDFreactor::EnableDebugMode (  )  [inline]

Enables debug mode, which adds additional information to the output.

void PDFreactor::SetTimeout ( int  timeout  )  [inline]

Indicates the time the PDFrector .NET wrapper waits for the PDFreactor service to complete the conversion process (in milliseconds). The default is 100000 milliseconds.

Setting this property to -1 indicates that the request does not time out.

Parameters:
timeout The time out, in milliseconds.

Member Data Documentation

const int PDFreactor::CLEANUP_NONE = 0

Indicates that no cleanup will be performed when loading a document. SetCleanupTool.

const int PDFreactor::CLEANUP_JTIDY = 1

Indicates that Tidy will be used to perform a cleanup when loading a document. SetCleanupTool.

const int PDFreactor::CLEANUP_CYBERNEKO = 2

Indicates that the CyberNeko HTML parser will be used to perform a cleanup when loading a document. SetCleanupTool.

const int PDFreactor::CLEANUP_TAGSOUP = 3

Indicates that Tagsoup will be used to perform a cleanup when loading a document. SetCleanupTool.

const int PDFreactor::CLEANUP_DEFAULT = CLEANUP_CYBERNEKO

The default cleanup setting. It is set to CLEANUP_CYBERNEKO. SetCleanupTool.

const int PDFreactor::CONFORMANCE_PDF = 0

PDF with no additional restrictions (default) SetConformance.

const int PDFreactor::CONFORMANCE_PDFA1A = 1

PDF/A-1a (ISO 19005-1 Level A) SetConformance.

const int PDFreactor::CONFORMANCE_PDFA3A = 2

PDF/A-3a (ISO 19005-3 Level A) SetConformance.

const int PDFreactor::CONFORMANCE_PDFA = CONFORMANCE_PDFA1A

Deprecated! As of PDFreactor 7.0, replaced by CONFORMANCE_PDFA1A.

CONFORMANCE_PDFA1A

const int PDFreactor::CONFORMANCE_DEFAULT = CONFORMANCE_PDF

The default value of the conformance property which is CONFORMANCE_PDF. SetConformance.

const int PDFreactor::COLOR_SPACE_RGB = 0

Color space RGB (default).

const int PDFreactor::COLOR_SPACE_CMYK = 1

Color space CMYK.

const int PDFreactor::EXCEEDING_CONTENT_ANALYZE_NONE = 0

Do not log exceeding content SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_ANALYZE_CONTENT = 1

Log exceeding content SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_STATIC_BOXES = 2

Log exceeding content and boxes without absolute positioning SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_ANALYZE_CONTENT_AND_BOXES = 3

Log exceeding content and all boxes SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_AGAINST_NONE = 0

Do not log exceeding content SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_AGAINST_PAGE_BORDERS = 1

Log content exceeding the edges of the page SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_AGAINST_PAGE_CONTENT = 2

Log content exceeding its page content area (overlaps the page margin) SetLogExceedingContent.

const int PDFreactor::EXCEEDING_CONTENT_AGAINST_PARENT = 3

Log content exceeding its container SetLogExceedingContent.

const String PDFreactor::DOCUMENT_DEFAULT_LANGUAGE_DEFAULT = "en"

The default document language. Indicates which is the default language for the document.

const int PDFreactor::DOCTYPE_AUTODETECT = 0

Indicates that the document type will be detected automatically. SetDocumentType.

const int PDFreactor::DOCTYPE_XML = 1

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

const int PDFreactor::DOCTYPE_XHTML = 2

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

const int PDFreactor::DOCTYPE_HTML5 = 3

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

const int PDFreactor::DOCTYPE_DEFAULT = DOCTYPE_AUTODETECT

The default document type setting. It is set to DOCTYPE_AUTODETECT. SetDocumentType.

const int PDFreactor::ENCRYPTION_NONE = 0

Indicates that the document will not be encrypted. SetEncryption.

const int PDFreactor::ENCRYPTION_40 = 1

Indicates that the document will be encrypted using 40 bit encryption. SetEncryption.

const int PDFreactor::ENCRYPTION_128 = 2

Indicates that the document will be encrypted using 128 bit encryption. For normal purposes this value should be used. SetEncryption.

const int PDFreactor::ENCRYPTION_DEFAULT = ENCRYPTION_NONE

The default encryption setting. It is set to ENCRYPTION_NONE. SetEncryption.

const String PDFreactor::KEYSTORE_TYPE_PKCS12 = "pkcs12"

Keystore type "pkcs12" SetSignPDF.

const String PDFreactor::KEYSTORE_TYPE_JKS = "jks"

Keystore type "jks" SetSignPDF.

const int PDFreactor::SIGNING_MODE_SELF_SIGNED = 1

Signing mode for self-signed certificates SetSignPDF.

const int PDFreactor::SIGNING_MODE_VERISIGN_SIGNED = 2

Signing mode for VeriSign certificates SetSignPDF.

const int PDFreactor::SIGNING_MODE_WINCER_SIGNED = 3

Signing mode for Windows certificates SetSignPDF.

const int PDFreactor::LOG_LEVEL_NONE = 4

Indicates that no log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_FATAL = 3

Indicates that only fatal log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_WARN = 2

Indicates that warn and fatal log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_INFO = 1

Indicates that info, warn and fatal log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_DEBUG = 0

Indicates that debug, info, warn and fatal log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_PERFORMANCE = -1

Indicates that all log events will be logged. SetLogLevel.

const int PDFreactor::LOG_LEVEL_DEFAULT = LOG_LEVEL_NONE

The default log level setting. It is set to LOG_LEVEL_NONE. SetLogLevel.

const String PDFreactor::PAGE_ORDER_REVERSE = "REVERSE"

Page order mode to reverse the page order SetPageOrder.

const String PDFreactor::PAGE_ORDER_ODD = "ODD"

Page order mode to keep odd pages only SetPageOrder.

const String PDFreactor::PAGE_ORDER_EVEN = "EVEN"

Page order mode to keep even pages only SetPageOrder.

const String PDFreactor::PAGE_ORDER_BOOKLET = "BOOKLET"

Page order mode to arrange all pages in booklet order SetPageOrder.

const String PDFreactor::PAGE_ORDER_BOOKLET_RTL = "BOOKLET_RTL"

Page order mode to arrange all pages in right-to-left booklet order SetPageOrder.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_RIGHT_DOWN = 0

Arranges the pages on a sheet from left to right and top to bottom SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_LEFT_DOWN = 1

Arranges the pages on a sheet from right to left and top to bottom SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_RIGHT_UP = 2

Arranges the pages on a sheet from left to right and bottom to top SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_LEFT_UP = 3

Arranges the pages on a sheet from right to left and bottom to top SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_DOWN_RIGHT = 4

Arranges the pages on a sheet from top to bottom and left to right SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_DOWN_LEFT = 5

Arranges the pages on a sheet from top to bottom and right to left SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_UP_RIGHT = 6

Arranges the pages on a sheet from bottom to top and left to right SetPagesPerSheetProperties.

const int PDFreactor::PAGES_PER_SHEET_DIRECTION_UP_LEFT = 7

Arranges the pages on a sheet from bottom to top and right to left SetPagesPerSheetProperties.

const int PDFreactor::MERGE_MODE_APPEND = 1

Default merge mode: Append converted document to existing PDF SetMergeMode.

const int PDFreactor::MERGE_MODE_PREPEND = 2

Alternate merge mode: Prepend converted document to existing PDF SetMergeMode.

const int PDFreactor::MERGE_MODE_OVERLAY = 3

Alternate merge mode (overlay): Adding converted document above the existing PDF SetMergeMode.

const int PDFreactor::MERGE_MODE_OVERLAY_BELOW = 4

Alternate merge mode (overlay): Adding converted document below the existing PDF SetMergeMode.

const int PDFreactor::OUTPUT_FORMAT_PDF = 0

PDF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_JPEG = 1

JPEG output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_PNG = 2

PNG output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_PNG_TRANSPARENT = 3

Transparent PNG output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_BMP = 4

BMP output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_GIF = 5

GIF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_PNG_AI = 6

PNG output format (using Apache Imaging) SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_PNG_TRANSPARENT_AI = 7

Transparent PNG output format (using Apache Imaging) SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_LZW = 8

LZW compressed TIFF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_PACKBITS = 9

PackBits compressed TIFF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_UNCOMPRESSED = 10

Uncompressed TIFF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_CCITT_1D = 11

Monochrome CCITT 1D compressed TIFF output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_CCITT_GROUP_3 = 12

Monochrome CCITT Group 3 compressed output format SetOutputFormat.

const int PDFreactor::OUTPUT_FORMAT_TIFF_CCITT_GROUP_4 = 13

Monochrome CCITT Group 4 compressed output format SetOutputFormat.

const int PDFreactor::OVERLAY_REPEAT_NONE = 0

No pages of the shorter document are repeated, leaving some pages of the longer document without overlay SetOverlayRepeat.

const int PDFreactor::OVERLAY_REPEAT_LAST_PAGE = 1

Last page of the shorter document is repeated, to overlay all pages of the longer document SetOverlayRepeat.

const int PDFreactor::OVERLAY_REPEAT_ALL_PAGES = 2

All pages of the shorter document are repeated, to overlay all pages of the longer document SetOverlayRepeat.

const int PDFreactor::PROCESSING_PREFERENCES_SAVE_MEMORY_IMAGES = 1

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

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_SINGLE_PAGE = 1

Display one page at a time. (default) SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_ONE_COLUMN = 2

Display the pages in one column. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_LEFT = 4

Display the pages in two columns, with odd numbered pages on the left. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_COLUMN_RIGHT = 8

Display the pages in two columns, with odd numbered pages on the right. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_LEFT = 16

Display two pages at a time, with odd numbered pages on the left. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_LAYOUT_TWO_PAGE_RIGHT = 32

Display two pages at a time, with odd numbered pages on the right. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_USE_NONE = 64

Show no panel on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_USE_OUTLINES = 128

Show document outline panel on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_USE_THUMBS = 256

Show thumbnail images panel on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN = 512

Switch to fullscreen mode on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_USE_OC = 1024

Show optional content group panel on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PAGE_MODE_USE_ATTACHMENTS = 2048

Show attachments panel on startup. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_HIDE_TOOLBAR = 1 << 12

Hide the viewer application's tool bars when the document is active. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_HIDE_MENUBAR = 1 << 13

Hide the viewer application's menu bar when the document is active. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_HIDE_WINDOW_UI = 1 << 14

Hide user interface elements in the document's window. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_FIT_WINDOW = 1 << 15

Resize the document's window to fit the size of the first displayed page SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_CENTER_WINDOW = 1 << 16

Position the document's window in the center of the screen. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DISPLAY_DOC_TITLE = 1 << 17

Display the document's title in the top bar. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_NONE = 1 << 18

Show document outline panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES = 1 << 19

Show thumbnail images panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_THUMBS = 1 << 20

Show optional content group panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_NON_FULLSCREEN_PAGE_MODE_USE_OC = 1 << 21

Show attachments panel on exiting full-screen mode. Has to be combined with VIEWER_PREFERENCES_PAGE_MODE_FULLSCREEN. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DIRECTION_L2R = 1 << 22

Position pages in ascending order from left to right. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DIRECTION_R2L = 1 << 23

Position pages in ascending order from right to left. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PRINTSCALING_NONE = 1 << 24

Print dialog default setting: disabled scaling. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PRINTSCALING_APPDEFAULT = 1 << 25

Print dialog default setting: set scaling to application default value. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DUPLEX_SIMPLEX = 1 << 26

Print dialog default setting: simplex. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DUPLEX_FLIP_SHORT_EDGE = 1 << 27

Print dialog default setting: duplex (short edge). SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_DUPLEX_FLIP_LONG_EDGE = 1 << 28

Print dialog default setting: duplex (long edge). SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_FALSE = 1 << 29

Print dialog default setting: do not pick tray by PDF size. SetViewerPreferences.

const int PDFreactor::VIEWER_PREFERENCES_PICKTRAYBYPDFSIZE_TRUE = 1 << 30

Print dialog default setting: pick tray by PDF size. SetViewerPreferences.

const int PDFreactor::JAVASCRIPT_MODE_DISABLED = 0

Indicates that JavaScript is disabled. SetJavaScriptMode.

const int PDFreactor::JAVASCRIPT_MODE_ENABLED = 1

Indicates that JavaScript is enabled, without access to layout data. SetJavaScriptMode.

const int PDFreactor::JAVASCRIPT_MODE_ENABLED_NO_LAYOUT = 2

Indicates that JavaScript is enabled. SetJavaScriptMode.

const int PDFreactor::JAVASCRIPT_MODE_ENABLED_REAL_TIME = 3

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

const int PDFreactor::JAVASCRIPT_MODE_ENABLED_TIME_LAPSE = 4

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 JAVASCRIPT_MODE_ENABLED_REAL_TIME, but is significantly faster. Only Date.getTime() is affected by this. SetJavaScriptMode.

const int PDFreactor::JAVASCRIPT_MODE_DEFAULT = JAVASCRIPT_MODE_DISABLED

The default JavaScript mode. It is set to JAVASCRIPT_MODE_DISABLED. SetJavaScriptMode.

const int PDFreactor::HTTPS_MODE_STRICT = 0

Indicates strict HTTPS behavior. This matches the default behavior of Java. SetHTTPSMode.

const int PDFreactor::HTTPS_MODE_LENIENT = 1

Indicates lenient HTTPS behavior. This means that many certificate issues are ignored. SetHTTPSMode.

const int PDFreactor::HTTPS_MODE_DEFAULT = HTTPS_MODE_STRICT

The default HTTPS mode. It is set to HTTPS_MODE_STRICT. SetHTTPSMode.