com.aspose.slides

Class PdfOptions

java.lang.Object

com.aspose.slides.SaveOptions

com.aspose.slides.PdfOptions

All Implemented Interfaces:

IPdfOptions, ISaveOptions

public class PdfOptions
extends SaveOptions
implements IPdfOptions

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

Constructor Summary

Constructors

Constructor and Description
PdfOptions() Default constructor.

Method Summary

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

Methods inherited from class com.aspose.slides.SaveOptions

getDefaultRegularFont, getProgressCallback, getWarningCallback, setDefaultRegularFont, setProgressCallback, setWarningCallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.slides.ISaveOptions

getDefaultRegularFont, getProgressCallback, getWarningCallback, setDefaultRegularFont, setProgressCallback, setWarningCallback

Constructor Detail

PdfOptions

public PdfOptions()

Default constructor.

Method Detail

getNotesCommentsLayouting

public final INotesCommentsLayoutingOptions getNotesCommentsLayouting()

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

Specified by:

getNotesCommentsLayouting in interface IPdfOptions

getShowHiddenSlides

public final boolean getShowHiddenSlides()

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

Specified by:

getShowHiddenSlides in interface IPdfOptions

setShowHiddenSlides

public final void setShowHiddenSlides(boolean value)

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

Specified by:

setShowHiddenSlides in interface IPdfOptions

getTextCompression

public final int getTextCompression()

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

Default is PdfTextCompression.Flate.

Specified by:

getTextCompression in interface IPdfOptions

setTextCompression

public final void setTextCompression(int value)

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

Default is PdfTextCompression.Flate.

Specified by:

setTextCompression in interface IPdfOptions

getBestImagesCompressionRatio

public final 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.

Specified by:

getBestImagesCompressionRatio in interface IPdfOptions

setBestImagesCompressionRatio

public final 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.

Specified by:

setBestImagesCompressionRatio in interface IPdfOptions

getEmbedTrueTypeFontsForASCII

public final boolean getEmbedTrueTypeFontsForASCII()

Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF's base 14 fonts and additional user specified fonts. Read/write boolean.

Default is true.

Specified by:

getEmbedTrueTypeFontsForASCII in interface IPdfOptions

setEmbedTrueTypeFontsForASCII

public final void setEmbedTrueTypeFontsForASCII(boolean value)

Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF's base 14 fonts and additional user specified fonts. Read/write boolean.

Default is true.

Specified by:

setEmbedTrueTypeFontsForASCII in interface IPdfOptions

getAdditionalCommonFontFamilies

public final java.lang.String[] getAdditionalCommonFontFamilies()

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

Specified by:

getAdditionalCommonFontFamilies in interface IPdfOptions

setAdditionalCommonFontFamilies

public final void setAdditionalCommonFontFamilies(java.lang.String[] value)

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

Specified by:

setAdditionalCommonFontFamilies in interface IPdfOptions

getEmbedFullFonts

public final boolean getEmbedFullFonts()

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

Default is false.

Specified by:

getEmbedFullFonts in interface IPdfOptions

setEmbedFullFonts

public final void setEmbedFullFonts(boolean value)

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

Default is false.

Specified by:

setEmbedFullFonts in interface IPdfOptions

getJpegQuality

public final 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.

Specified by:

getJpegQuality in interface IPdfOptions

setJpegQuality

public final 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.

Specified by:

setJpegQuality in interface IPdfOptions

getCompliance

public final int getCompliance()

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

Default is PdfCompliance.Pdf15.

Specified by:

getCompliance in interface IPdfOptions

setCompliance

public final void setCompliance(int value)

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

Default is PdfCompliance.Pdf15.

Specified by:

setCompliance in interface IPdfOptions

getPassword

public final java.lang.String getPassword()

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

Specified by:

getPassword in interface IPdfOptions

setPassword

public final void setPassword(java.lang.String value)

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

Specified by:

setPassword in interface IPdfOptions

getAccessPermissions

public final 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();
 }
 
 

Specified by:

getAccessPermissions in interface IPdfOptions

setAccessPermissions

public final 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();
 }
 
 

Specified by:

setAccessPermissions in interface IPdfOptions

getSaveMetafilesAsPng

public final 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.

Specified by:

getSaveMetafilesAsPng in interface IPdfOptions

setSaveMetafilesAsPng

public final 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.

Specified by:

setSaveMetafilesAsPng in interface IPdfOptions

getSufficientResolution

public final 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.

Specified by:

getSufficientResolution in interface IPdfOptions

setSufficientResolution

public final 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.

Specified by:

setSufficientResolution in interface IPdfOptions

getDrawSlidesFrame

public final boolean getDrawSlidesFrame()

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

Default is false.

Specified by:

getDrawSlidesFrame in interface IPdfOptions

setDrawSlidesFrame

public final void setDrawSlidesFrame(boolean value)

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

Default is false.

Specified by:

setDrawSlidesFrame in interface IPdfOptions

getImageTransparentColor

public final java.awt.Color getImageTransparentColor()

Gets or sets the image transparent color.

Value: The color of the image transparent.

Specified by:

getImageTransparentColor in interface IPdfOptions

setImageTransparentColor

public final void setImageTransparentColor(java.awt.Color value)

Gets or sets the image transparent color.

Value: The color of the image transparent.

Specified by:

setImageTransparentColor in interface IPdfOptions

getApplyImageTransparent

public final boolean getApplyImageTransparent()

Applies the specified transparent color to an image if true.

Specified by:

getApplyImageTransparent in interface IPdfOptions

setApplyImageTransparent

public final void setApplyImageTransparent(boolean value)

Applies the specified transparent color to an image if true.

Specified by:

setApplyImageTransparent in interface IPdfOptions