PTXODOutputOptions

@interface PTXODOutputOptions : PTXPSOutputCommonOptions

A class containing options for ToXod functions

  • Sets whether per page thumbnails should be included in the file. Default is true.

    Declaration

    Objective-C

    - (void)SetOutputThumbnails:(BOOL)include_thumbs;

    Swift

    func setOutputThumbnails(_ include_thumbs: Bool)

    Parameters

    include_thumbs

    if true thumbnails will be included

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

    Declaration

    Objective-C

    - (void)SetThumbnailSize:(unsigned int)size;

    Swift

    func setThumbnailSize(_ size: UInt32)

    Parameters

    size

    the maximum dimension (width or height) that thumbnails will have.

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

    Declaration

    Objective-C

    - (void)SetElementLimit:(unsigned int)element_limit;

    Swift

    func setElementLimit(_ element_limit: UInt32)

    Parameters

    element_limit

    the maximum number of elements before a given page will be rendered

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

    Declaration

    Objective-C

    - (void)SetOpacityMaskWorkaround:(BOOL)opacity_render;

    Swift

    func setOpacityMaskWorkaround(_ opacity_render: Bool)

    Parameters

    opacity_render

    if true pages with opacity masks will be rendered

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

    Declaration

    Objective-C

    - (void)SetMaximumImagePixels:(unsigned int)max_pixels;

    Swift

    func setMaximumImagePixels(_ max_pixels: UInt32)

    Parameters

    max_pixels

    the maximum number of pixels an image can have

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

    Declaration

    Objective-C

    - (void)SetFlattenContent:(PTFlattenFlag)flatten;

    Swift

    func setFlattenContent(_ flatten: PTFlattenFlag)

    Parameters

    flatten

    select which flattening mode to use.

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

    Declaration

    Objective-C

    - (void)SetFlattenThreshold:(PTFlattenThresholdFlag)threshold;

    Swift

    func setFlattenThreshold(_ threshold: PTFlattenThresholdFlag)

    Parameters

    threshold

    the threshold setting to use.

  • Where possible output JPG files rather than PNG. This will apply to both thumbnails and document images. Default is true.

    Declaration

    Objective-C

    - (void)SetPreferJPG:(BOOL)prefer_jpg;

    Swift

    func setPreferJPG(_ prefer_jpg: Bool)

    Parameters

    prefer_jpg

    if true JPG images will be used whenever possible.

  • Specifies the compression quality to use when generating JPEG images.

    Declaration

    Objective-C

    - (void)SetJPGQuality:(unsigned int)quality;

    Swift

    func setJPGQuality(_ quality: UInt32)

    Parameters

    quality

    the JPEG compression quality, from 0(highest compression) to 100(best quality).

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

    Declaration

    Objective-C

    - (void)SetSilverlightTextWorkaround:(BOOL)workaround;

    Swift

    func setSilverlightTextWorkaround(_ workaround: Bool)

    Parameters

    workaround

    if true rotated text will be changed to paths

  • Choose how to output annotations. Default is e_internal_xfdf.

    Declaration

    Objective-C

    - (void)SetAnnotationOutput:(PTAnnotationOutputFlag)annot_output;

    Swift

    func setAnnotationOutput(_ annot_output: PTAnnotationOutputFlag)

    Parameters

    annot_output

    the flag to specify the output option

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

    Declaration

    Objective-C

    - (void)SetExternalParts:(BOOL)generate;

    Swift

    func setExternalParts(_ generate: Bool)

    Parameters

    generate

    if true XOD is output as a collection of loose files

  • Encrypt XOD parts with AES 128 encryption using the supplied password. This option is not available when using SetExternalParts(true)

    Declaration

    Objective-C

    - (void)SetEncryptPassword:(NSString *)pass;

    Swift

    func setEncryptPassword(_ pass: String!)

    Parameters

    pass

    the encryption password

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

    Declaration

    Objective-C

    - (void)UseSilverlightFlashCompatible:(BOOL)compatible;

    Swift

    func useSilverlightFlashCompatible(_ compatible: Bool)

    Parameters

    compatible

    if true will use the older XOD format which is not compatible with Silverlight/Flash

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()