PdfSaveOptions

Inheritance: java.lang.Object, com.aspose.tex.rendering.SaveOptions

public class PdfSaveOptions extends SaveOptions

Class representing options of saving to PDF.

Constructors

ConstructorDescription
PdfSaveOptions()Creates new instance of options.

Methods

MethodDescription
getJpegQualityLevel()The Quality category specifies the level of compression for an image.
setJpegQualityLevel(int value)The Quality category specifies the level of compression for an image.
getOutlineTreeHeight()Specifies 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, ans so on.
setOutlineTreeHeight(int value)Specifies 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, ans so on.
getOutlineTreeExpansionLevel()Specifies up to what level the document outline should be expanded when the PDF file is viewed. 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)Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on.
getTextCompression()Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on.
setTextCompression(PdfTextCompression value)Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on.
getImageCompression()Specifies compression type to be used for all images in the document.
setImageCompression(PdfImageCompression value)Specifies compression type to be used for all images in the document.
getEncryptionDetails()Gets or sets a encryption details.
setEncryptionDetails(PdfEncryptionDetails value)Gets or sets a encryption details.

PdfSaveOptions()

public PdfSaveOptions()

Creates new instance of options.

getJpegQualityLevel()

public int getJpegQualityLevel()

The Quality category specifies the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Returns: int - The value specifying the level of compression for an image.

setJpegQualityLevel(int value)

public void setJpegQualityLevel(int value)

The Quality category specifies the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Parameters:

ParameterTypeDescription
valueintThe value specifying the level of compression for an image.

getOutlineTreeHeight()

public int getOutlineTreeHeight()

Specifies 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, ans so on.

Returns: int - The outline tree height.

setOutlineTreeHeight(int value)

public void setOutlineTreeHeight(int value)

Specifies 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, ans so on.

Parameters:

ParameterTypeDescription
valueintThe outline tree height.

getOutlineTreeExpansionLevel()

public int getOutlineTreeExpansionLevel()

Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1.

Returns: int - The outline tree expansion level.

setOutlineTreeExpansionLevel(int value)

public void setOutlineTreeExpansionLevel(int value)

Specifies up to what level the document outline should be expanded when the PDF file is viewed. 1 - only the first level outline items are shown, 2 - only the first and second level outline items are shown, and so on. Default is 1.

Parameters:

ParameterTypeDescription
valueintThe outline tree expansion level.

getTextCompression()

public PdfTextCompression getTextCompression()

Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

Specifies 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)

Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

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

Parameters:

ParameterTypeDescription
valuePdfTextCompressionThe compression type.

getImageCompression()

public PdfImageCompression getImageCompression()

Specifies 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)

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

Parameters:

ParameterTypeDescription
valuePdfImageCompressionThe compression type.

getEncryptionDetails()

public PdfEncryptionDetails getEncryptionDetails()

Gets or sets a encryption details. If not set, then no encryption will be performed.

Returns: PdfEncryptionDetails - The encryption details.

setEncryptionDetails(PdfEncryptionDetails value)

public void setEncryptionDetails(PdfEncryptionDetails value)

Gets or sets a encryption details. If not set, then no encryption will be performed.

Parameters:

ParameterTypeDescription
valuePdfEncryptionDetailsThe encryption details.