PDFTron WebViewer

Class: XODOutputOptions

PDFNet.Convert. XODOutputOptions

new XODOutputOptions()

An object containing options for ToXod functions

Extends

Methods

Sets whether links should be generated from urls found in the document. Default is false.
Parameters:
Name Type Description
generate boolean if true links will be generated from urls
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setAnnotationOutput(annot_output)

Choose how to output annotations. Default is e_internal_xfdf.
Parameters:
Name Type Description
annot_output number 
PDFNet.PDFNet.Convert.AnnotationOutputFlag = {
	e_internal_xfdf : 0
	e_external_xfdf : 1
	e_flatten : 2
}
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setDPI(dpi)

The output resolution, from 1 to 1000, in Dots Per Inch (DPI) at which to render elements which cannot be directly converted. Default is 140.
Parameters:
Name Type Description
dpi number the resolution in Dots Per Inch
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setElementLimit(element_limit)

If rendering is permitted, sets the maximum number of page elements before that page will be rendered. Default is 2000000000 which will never cause pages to be completely rendered in this manner.
Parameters:
Name Type Description
element_limit number the maximum number of elements before a given page will be rendered
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setEncryptPassword(pass)

Encrypt XOD parts with AES 128 encryption using the supplied password. This option is not available when using setExternalParts(true)
Parameters:
Name Type Description
pass string the encryption password
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setExternalParts(generate)

Output XOD as a collection of loose files rather than a zip archive. This option should be used when using the external part retriever in Webviewer. Default is false.
Parameters:
Name Type Description
generate boolean if true XOD is output as a collection of loose files
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setFlattenContent(flatten)

Flatten images and paths into a single background image overlaid with vector text. This option can be used to improve speed on devices with little processing power such as iPads. Default is e_high_quality.
Parameters:
Name Type Description
flatten number 
PDFNet.Convert.FlattenFlag = {
	e_off : 0
	e_simple : 1
	e_fast : 2
	e_high_quality : 3
}
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setFlattenThreshold(threshold)

Used to control how precise or relaxed text flattening is. When some text is preserved (not flattened to image) the visual appearance of the document may be altered.
Parameters:
Name Type Description
threshold number 
PDFNet.PDFNet.Convert.FlattenThresholdFlag = {
	e_very_strict : 0
	e_strict : 1
	e_default : 2
	e_keep_most : 3
	e_keep_all : 4
}
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setJPGQuality(quality)

Specifies the compression quality to use when generating JPEG images.
Parameters:
Name Type Description
quality number the JPEG compression quality, from 0(highest compression) to 100(best quality).
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setMaximumImagePixels(max_pixels)

Specifies the maximum image slice size in pixels. Default is 2000000.
Parameters:
Name Type Description
max_pixels number the maximum number of pixels an image can have
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setOpacityMaskWorkaround(opacity_render)

If rendering is permitted, sets whether pages containing opacity masks should be rendered. This option is used as a workaround to a bug in Silverlight where opacity masks are transformed incorrectly. Default is false.
Parameters:
Name Type Description
opacity_render boolean if true pages with opacity masks will be rendered
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setOutputThumbnails(include_thumbs)

Sets whether per page thumbnails should be included in the file. Default is true.
Parameters:
Name Type Description
include_thumbs boolean if true thumbnails will be included
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setOutputThumbnails(include_thumbs)

Sets whether per page thumbnails should be included in the file. Default is true.
Parameters:
Name Type Description
include_thumbs boolean if true thumbnails will be included
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setOverprint(mode)

Enable or disable support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). Default is e_op_pdfx_on.
Parameters:
Name Type Description
mode number 
PDFNet.Convert.OverprintPreviewMode = {
	e_op_off : 0
	e_op_on : 1
	e_op_pdfx_on : 2
}
e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only.
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setPreferJPG(prefer_jpg)

Where possible output JPG files rather than PNG. This will apply to both thumbnails and document images. Default is true.
Parameters:
Name Type Description
prefer_jpg boolean if true JPG images will be used whenever possible.
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setPrintMode(print_mode)

Sets whether ToXps should be run in print mode. Default is false.
Parameters:
Name Type Description
print_mode boolean if true print mode is enabled
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setRenderPages(render)

Sets whether rendering of pages should be permitted when necessary to guarantee output. Default is true.
Parameters:
Name Type Description
render boolean if false rendering is not permitted under any circumstance
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setSilverlightTextWorkaround(workaround)

Outputs rotated text as paths. This option is used as a workaround to a bug in Silverlight where pages with rotated text could cause the plugin to crash. Default is false.
Parameters:
Name Type Description
workaround boolean if true rotated text will be changed to paths
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

setThickenLines(thicken)

Sets whether thin lines should be thickened. Default is true for XPS and false for XOD.
Parameters:
Name Type Description
thicken boolean if true then thin lines will be thickened
Inherited From:
Returns:
this object, for call chaining
Type
PDFNet.Convert.XPSOutputCommonOptions

setThumbnailSize(regular_size [, large_size])

The width and height of a square in which thumbnails will be contained. Default is 400 for normal pages and 1500 for large pages.
Parameters:
Name Type Argument Default Description
regular_size number the maximum dimension that thumbnails for regular size pages will have.
large_size number <optional>
 regular_size the maximum dimension that thumbnails for large pages will have.
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions

useSilverlightFlashCompatible(compatible)

The latest XOD format is only partially supported in Silverlight and Flash due to various optimizations in the text format and the addition of blend mode support. This option forces the converter to use an older version of XOD that is Silverlight/Flash compatible but does not have these improvements. By default the latest XOD format is generated.
Parameters:
Name Type Description
compatible boolean if true will use the older XOD format which is not compatible with Silverlight/Flash
Returns:
this object, for call chaining
Type
PDFNet.Convert.XODOutputOptions