IPdfOptions

All Implemented Interfaces: com.aspose.slides.ISaveOptions

public interface IPdfOptions extends ISaveOptions

Provides options that control how a presentation is saved in Pdf format.

Methods

Method Description
getTextCompression() Specifies compression type to be used for all textual content in the document.
setTextCompression(int value) Specifies compression type to be used for all textual content in the document.
getBestImagesCompressionRatio() Indicates if the most effective compression (instead of the default one) for each image must be selected automatically.
setBestImagesCompressionRatio(boolean value) Indicates if the most effective compression (instead of the default one) for each image must be selected automatically.
getEmbedTrueTypeFontsForASCII() True to embed true type fonts for ASCII characters 32-127.
setEmbedTrueTypeFontsForASCII(boolean value) True to embed true type fonts for ASCII characters 32-127.
getShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
setShowHiddenSlides(boolean value) Specifies whether the generated document should include hidden slides or not.
getAdditionalCommonFontFamilies() Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
setAdditionalCommonFontFamilies(String[] value) Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
getEmbedFullFonts() Determines if all characters of font should be embedded or only used subset.
setEmbedFullFonts(boolean value) Determines if all characters of font should be embedded or only used subset.
getJpegQuality() Returns or sets a value determining the quality of the JPEG images inside PDF document.
setJpegQuality(byte value) Returns or sets a value determining the quality of the JPEG images inside PDF document.
getCompliance() Desired conformance level for generated PDF document.
setCompliance(int value) Desired conformance level for generated PDF document.
getPassword() Setting user password to protect the PDF document.
setPassword(String value) Setting user password to protect the PDF document.
getAccessPermissions() Contains a set of flags specifying which access permissions should be granted when the document is opened with user access.
setAccessPermissions(int value) Contains a set of flags specifying which access permissions should be granted when the document is opened with user access.
getSaveMetafilesAsPng() True to convert all metafiles used in a presentation to the PNG images.
setSaveMetafilesAsPng(boolean value) True to convert all metafiles used in a presentation to the PNG images.
getSufficientResolution() Returns or sets a value determining resolution of images inside PDF document.
setSufficientResolution(float value) Returns or sets a value determining resolution of images inside PDF document.
getDrawSlidesFrame() True to draw black frame around each slide.
setDrawSlidesFrame(boolean value) True to draw black frame around each slide.
getNotesCommentsLayouting() Provides options that control how notes and comments is placed in exported document.
getImageTransparentColor() Gets or sets the image transparent color.
setImageTransparentColor(Color value) Gets or sets the image transparent color.
getApplyImageTransparent() Applies the specified transparent color to an image if true.
setApplyImageTransparent(boolean value) Applies the specified transparent color to an image if true.

getTextCompression()

public abstract int getTextCompression()

Specifies compression type to be used for all textual content in the document. Read/write PdfTextCompression.


Default is PdfTextCompression#Flate.

Returns: int

setTextCompression(int value)

public abstract void setTextCompression(int value)

Specifies compression type to be used for all textual content in the document. Read/write PdfTextCompression.


Default is PdfTextCompression#Flate.

Parameters:

Parameter Type Description
value int

getBestImagesCompressionRatio()

public abstract boolean getBestImagesCompressionRatio()

Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to true, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.


Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is false by default.


Default is false.

Returns: boolean

setBestImagesCompressionRatio(boolean value)

public abstract void setBestImagesCompressionRatio(boolean value)

Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to true, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.


Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is false by default.


Default is false.

Parameters:

Parameter Type Description
value boolean

getEmbedTrueTypeFontsForASCII()

public abstract boolean getEmbedTrueTypeFontsForASCII()

True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read/write boolean.


Default is true.

Returns: boolean

setEmbedTrueTypeFontsForASCII(boolean value)

public abstract void setEmbedTrueTypeFontsForASCII(boolean value)

True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read/write boolean.


Default is true.

Parameters:

Parameter Type Description
value boolean

getShowHiddenSlides()

public abstract boolean getShowHiddenSlides()

Specifies whether the generated document should include hidden slides or not. Default is false.

Returns: boolean

setShowHiddenSlides(boolean value)

public abstract void setShowHiddenSlides(boolean value)

Specifies whether the generated document should include hidden slides or not. Default is false.

Parameters:

Parameter Type Description
value boolean

getAdditionalCommonFontFamilies()

public abstract String[] getAdditionalCommonFontFamilies()

Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common. Read/write String[].

Returns: java.lang.String[]

setAdditionalCommonFontFamilies(String[] value)

public abstract void setAdditionalCommonFontFamilies(String[] value)

Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common. Read/write String[].

Parameters:

Parameter Type Description
value java.lang.String[]

getEmbedFullFonts()

public abstract boolean getEmbedFullFonts()

Determines if all characters of font should be embedded or only used subset. Read/write boolean.


Default is false.

Returns: boolean

setEmbedFullFonts(boolean value)

public abstract void setEmbedFullFonts(boolean value)

Determines if all characters of font should be embedded or only used subset. Read/write boolean.


Default is false.

Parameters:

Parameter Type Description
value boolean

getJpegQuality()

public abstract byte getJpegQuality()

Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.


Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Returns: byte

setJpegQuality(byte value)

public abstract void setJpegQuality(byte value)

Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.


Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 100.

Parameters:

Parameter Type Description
value byte

getCompliance()

public abstract int getCompliance()

Desired conformance level for generated PDF document. Read/write PdfCompliance.


Default is PdfCompliance#Pdf15.

Returns: int

setCompliance(int value)

public abstract void setCompliance(int value)

Desired conformance level for generated PDF document. Read/write PdfCompliance.


Default is PdfCompliance#Pdf15.

Parameters:

Parameter Type Description
value int

getPassword()

public abstract String getPassword()

Setting user password to protect the PDF document. Read/write String.

Returns: java.lang.String

setPassword(String value)

public abstract void setPassword(String value)

Setting user password to protect the PDF document. Read/write String.

Parameters:

Parameter Type Description
value java.lang.String

getAccessPermissions()

public abstract int getAccessPermissions()

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.


PdfOptions pdfOptions = new PdfOptions();
 pdfOptions.setPassword("my_password");
 pdfOptions.setAccessPermissions(PdfAccessPermissions.PrintDocument | PdfAccessPermissions.HighQualityPrint);
 Presentation presentation = new Presentation();
 try
 {
     presentation.save(pdfFilePath, SaveFormat.Pdf, pdfOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }

Returns: int

setAccessPermissions(int value)

public abstract void setAccessPermissions(int value)

Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions.


PdfOptions pdfOptions = new PdfOptions();
 pdfOptions.setPassword("my_password");
 pdfOptions.setAccessPermissions(PdfAccessPermissions.PrintDocument | PdfAccessPermissions.HighQualityPrint);
 Presentation presentation = new Presentation();
 try
 {
     presentation.save(pdfFilePath, SaveFormat.Pdf, pdfOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }

Parameters:

Parameter Type Description
value int

getSaveMetafilesAsPng()

public abstract boolean getSaveMetafilesAsPng()

True to convert all metafiles used in a presentation to the PNG images. Read/write boolean.


Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages. For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling. If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Returns: boolean

setSaveMetafilesAsPng(boolean value)

public abstract void setSaveMetafilesAsPng(boolean value)

True to convert all metafiles used in a presentation to the PNG images. Read/write boolean.


Default is true. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages. For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling. If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

Parameters:

Parameter Type Description
value boolean

getSufficientResolution()

public abstract float getSufficientResolution()

Returns or sets a value determining resolution of images inside PDF document. Read/write float.

Value: Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.


Property affects on file size, time of export and image quality.

The default value is 96.

Returns: float

setSufficientResolution(float value)

public abstract void setSufficientResolution(float value)

Returns or sets a value determining resolution of images inside PDF document. Read/write float.

Value: Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.


Property affects on file size, time of export and image quality.

The default value is 96.

Parameters:

Parameter Type Description
value float

getDrawSlidesFrame()

public abstract boolean getDrawSlidesFrame()

True to draw black frame around each slide. Read/write boolean.


Default is false.

Returns: boolean

setDrawSlidesFrame(boolean value)

public abstract void setDrawSlidesFrame(boolean value)

True to draw black frame around each slide. Read/write boolean.


Default is false.

Parameters:

Parameter Type Description
value boolean

getNotesCommentsLayouting()

public abstract INotesCommentsLayoutingOptions getNotesCommentsLayouting()

Provides options that control how notes and comments is placed in exported document.

Returns: INotesCommentsLayoutingOptions

getImageTransparentColor()

public abstract Color getImageTransparentColor()

Gets or sets the image transparent color.

Value: The color of the image transparent.

Returns: java.awt.Color

setImageTransparentColor(Color value)

public abstract void setImageTransparentColor(Color value)

Gets or sets the image transparent color.

Value: The color of the image transparent.

Parameters:

Parameter Type Description
value java.awt.Color

getApplyImageTransparent()

public abstract boolean getApplyImageTransparent()

Applies the specified transparent color to an image if true.

Returns: boolean

setApplyImageTransparent(boolean value)

public abstract void setApplyImageTransparent(boolean value)

Applies the specified transparent color to an image if true.

Parameters:

Parameter Type Description
value boolean