com.aspose.cells
Class PdfSaveOptions

java.lang.Object
  SaveOptions
      com.aspose.cells.PdfSaveOptions

public class PdfSaveOptions 
extends SaveOptions

Workbook wb = new Workbook("Book1.xlsx");

PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();

//ignore blank pages
pdfSaveOptions.setPrintingPageType(PrintingPageType.IGNORE_BLANK);

wb.save("output_ignore_blank_page.pdf", pdfSaveOptions);


//ignore blank pages and pages which only contains some style content like cell background
pdfSaveOptions.setPrintingPageType(PrintingPageType.IGNORE_STYLE);

wb.save("output_ignore_blank_and_style_page.pdf", pdfSaveOptions);

PdfSaveOptions

public PdfSaveOptions()

Creates the options for saving pdf file.

PdfSaveOptions

public PdfSaveOptions(int saveFormat)

Creates the options for saving pdf file.

NOTE: This constructor is now obsolete. Instead, please use PdfSaveOptions() constructor. This property will be removed 12 months later since January 2021. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

saveFormat - A SaveFormat value. The save format.It must be pdf.

public int getPrintingPageType() / public void setPrintingPageType(int value)

Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.

If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. If you don't want these blank pages, you can use this option to omit them.

public boolean getEmbedStandardWindowsFonts() / 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.

public PdfBookmarkEntry getBookmark() / public void setBookmark(PdfBookmarkEntry value)

Gets and sets the PdfBookmarkEntry object.

public int getCompliance() / public void setCompliance(int value)

Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.

public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

public boolean getCheckWorkbookDefaultFont() / public void setCheckWorkbookDefaultFont(boolean value)

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook's default font to show these characters first.

Default is true.

public PdfSecurityOptions getSecurityOptions() / public void setSecurityOptions(PdfSecurityOptions value)

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

Example:

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

public boolean getOnePagePerSheet() / public void setOnePagePerSheet(boolean value)

If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

public boolean getAllColumnsInOnePagePerSheet() / public void setAllColumnsInOnePagePerSheet(boolean value)

If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.

public com.aspose.cells.ImageFormat getImageType() / public void setImageType(com.aspose.cells.ImageFormat value)

Represents the image type when converting the chart and shape .

NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

public boolean getCalculateFormula() / public void setCalculateFormula(boolean value)

Indicates whether to calculate formulas before saving pdf file.

The default value is false.

public int getPdfCompression() / public void setPdfCompression(int value)

Indicate the compression algorithm The value of the property is PdfCompressionCore integer constant.

public boolean getCheckFontCompatibility() / public void setCheckFontCompatibility(boolean value)

Indicates whether to check font compatibility for every character in text.

The default value is true. Disable this property may give better performance. But when the default or specified font of text/character cannot be used to render it, unreadable characters(such as block) maybe occur in the generated pdf. For such situation user should keep this property as true so that alternative font can be searched and used to render the text instead;

public int getPageIndex() / public void setPageIndex(int value)

Gets or sets the 0-based index of the first page to save.

Default is 0.

Example:

//Open an Excel file
Workbook wb = new Workbook("Book1.xlsx");

PdfSaveOptions options = new PdfSaveOptions();

//Print only Page 3 and Page 4 in the output PDF
//Starting page index (0-based index)
options.setPageIndex(3);
//Number of pages to be printed
options.setPageCount(2);

//Save the PDF file
wb.save("output.pdf", options);

public int getPageCount() / public void setPageCount(int value)

Gets or sets the number of pages to save.

Default is System.Int32.MaxValue which means all pages will be rendered..

Example:

//Open an Excel file
Workbook wb = new Workbook("Book1.xlsx");

PdfSaveOptions options = new PdfSaveOptions();

//Print only Page 3 and Page 4 in the output PDF
//Starting page index (0-based index)
options.setPageIndex(3);
//Number of pages to be printed
options.setPageCount(2);

//Save the PDF file
wb.save("output.pdf", options);

public com.aspose.cells.DateTime getCreatedTime() / public void setCreatedTime(com.aspose.cells.DateTime value)

Gets and sets the time of generating the pdf document.

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

public java.lang.String getProducer() / public void setProducer(java.lang.String value)

Gets and sets producer of generated pdf document.

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

public int getOptimizationType() / public void setOptimizationType(int value)

Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.

Default value is PdfOptimizationType.STANDARD

public boolean isFontSubstitutionCharGranularity() / public void setFontSubstitutionCharGranularity(boolean value)

Indicates whether to only substitute the font of character when the cell font is not compatibility for it.

Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

public int getGridlineType() / public void setGridlineType(int value)

Gets or sets gridline type. The value of the property is GridlineType integer constant.

Default is Dotted type.

public int getTextCrossType() / public void setTextCrossType(int value)

Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.

public boolean getIgnoreError() / public void setIgnoreError(boolean value)

Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

public boolean getOutputBlankPageWhenNothingToPrint() / public void setOutputBlankPageWhenNothingToPrint(boolean value)

Indicates whether to output a blank page when there is nothing to print.

Default is true.

public DrawObjectEventHandler getDrawObjectEventHandler() / public void setDrawObjectEventHandler(DrawObjectEventHandler value)

Implements this interface to get DrawObject and Bound when rendering.

public int getCustomPropertiesExport() / public void setCustomPropertiesExport(int value)

Gets or sets a value determining the way CustomDocumentPropertyCollection are exported to PDF file. Default value is None. The value of the property is PdfCustomPropertiesExport integer constant.

public boolean getExportDocumentStructure() / public void setExportDocumentStructure(boolean value)

Indicates whether to export document structure.

public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)

Control/Indicate progress of page saving process.

public int getEmfRenderSetting() / public void setEmfRenderSetting(int value)

Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.

EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When #Error Cref: !:EmfRenderSetting.EmfPlusPrefer is set, then EMF+ records will be parsed while rendering to pdf, otherwise only EMF records will be parsed. Default value is #Error Cref: !:EmfRenderSetting.EmfOnly.

public boolean getDisplayDocTitle() / public void setDisplayDocTitle(boolean value)

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

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

public int getDefaultEditLanguage() / public void setDefaultEditLanguage(int value)

Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.

It may display/render different layouts for text paragraph when different edit languages is set. Default is #Error Cref: !:DefaultEditLanguage.Auto.

public int getFontEncoding() / public void setFontEncoding(int value)

Gets or sets embedded font encoding in pdf. The value of the property is PdfFontEncoding integer constant.

Default value is PdfFontEncoding.IDENTITY

public int getSaveFormat()

Gets the save file format. The value of the property is SaveFormat integer constant.

public boolean getClearData() / public void setClearData(boolean value)

Make the workbook empty after saving the file.

public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)

The cached file folder is used to store some large data.

public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

The default value is false.

public boolean getMergeAreas() / public void setMergeAreas(boolean value)

Indicates whether merge the areas of conditional formatting and validation before saving the file.

The default value is false.

public boolean getCreateDirectory() / public void setCreateDirectory(boolean value)

If true and the directory does not exist, the directory will be automatically created before saving the file.

The default value is false.

public boolean getSortNames() / public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

public boolean getSortExternalNames() / public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

public java.lang.String getPdfExportImagesFolder() / public void setPdfExportImagesFolder(java.lang.String value)

The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.

public boolean getEnableHTTPCompression() / public void setEnableHTTPCompression(boolean value)

Indicates if http compression is to be used in user's IIS.

Please specify this property to true if http compression is used.

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)

Gets or sets warning callback.

public boolean getUpdateSmartArt() / public void setUpdateSmartArt(boolean value)

Indicates whether updating smart art setting. The default value is false.

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

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.

Parameters:

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

jpegQuality - 0 - 100% JPEG quality.

Example:

//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);