Class Convert.XODOutputOptions

A class containing options for ToXod functions

Inheritance

object

Convert.XPSOutputCommonOptions

Convert.XODOutputOptions

Inherited Members

Convert.XPSOutputCommonOptions.SetPrintMode(bool)

Convert.XPSOutputCommonOptions.SetDPI(uint)

Convert.XPSOutputCommonOptions.SetRenderPages(bool)

Convert.XPSOutputCommonOptions.SetThickenLines(bool)

Convert.XPSOutputCommonOptions.GenerateURLLinks(bool)

Convert.XPSOutputCommonOptions.SetOverprint(PDFRasterizer.OverprintPreviewMode)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class Convert.XODOutputOptions : Convert.XPSOutputCommonOptions

Constructors

XODOutputOptions()

Declaration

public XODOutputOptions()

Methods

SetAnnotationOutput(AnnotationOutputFlag)

Choose how to output annotations. Default is e_internal_xfdf.

Declaration

public void SetAnnotationOutput(Convert.XODOutputOptions.AnnotationOutputFlag annot_output)

Parameters

Type	Name	Description
Convert.XODOutputOptions.AnnotationOutputFlag	annot_output	the chosen annotation output option

SetElementLimit(uint)

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

public void SetElementLimit(uint element_limit)

Parameters

Type	Name	Description
uint	element_limit	the maximum number of elements before a given page will be rendered

SetEncryptPassword(string)

Encrypt XOD parts with AES 128 encryption using the supplied password.

Declaration

public void SetEncryptPassword(string pass)

Parameters

Type	Name	Description
string	pass	the encryption password.

SetExternalParts(bool)

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

public void SetExternalParts(bool generate)

Parameters

Type	Name	Description
bool	generate	if true XOD is output as a collection of loose files.

SetExtractUsingZorder(bool)

Sets whether text extraction uses Z-order as reading order. Default is false.

Declaration

public void SetExtractUsingZorder(bool use_zorder)

Parameters

Type	Name	Description
bool	use_zorder	if true text extraction uses Z-order as reading order.

SetFlattenContent(FlattenFlag)

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

public void SetFlattenContent(Convert.FlattenFlag flatten)

Parameters

Type	Name	Description
Convert.FlattenFlag	flatten	select which flattening mode to use.

SetFlattenThreshold(FlattenThresholdFlag)

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

public void SetFlattenThreshold(Convert.FlattenThresholdFlag threshold)

Parameters

Type	Name	Description
Convert.FlattenThresholdFlag	threshold	the threshold setting to use.

SetJPGQuality(uint)

Specifies the compression quality to use when generating JPEG images.

Declaration

public void SetJPGQuality(uint quality)

Parameters

Type	Name	Description
uint	quality	the JPEG compression quality, from 0(highest compression) to 100(best quality).

SetMaximumImagePixels(uint)

Specifies the maximum image size in pixels. Default is 2000000.

Declaration

public void SetMaximumImagePixels(uint max_pixels)

Parameters

Type	Name	Description
uint	max_pixels	the maximum number of pixels an image can have.

Remarks

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.

SetOpacityMaskWorkaround(bool)

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. the default setting is not to render pages with opacity masks. Default is false.

Declaration

public void SetOpacityMaskWorkaround(bool opacity_render)

Parameters

Type	Name	Description
bool	opacity_render	if true pages with opacity masks will be rendered

SetOutputThumbnails(bool)

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

Declaration

public void SetOutputThumbnails(bool include_thumbs)

Parameters

Type	Name	Description
bool	include_thumbs	if true thumbnails will be included

SetPreferJPG(bool)

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

Declaration

public void SetPreferJPG(bool prefer_jpg)

Parameters

Type	Name	Description
bool	prefer_jpg	if true JPG images will be used whenever possible.

SetSilverlightTextWorkaround(bool)

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

public void SetSilverlightTextWorkaround(bool workaround)

Parameters

Type	Name	Description
bool	workaround	if true rotated text will be changed to paths.

SetThumbnailSize(uint)

The width and height of squares in which thumbnails will be contained. Default is 400 for normal pages and 1500 for large pages.

Declaration

public void SetThumbnailSize(uint size)

Parameters

Type	Name	Description
uint	size	size the maximum dimension (width or height) that thumbnails will have.

Remarks

A large page is a page larger than twice the area of the standard page size (8.5 X 11).

SetThumbnailSize(uint, uint)

The width and height of squares in which thumbnails will be contained. Default is 400 for normal pages and 1500 for large pages.

Declaration

public void SetThumbnailSize(uint regular_size, uint large_size)

Parameters

Type	Name	Description
uint	regular_size	the maximum dimension that thumbnails for regular size pages will have.
uint	large_size	the maximum dimension that thumbnails for large pages will have.

Remarks

A large page is a page larger than twice the area of the standard page size (8.5 X 11).

UseSilverlightFlashCompatible(bool)

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

public void UseSilverlightFlashCompatible(bool compatible)

Parameters

Type	Name	Description
bool	compatible	if true will use the older XOD format which is not compatible with Silverlight/Flash.