com.aspose.slides.model

Class PdfExportOptions

java.lang.Object

com.aspose.slides.model.ExportOptions

com.aspose.slides.model.PdfExportOptions

public class PdfExportOptions
extends ExportOptions

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfExportOptions.ComplianceEnum Desired conformance level for generated PDF document.
static class	PdfExportOptions.TextCompressionEnum Specifies compression type to be used for all textual content in the document.

Nested classes/interfaces inherited from class com.aspose.slides.model.ExportOptions

ExportOptions.GradientStyleEnum

Constructor Summary

Constructors

Constructor and Description
PdfExportOptions()

Method Summary

Modifier and Type	Method and Description
PdfExportOptions	accessPermissions(AccessPermissions accessPermissions)
PdfExportOptions	addAdditionalCommonFontFamiliesItem(String additionalCommonFontFamiliesItem)
PdfExportOptions	additionalCommonFontFamilies(List<String> additionalCommonFontFamilies)
PdfExportOptions	applyImageTransparent(Boolean applyImageTransparent)
PdfExportOptions	compliance(PdfExportOptions.ComplianceEnum compliance)
PdfExportOptions	drawSlidesFrame(Boolean drawSlidesFrame)
PdfExportOptions	embedFullFonts(Boolean embedFullFonts)
PdfExportOptions	embedTrueTypeFontsForASCII(Boolean embedTrueTypeFontsForASCII)
boolean	equals(Object o)
AccessPermissions	getAccessPermissions() Access permissions that should be granted when the document is opened with user access.
List<String>	getAdditionalCommonFontFamilies() Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
PdfExportOptions.ComplianceEnum	getCompliance() Desired conformance level for generated PDF document.
String	getImageTransparentColor() Image transparent color.
Integer	getJpegQuality() Returns or sets a value determining the quality of the JPEG images inside PDF document.
String	getPassword() Setting user password to protect the PDF document.
SlidesLayoutOptions	getSlidesLayoutOptions() Slides layouting options
Double	getSufficientResolution() Returns or sets a value determining resolution of images inside PDF document.
PdfExportOptions.TextCompressionEnum	getTextCompression() Specifies compression type to be used for all textual content in the document.
int	hashCode()
PdfExportOptions	hideInk(Boolean hideInk)
PdfExportOptions	imageTransparentColor(String imageTransparentColor)
PdfExportOptions	includeOleData(Boolean includeOleData)
PdfExportOptions	interpretMaskOpAsOpacity(Boolean interpretMaskOpAsOpacity)
Boolean	isApplyImageTransparent() True to apply specified ImageTransparentColor to an image.
Boolean	isDrawSlidesFrame() True to draw black frame around each slide.
Boolean	isEmbedFullFonts() Determines if all characters of font should be embedded or only used subset.
Boolean	isEmbedTrueTypeFontsForASCII() Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text.
Boolean	isHideInk() True to hide Ink elements in exported document.
Boolean	isIncludeOleData() True to convert all OLE data from the presentation to embedded files in the resulting PDF.
Boolean	isInterpretMaskOpAsOpacity() True to use ROP operation or Opacity for rendering brush.
Boolean	isRasterizeUnsupportedFontStyles() True if text should be rasterized as a bitmap and saved to PDF when the font does not support bold styling.
Boolean	isSaveMetafilesAsPng() True to convert all metafiles used in a presentation to the PNG images.
Boolean	isShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
PdfExportOptions	jpegQuality(Integer jpegQuality)
PdfExportOptions	password(String password)
PdfExportOptions	rasterizeUnsupportedFontStyles(Boolean rasterizeUnsupportedFontStyles)
PdfExportOptions	saveMetafilesAsPng(Boolean saveMetafilesAsPng)
void	setAccessPermissions(AccessPermissions accessPermissions)
void	setAdditionalCommonFontFamilies(List<String> additionalCommonFontFamilies)
void	setApplyImageTransparent(Boolean applyImageTransparent)
void	setCompliance(PdfExportOptions.ComplianceEnum compliance)
void	setDrawSlidesFrame(Boolean drawSlidesFrame)
void	setEmbedFullFonts(Boolean embedFullFonts)
void	setEmbedTrueTypeFontsForASCII(Boolean embedTrueTypeFontsForASCII)
void	setHideInk(Boolean hideInk)
void	setImageTransparentColor(String imageTransparentColor)
void	setIncludeOleData(Boolean includeOleData)
void	setInterpretMaskOpAsOpacity(Boolean interpretMaskOpAsOpacity)
void	setJpegQuality(Integer jpegQuality)
void	setPassword(String password)
void	setRasterizeUnsupportedFontStyles(Boolean rasterizeUnsupportedFontStyles)
void	setSaveMetafilesAsPng(Boolean saveMetafilesAsPng)
void	setShowHiddenSlides(Boolean showHiddenSlides)
void	setSlidesLayoutOptions(SlidesLayoutOptions slidesLayoutOptions)
void	setSufficientResolution(Double sufficientResolution)
void	setTextCompression(PdfExportOptions.TextCompressionEnum textCompression)
PdfExportOptions	showHiddenSlides(Boolean showHiddenSlides)
PdfExportOptions	slidesLayoutOptions(SlidesLayoutOptions slidesLayoutOptions)
PdfExportOptions	sufficientResolution(Double sufficientResolution)
PdfExportOptions	textCompression(PdfExportOptions.TextCompressionEnum textCompression)
String	toString()

Methods inherited from class com.aspose.slides.model.ExportOptions

addFontFallbackRulesItem, addFontSubstRulesItem, defaultRegularFont, deleteEmbeddedBinaryObjects, fontFallbackRules, fontSubstRules, getDefaultRegularFont, getFontFallbackRules, getFontSubstRules, getFormat, getGradientStyle, gradientStyle, isDeleteEmbeddedBinaryObjects, isSkipJavaScriptLinks, setDefaultRegularFont, setDeleteEmbeddedBinaryObjects, setFontFallbackRules, setFontSubstRules, setFormat, setGradientStyle, setSkipJavaScriptLinks, skipJavaScriptLinks

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PdfExportOptions

public PdfExportOptions()

Method Detail

textCompression

public PdfExportOptions textCompression(PdfExportOptions.TextCompressionEnum textCompression)

getTextCompression

public PdfExportOptions.TextCompressionEnum getTextCompression()

Specifies compression type to be used for all textual content in the document.

Returns:

textCompression

setTextCompression

public void setTextCompression(PdfExportOptions.TextCompressionEnum textCompression)

embedFullFonts

public PdfExportOptions embedFullFonts(Boolean embedFullFonts)

isEmbedFullFonts

public Boolean isEmbedFullFonts()

Determines if all characters of font should be embedded or only used subset.

Returns:

embedFullFonts

setEmbedFullFonts

public void setEmbedFullFonts(Boolean embedFullFonts)

compliance

public PdfExportOptions compliance(PdfExportOptions.ComplianceEnum compliance)

getCompliance

public PdfExportOptions.ComplianceEnum getCompliance()

Desired conformance level for generated PDF document.

Returns:

compliance

setCompliance

public void setCompliance(PdfExportOptions.ComplianceEnum compliance)

sufficientResolution

public PdfExportOptions sufficientResolution(Double sufficientResolution)

getSufficientResolution

public Double getSufficientResolution()

Returns or sets a value determining resolution of images inside PDF document. Property affects on file size, time of export and image quality. The default value is 96.

Returns:

sufficientResolution

setSufficientResolution

public void setSufficientResolution(Double sufficientResolution)

jpegQuality

public PdfExportOptions jpegQuality(Integer jpegQuality)

getJpegQuality

public Integer getJpegQuality()

Returns or sets a value determining the quality of the JPEG images inside PDF document.

Returns:

jpegQuality

setJpegQuality

public void setJpegQuality(Integer jpegQuality)

drawSlidesFrame

public PdfExportOptions drawSlidesFrame(Boolean drawSlidesFrame)

isDrawSlidesFrame

public Boolean isDrawSlidesFrame()

True to draw black frame around each slide.

Returns:

drawSlidesFrame

setDrawSlidesFrame

public void setDrawSlidesFrame(Boolean drawSlidesFrame)

showHiddenSlides

public PdfExportOptions showHiddenSlides(Boolean showHiddenSlides)

isShowHiddenSlides

public Boolean isShowHiddenSlides()

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

Returns:

showHiddenSlides

setShowHiddenSlides

public void setShowHiddenSlides(Boolean showHiddenSlides)

saveMetafilesAsPng

public PdfExportOptions saveMetafilesAsPng(Boolean saveMetafilesAsPng)

isSaveMetafilesAsPng

public Boolean isSaveMetafilesAsPng()

True to convert all metafiles used in a presentation to the PNG images.

Returns:

saveMetafilesAsPng

setSaveMetafilesAsPng

public void setSaveMetafilesAsPng(Boolean saveMetafilesAsPng)

password

public PdfExportOptions password(String password)

getPassword

public String getPassword()

Setting user password to protect the PDF document.

Returns:

password

setPassword

public void setPassword(String password)

embedTrueTypeFontsForASCII

public PdfExportOptions embedTrueTypeFontsForASCII(Boolean embedTrueTypeFontsForASCII)

isEmbedTrueTypeFontsForASCII

public Boolean isEmbedTrueTypeFontsForASCII()

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.

Returns:

embedTrueTypeFontsForASCII

setEmbedTrueTypeFontsForASCII

public void setEmbedTrueTypeFontsForASCII(Boolean embedTrueTypeFontsForASCII)

additionalCommonFontFamilies

public PdfExportOptions additionalCommonFontFamilies(List<String> additionalCommonFontFamilies)

addAdditionalCommonFontFamiliesItem

public PdfExportOptions addAdditionalCommonFontFamiliesItem(String additionalCommonFontFamiliesItem)

getAdditionalCommonFontFamilies

public List<String> getAdditionalCommonFontFamilies()

Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.

Returns:

additionalCommonFontFamilies

setAdditionalCommonFontFamilies

public void setAdditionalCommonFontFamilies(List<String> additionalCommonFontFamilies)

slidesLayoutOptions

public PdfExportOptions slidesLayoutOptions(SlidesLayoutOptions slidesLayoutOptions)

getSlidesLayoutOptions

public SlidesLayoutOptions getSlidesLayoutOptions()

Slides layouting options

Returns:

slidesLayoutOptions

setSlidesLayoutOptions

public void setSlidesLayoutOptions(SlidesLayoutOptions slidesLayoutOptions)

imageTransparentColor

public PdfExportOptions imageTransparentColor(String imageTransparentColor)

getImageTransparentColor

public String getImageTransparentColor()

Image transparent color.

Returns:

imageTransparentColor

setImageTransparentColor

public void setImageTransparentColor(String imageTransparentColor)

applyImageTransparent

public PdfExportOptions applyImageTransparent(Boolean applyImageTransparent)

isApplyImageTransparent

public Boolean isApplyImageTransparent()

True to apply specified ImageTransparentColor to an image.

Returns:

applyImageTransparent

setApplyImageTransparent

public void setApplyImageTransparent(Boolean applyImageTransparent)

accessPermissions

public PdfExportOptions accessPermissions(AccessPermissions accessPermissions)

getAccessPermissions

public AccessPermissions getAccessPermissions()

Access permissions that should be granted when the document is opened with user access. Default is AccessPermissions.None.

Returns:

accessPermissions

setAccessPermissions

public void setAccessPermissions(AccessPermissions accessPermissions)

hideInk

public PdfExportOptions hideInk(Boolean hideInk)

isHideInk

public Boolean isHideInk()

True to hide Ink elements in exported document.

Returns:

hideInk

setHideInk

public void setHideInk(Boolean hideInk)

interpretMaskOpAsOpacity

public PdfExportOptions interpretMaskOpAsOpacity(Boolean interpretMaskOpAsOpacity)

isInterpretMaskOpAsOpacity

public Boolean isInterpretMaskOpAsOpacity()

True to use ROP operation or Opacity for rendering brush.

Returns:

interpretMaskOpAsOpacity

setInterpretMaskOpAsOpacity

public void setInterpretMaskOpAsOpacity(Boolean interpretMaskOpAsOpacity)

rasterizeUnsupportedFontStyles

public PdfExportOptions rasterizeUnsupportedFontStyles(Boolean rasterizeUnsupportedFontStyles)

isRasterizeUnsupportedFontStyles

public Boolean isRasterizeUnsupportedFontStyles()

True if text should be rasterized as a bitmap and saved to PDF when the font does not support bold styling. This approach can enhance the quality of text in the resulting PDF for certain fonts.

Returns:

rasterizeUnsupportedFontStyles

setRasterizeUnsupportedFontStyles

public void setRasterizeUnsupportedFontStyles(Boolean rasterizeUnsupportedFontStyles)

includeOleData

public PdfExportOptions includeOleData(Boolean includeOleData)

isIncludeOleData

public Boolean isIncludeOleData()

True to convert all OLE data from the presentation to embedded files in the resulting PDF.

Returns:

includeOleData

setIncludeOleData

public void setIncludeOleData(Boolean includeOleData)

equals

public boolean equals(Object o)

Overrides:

equals in class ExportOptions

hashCode

public int hashCode()

Overrides:

hashCode in class ExportOptions

toString

public String toString()

Overrides:

toString in class ExportOptions