PdfSaveOptions

Inheritance: java.lang.Object, com.aspose.page.SaveOptions

All Implemented Interfaces: com.aspose.page.IMultiPageSaveOptions

public class PdfSaveOptions extends SaveOptions implements IMultiPageSaveOptions

Class for XPS-as-PDF saving options.

Constructors

ConstructorDescription
PdfSaveOptions()Creates new instance of options.

Methods

MethodDescription
getPageNumbers()Gets the array of numbers of pages to render.
setPageNumbers(int[] value)Sets the array of numbers of pages to render.
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.
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.
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.
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.
getTextCompression()Returns the compression type to be used for all content streams except images.
setTextCompression(PdfTextCompression value)Sets the compression type to be used for all content streams except images.
getImageCompression()Returns the compression type to be used for all images in the document.
setImageCompression(PdfImageCompression value)Sets the compression type to be used for all images in the document.
getEncryptionDetails()Returns the encryption details.
setEncryptionDetails(PdfEncryptionDetails value)Sets the encryption details.

PdfSaveOptions()

public PdfSaveOptions()

Creates new instance of options.

getPageNumbers()

public int[] getPageNumbers()

Gets the array of numbers of pages to render.

Returns: int[] - Numbers of pages.

setPageNumbers(int[] value)

public void setPageNumbers(int[] value)

Sets the array of numbers of pages to render.

Parameters:

ParameterTypeDescription
valueint[]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: int - The outline tree height.

setOutlineTreeHeight(int value)

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:

ParameterTypeDescription
valueintThe 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: int - The outline tree expansion level.

setOutlineTreeExpansionLevel(int value)

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:

ParameterTypeDescription
valueintThe 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: PdfTextCompression - The compression type.

setTextCompression(PdfTextCompression value)

public void setTextCompression(PdfTextCompression value)

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

Parameters:

ParameterTypeDescription
valuePdfTextCompressionThe compression type.

getImageCompression()

public PdfImageCompression getImageCompression()

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

Returns: PdfImageCompression - The compression type.

setImageCompression(PdfImageCompression value)

public void setImageCompression(PdfImageCompression value)

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

Parameters:

ParameterTypeDescription
valuePdfImageCompressionThe compression type.

getEncryptionDetails()

public PdfEncryptionDetails getEncryptionDetails()

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

Returns: PdfEncryptionDetails - The encryption details.

setEncryptionDetails(PdfEncryptionDetails value)

public void setEncryptionDetails(PdfEncryptionDetails value)

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

Parameters:

ParameterTypeDescription
valuePdfEncryptionDetailsThe encryption details.