new XODOutputOptions()
An object containing options for ToXod functions
Extends
- PDFNet.Convert.XPSOutputCommonOptions
Methods
-
setAnnotationOutput(annot_output)
-
Choose how to output annotations. Default is e_internal_xfdf.
Parameters:
Name Type Description annot_outputnumber PDFNet.PDFNet.Convert.AnnotationOutputFlag = { e_internal_xfdf : 0 e_external_xfdf : 1 e_flatten : 2 }Returns:
this object, for call chaining -
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_limitnumber the maximum number of elements before a given page will be rendered Returns:
this object, for call chaining -
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 passstring the encryption password Returns:
this object, for call chaining -
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 generateboolean if true XOD is output as a collection of loose files Returns:
this object, for call chaining -
setExtractUsingZorder(use_zorder)
-
Sets whether text extraction uses Z-order as reading order. Default is false.
Parameters:
Name Type Description use_zorderboolean if true text extraction uses Z-order as reading order. Returns:
this object, for call chaining -
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 flattennumber PDFNet.Convert.FlattenFlag = { e_off : 0 e_simple : 1 e_fast : 2 e_high_quality : 3 }Returns:
this object, for call chaining -
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 thresholdnumber 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 -
setJPGQuality(quality)
-
Specifies the compression quality to use when generating JPEG images.
Parameters:
Name Type Description qualitynumber the JPEG compression quality, from 0(highest compression) to 100(best quality). Returns:
this object, for call chaining -
setMaximumImagePixels(max_pixels)
-
Specifies the maximum image slice size in pixels. Default is 2000000. Note: This setting now will no longer reduce the total number of image pixels. Instead a lower value will just produce more slices and vice versa. Note: Since image compression works better with more pixels a larger max pixels should generally create smaller files.
Parameters:
Name Type Description max_pixelsnumber the maximum number of pixels an image can have Returns:
this object, for call chaining -
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_renderboolean if true pages with opacity masks will be rendered Returns:
this object, for call chaining -
setOutputThumbnails(include_thumbs)
-
Sets whether per page thumbnails should be included in the file. Default is true.
Parameters:
Name Type Description include_thumbsboolean if true thumbnails will be included Returns:
this object, for call chaining -
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_jpgboolean if true JPG images will be used whenever possible. Returns:
this object, for call chaining -
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 workaroundboolean if true rotated text will be changed to paths Returns:
this object, for call chaining -
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. Note: A large page is a page larger than twice the area of the standard page size (8.5 X 11).
Parameters:
Name Type Argument Default Description regular_sizenumber the maximum dimension that thumbnails for regular size pages will have. large_sizenumber <optional>
regular_size the maximum dimension that thumbnails for large pages will have. Returns:
this object, for call chaining -
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 compatibleboolean if true will use the older XOD format which is not compatible with Silverlight/Flash Returns:
this object, for call chaining