com.aspose.cells

Class PdfSaveOptions

java.lang.Object

com.aspose.cells.SaveOptions

com.aspose.cells.PaginatedSaveOptions

com.aspose.cells.PdfSaveOptions

public class PdfSaveOptions
extends PaginatedSaveOptions

Represents the options for saving pdf file.

Constructor Summary

Constructors

Constructor and Description
PdfSaveOptions() Creates the options for saving pdf file.

Method Summary

Methods

Modifier and Type	Method and Description
PdfBookmarkEntry	getBookmark() Gets the PdfBookmarkEntry object.
boolean	getCalculateFormula() Indicates whether to calculate formulas before saving pdf file.
int	getCompliance() Gets the PDF standards compliance level for output documents.
DateTime	getCreatedTime() Gets the time of generating the pdf document.
int	getCustomPropertiesExport() Gets a value determining the way CustomDocumentPropertyCollection are exported to PDF file.
boolean	getDisplayDocTitle() Indicates whether the window's title bar should display the document title.
boolean	getEmbedAttachments() Indicates whether to embed attachment for Ole objects in Excel.
boolean	getEmbedStandardWindowsFonts() True to embed true type fonts.
boolean	getExportDocumentStructure() Indicates whether to export document structure.
int	getFontEncoding() Gets embedded font encoding in pdf.
ImageFormat	getImageType() Deprecated. Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
int	getOptimizationType() Gets pdf optimization type.
int	getPdfCompression() Indicate the compression algorithm
java.lang.String	getProducer() Gets producer of generated pdf document.
PdfSecurityOptions	getSecurityOptions() Set this options, when security is need in xls2pdf result.
RenderingWatermark	getWatermark() Gets watermark to output.
void	setBookmark(PdfBookmarkEntry value) Sets the PdfBookmarkEntry object.
void	setCalculateFormula(boolean value) Indicates whether to calculate formulas before saving pdf file.
void	setCompliance(int value) Sets the PDF standards compliance level for output documents.
void	setCreatedTime(DateTime value) Sets the time of generating the pdf document.
void	setCustomPropertiesExport(int value) Sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file.
void	setDisplayDocTitle(boolean value) Indicates whether the window's title bar should display the document title.
void	setEmbedAttachments(boolean value) Indicates whether to embed attachment for Ole objects in Excel.
void	setEmbedStandardWindowsFonts(boolean value) True to embed true type fonts.
void	setExportDocumentStructure(boolean value) Indicates whether to export document structure.
void	setFontEncoding(int value) Sets embedded font encoding in pdf.
void	setImageResample(int desiredPPI, int jpegQuality) Sets desired PPI(pixels per inch) of resample images and jpeg quality.
void	setImageType(ImageFormat value) Deprecated. Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.
void	setOptimizationType(int value) Sets pdf optimization type.
void	setPdfCompression(int value) Indicate the compression algorithm
void	setProducer(java.lang.String value) Sets producer of generated pdf document.
void	setSecurityOptions(PdfSecurityOptions value) Set this options, when security is need in xls2pdf result.
void	setWatermark(RenderingWatermark value) Sets watermark to output.

Methods inherited from class com.aspose.cells.PaginatedSaveOptions

getAllColumnsInOnePagePerSheet, getCheckFontCompatibility, getCheckWorkbookDefaultFont, getCustomRenderSettings, getDefaultEditLanguage, getDefaultFont, getDrawObjectEventHandler, getEmfRenderSetting, getGridlineColor, getGridlineType, getIgnoreError, getOnePagePerSheet, getOutputBlankPageWhenNothingToPrint, getPageCount, getPageIndex, getPageSavingCallback, getPrintingPageType, getSheetSet, getTextCrossType, isFontSubstitutionCharGranularity, setAllColumnsInOnePagePerSheet, setCheckFontCompatibility, setCheckWorkbookDefaultFont, setCustomRenderSettings, setDefaultEditLanguage, setDefaultFont, setDrawObjectEventHandler, setEmfRenderSetting, setFontSubstitutionCharGranularity, setGridlineColor, setGridlineType, setIgnoreError, setOnePagePerSheet, setOutputBlankPageWhenNothingToPrint, setPageCount, setPageIndex, setPageSavingCallback, setPrintingPageType, setSheetSet, setTextCrossType

Methods inherited from class com.aspose.cells.SaveOptions

getCachedFileFolder, getCheckExcelRestriction, getClearData, getCreateDirectory, getEncryptDocumentProperties, getMergeAreas, getRefreshChartCache, getSaveFormat, getSortExternalNames, getSortNames, getUpdateSmartArt, getValidateMergedAreas, getWarningCallback, setCachedFileFolder, setCheckExcelRestriction, setClearData, setCreateDirectory, setEncryptDocumentProperties, setMergeAreas, setRefreshChartCache, setSortExternalNames, setSortNames, setUpdateSmartArt, setValidateMergedAreas, setWarningCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfSaveOptions

public PdfSaveOptions()

Creates the options for saving pdf file.

Method Detail

getEmbedStandardWindowsFonts

public boolean getEmbedStandardWindowsFonts()

True to embed true type fonts. Affects only ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. Default is true.

setEmbedStandardWindowsFonts

public void setEmbedStandardWindowsFonts(boolean value)

True to embed true type fonts. Affects only ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. Default is true.

getBookmark

public PdfBookmarkEntry getBookmark()

Gets the PdfBookmarkEntry object.

setBookmark

public void setBookmark(PdfBookmarkEntry value)

Sets the PdfBookmarkEntry object.

getCompliance

public int getCompliance()

Gets the PDF standards compliance level for output documents.

See PdfCompliance.

Remarks

Default is Pdf17.

setCompliance

public void setCompliance(int value)

Sets the PDF standards compliance level for output documents.

See PdfCompliance.

Remarks

Default is Pdf17.

getSecurityOptions

public PdfSecurityOptions getSecurityOptions()

Set this options, when security is need in xls2pdf result.

Example

The following code sets hight resolution print permisson for the output pdf.

 
         Workbook wb = new Workbook();
         wb.getWorksheets().get(0).getCells().get("A1").setValue("Aspose");
 
         PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
 
 
         PdfSecurityOptions pdfSecurityOptions = new PdfSecurityOptions();
 
         //set owner password
         pdfSecurityOptions.setOwnerPassword("YourOwnerPassword");
 
         //set user password
         pdfSecurityOptions.setUserPassword("YourUserPassword");
 
         //set print permisson
         pdfSecurityOptions.setPrintPermission(true);
 
         //set high resolution for print
         pdfSecurityOptions.setFullQualityPrintPermission(true);
 
 
         pdfSaveOptions.setSecurityOptions(pdfSecurityOptions);
 
         wb.save("output.pdf", pdfSaveOptions);
 

setSecurityOptions

public void setSecurityOptions(PdfSecurityOptions value)

Set this options, when security is need in xls2pdf result.

getImageType

public ImageFormat getImageType()

Deprecated. Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.

Represents the image type when converting the chart and shape .

Remarks

NOTE: This member is now obsolete. Instead, Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

setImageType

public void setImageType(ImageFormat value)

Deprecated. Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality.

Represents the image type when converting the chart and shape .

Remarks

NOTE: This member is now obsolete. Instead, Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

getCalculateFormula

public boolean getCalculateFormula()

Indicates whether to calculate formulas before saving pdf file.

Remarks

The default value is false.

setCalculateFormula

public void setCalculateFormula(boolean value)

Indicates whether to calculate formulas before saving pdf file.

Remarks

The default value is false.

getPdfCompression

public int getPdfCompression()

Indicate the compression algorithm

See PdfCompressionCore.

setPdfCompression

public void setPdfCompression(int value)

Indicate the compression algorithm

See PdfCompressionCore.

setImageResample

public void setImageResample(int desiredPPI,
                    int jpegQuality)

Sets desired PPI(pixels per inch) of resample images and jpeg quality. All images will be converted to JPEG with the specified quality setting, and images that are greater than the specified PPI (pixels per inch) will be resampled.

Example

The following code sets desired PPI as 96 and jpeg quality as 80 for images in the output pdf.

 
         //load the source file with images.
         Workbook wb = new Workbook("Book1.xlsx");
 
         PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
 
         //set desired PPI as 96 and jpeg quality as 80.
         pdfSaveOptions.setImageResample(96, 80);
 
         wb.save("output.pdf", pdfSaveOptions);
 

Parameters:

desiredPPI - Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.

jpegQuality - 0 - 100% JPEG quality.

getCreatedTime

public DateTime getCreatedTime()

Gets the time of generating the pdf document.

Remarks

if it is not be set, it will be the time of generating the pdf.

setCreatedTime

public void setCreatedTime(DateTime value)

Sets the time of generating the pdf document.

Remarks

if it is not be set, it will be the time of generating the pdf.

getProducer

public java.lang.String getProducer()

Gets producer of generated pdf document.

Remarks

If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.

setProducer

public void setProducer(java.lang.String value)

Sets producer of generated pdf document.

Remarks

If the value is null, or a valid LICENSE is not set, string Aspose.Cells vVERSION will be used.

getOptimizationType

public int getOptimizationType()

Gets pdf optimization type.

See PdfOptimizationType.

Remarks

Default value is PdfOptimizationType.STANDARD

setOptimizationType

public void setOptimizationType(int value)

Sets pdf optimization type.

See PdfOptimizationType.

Remarks

Default value is PdfOptimizationType.STANDARD

getCustomPropertiesExport

public int getCustomPropertiesExport()

Gets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.

See PdfCustomPropertiesExport.

setCustomPropertiesExport

public void setCustomPropertiesExport(int value)

Sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None.

See PdfCustomPropertiesExport.

getExportDocumentStructure

public boolean getExportDocumentStructure()

Indicates whether to export document structure.

setExportDocumentStructure

public void setExportDocumentStructure(boolean value)

Indicates whether to export document structure.

getDisplayDocTitle

public boolean getDisplayDocTitle()

Indicates whether the window's title bar should display the document title.

Remarks

If false, the title bar should instead display the name of the PDF file. Default value is false.

setDisplayDocTitle

public void setDisplayDocTitle(boolean value)

Indicates whether the window's title bar should display the document title.

Remarks

If false, the title bar should instead display the name of the PDF file. Default value is false.

getFontEncoding

public int getFontEncoding()

Gets embedded font encoding in pdf.

See PdfFontEncoding.

Remarks

Default value is PdfFontEncoding.IDENTITY

setFontEncoding

public void setFontEncoding(int value)

Sets embedded font encoding in pdf.

See PdfFontEncoding.

Remarks

Default value is PdfFontEncoding.IDENTITY

getWatermark

public RenderingWatermark getWatermark()

Gets watermark to output.

Example

The following code sets watermark in the output pdf.

 
         //prepare a workbook with 3 pages.
         Workbook wb = new Workbook();
         wb.getWorksheets().get(0).getCells().get("A1").putValue("Page1");
         int index = wb.getWorksheets().add();
         wb.getWorksheets().get(index).getCells().get("A1").putValue("Page2");
         index = wb.getWorksheets().add();
         wb.getWorksheets().get(index).getCells().get("A1").putValue("Page3");
         wb.getWorksheets().get(index).getPageSetup().setPaperSize(PaperSizeType.PAPER_A_3);
 
         //create a font for watermark, and specify bold, italic, color
         RenderingFont font = new RenderingFont("Calibri", 68);
         font.setItalic(true);
         font.setBold(true);
         font.setColor(Color.getBlue());
 
         //create a watermark from text and the specified font
         RenderingWatermark watermark = new RenderingWatermark("Watermark", font);
 
         //specify horizontal and vertical alignment
         watermark.setHAlignment(TextAlignmentType.CENTER);
         watermark.setVAlignment(TextAlignmentType.CENTER);
 
         //specify rotation
         watermark.setRotation(30);
 
         //specify opacity
         watermark.setOpacity(0.6f);
 
         //specify the scale to page(e.g. 100, 50) in percent.
         watermark.setScaleToPagePercent(50);
 
         //spcify watermark for rendering to pdf.
         PdfSaveOptions options = new PdfSaveOptions();
         options.setWatermark(watermark);
 
         wb.save("output_watermark.pdf", options);
 

setWatermark

public void setWatermark(RenderingWatermark value)

Sets watermark to output.

getEmbedAttachments

public boolean getEmbedAttachments()

Indicates whether to embed attachment for Ole objects in Excel.

Remarks

Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled.

setEmbedAttachments

public void setEmbedAttachments(boolean value)

Indicates whether to embed attachment for Ole objects in Excel.

Remarks

Default value is false. The value must be false when PDF/A compliance is set or pdf encryption is enabled.