com.aspose.xps.rendering

Class PdfSaveOptions

java.lang.Object

com.aspose.page.SaveOptions

com.aspose.xps.rendering.PdfSaveOptions

All Implemented Interfaces:

IMultiPageSaveOptions, IEventBasedModificationOptions, IPipelineOptions, IXpsTextConversionOptions

public class PdfSaveOptions
extends SaveOptions
implements IMultiPageSaveOptions, IXpsTextConversionOptions, IPipelineOptions, IEventBasedModificationOptions

Class for XPS-as-PDF saving options.

Constructor Summary

Constructors

Constructor and Description
PdfSaveOptions() Creates new instance of options.

Method Summary

Modifier and Type	Method and Description
int	getBatchSize() Returns the size of a portion of pages to pass from node to node.
List<BeforePageSavingEventHandler>	getBeforePageSavingEventHandlers() Returns the collection of event handlers that performs modifications to an XPS page just before it is saved.
PdfEncryptionDetails	getEncryptionDetails() Returns the encryption details.
PdfImageCompression	getImageCompression() Returns the compression type to be used for all images in the document.
int	getOutlineTreeExpansionLevel() Gets up to what level the document outline should be expanded when the PDF file is opened in a viewer. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on.
int	getOutlineTreeHeight() Gets the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, and so on.
int[]	getPageNumbers() Gets the array of numbers of pages to render.
PdfTextCompression	getTextCompression() Returns the compression type to be used for all content streams except images.
boolean	preserveText() In XPS, some text elements may contain references to alternate glyph forms that do not correspond to any character code in the font.
void	preserveText(boolean value) In XPS, some text elements may contain references to alternate glyph forms that do not correspond to any character code in the font.
void	setBatchSize(int value) Sets the size of a portion of pages to pass from node to node.
void	setEncryptionDetails(PdfEncryptionDetails value) Sets the encryption details.
void	setImageCompression(PdfImageCompression value) Sets the compression type to be used for all images in the document.
void	setOutlineTreeExpansionLevel(int value) Sets up to what level the document outline should be expanded when the PDF file is opened in a viewer. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on.
void	setOutlineTreeHeight(int value) Sets the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, and so on.
void	setPageNumbers(int[] value) Sets the array of numbers of pages to render.
void	setTextCompression(PdfTextCompression value) Sets the compression type to be used for all content streams except images.

Methods inherited from class com.aspose.page.SaveOptions

getAdditionalFontsFolders, getConvertFontsToTTF, getExceptions, getJpegQualityLevel, getSize, isDebug, isSupressErrors, setAdditionalFontsFolders, setConvertFontsToTTF, setDebug, setJpegQualityLevel, setSize, setSupressErrors

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfSaveOptions

public PdfSaveOptions()

Creates new instance of options.

Method Detail

getPageNumbers

public int[] getPageNumbers()

Gets the array of numbers of pages to render.

Specified by:

getPageNumbers in interface IMultiPageSaveOptions

Returns:

Numbers of pages.

setPageNumbers

public void setPageNumbers(int[] value)

Sets the array of numbers of pages to render.

Specified by:

setPageNumbers in interface IMultiPageSaveOptions

Parameters:

value - Numbers of pages.

getOutlineTreeHeight

public int getOutlineTreeHeight()

Gets the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, and so on. Default is 10.

Returns:

The outline tree height.

setOutlineTreeHeight

public void setOutlineTreeHeight(int value)

Sets the height of the document outline tree to save. 0 - the outline tree will not be converted, 1 - only the first level outline items will be converted, and so on.

Parameters:

value - The outline tree height.

getOutlineTreeExpansionLevel

public int getOutlineTreeExpansionLevel()

Gets up to what level the document outline should be expanded when the PDF file is opened in a viewer. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on.

Returns:

The outline tree expansion level.

setOutlineTreeExpansionLevel

public void setOutlineTreeExpansionLevel(int value)

Sets up to what level the document outline should be expanded when the PDF file is opened in a viewer. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on.

Parameters:

value - The outline tree expansion level.

getTextCompression

public PdfTextCompression getTextCompression()

Returns the compression type to be used for all content streams except images. Default is PdfTextCompression.Flate.

Returns:

The compression type.

setTextCompression

public void setTextCompression(PdfTextCompression value)

Sets the compression type to be used for all content streams except images. Default is PdfTextCompression.Flate.

Parameters:

value - The compression type.

getImageCompression

public PdfImageCompression getImageCompression()

Returns the compression type to be used for all images in the document. Default is PdfImageCompression.Auto.

Returns:

The compression type.

setImageCompression

public void setImageCompression(PdfImageCompression value)

Sets the compression type to be used for all images in the document. Default is PdfImageCompression.Auto.

Parameters:

value - The compression type.

getEncryptionDetails

public PdfEncryptionDetails getEncryptionDetails()

Returns the encryption details. If not set, then no encryption will be performed.

Returns:

The encryption details.

setEncryptionDetails

public void setEncryptionDetails(PdfEncryptionDetails value)

Sets the encryption details. If not set, then no encryption will be performed.

Parameters:

value - The encryption details.

preserveText

public boolean preserveText()

In XPS, some text elements may contain references to alternate glyph forms that do not correspond to any character code in the font. If this flag is set to true, the text from such XPS elements is converted to graphic shapes. Then the text itself appears transparent on top. This leaves the text of such elements selectable. But the side effect is that the output file may be much larger than the original. If this flag is set to false, the characters that should be displayed as alternate forms are replaced with some other characters that become mapped to the alternate glyph forms. Therefore the text, although still selectable, will be modified and likely become unreadable.

Specified by:

preserveText in interface IXpsTextConversionOptions

Returns:

The flag value.

preserveText

public void preserveText(boolean value)

In XPS, some text elements may contain references to alternate glyph forms that do not correspond to any character code in the font. If this flag is set to true, the text from such XPS elements is converted to graphic shapes. Then the text itself appears transparent on top. This leaves the text of such elements selectable. But the side effect is that the output file may be much larger than the original. If this flag is set to false, the characters that should be displayed as alternate forms are replaced with some other characters that become mapped to the alternate glyph forms. Therefore the text, although still selectable, will be modified and likely become unreadable.

Specified by:

preserveText in interface IXpsTextConversionOptions

Parameters:

value - The flag value.

getBatchSize

public int getBatchSize()

Returns the size of a portion of pages to pass from node to node.

Specified by:

getBatchSize in interface IPipelineOptions

Returns:

The size of a portion of pages to pass from node to node.

setBatchSize

public void setBatchSize(int value)

Sets the size of a portion of pages to pass from node to node.

Specified by:

setBatchSize in interface IPipelineOptions

Parameters:

value - The size of a portion of pages to pass from node to node.

getBeforePageSavingEventHandlers

public List<BeforePageSavingEventHandler> getBeforePageSavingEventHandlers()

Returns the collection of event handlers that performs modifications to an XPS page just before it is saved.

Specified by:

getBeforePageSavingEventHandlers in interface IEventBasedModificationOptions

Returns:

The collection of event handlers that performs modifications to an XPS page just before it is saved.