com.aspose.cells
Class PdfSaveOptions

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

public class PdfSaveOptions 
extends SaveOptions

Represents the options for saving pdf file.

Constructor Summary
PdfSaveOptions()
           Creates the options for saving pdf file.
PdfSaveOptions(int saveFormat)
           Creates the options for saving pdf file.
 
Property Getters/Setters Summary
booleangetAllColumnsInOnePagePerSheet()
voidsetAllColumnsInOnePagePerSheet(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.
PdfBookmarkEntrygetBookmark()
voidsetBookmark(PdfBookmarkEntry value)
           Gets and sets the PdfBookmarkEntry object.
java.lang.StringgetCachedFileFolder()→ inherited from SaveOptions
voidsetCachedFileFolder(java.lang.String value)
           The cached file folder is used to store some large data.
booleangetCalculateFormula()
voidsetCalculateFormula(boolean value)
           Indicates whether calculate formulas before saving pdf file.
booleangetCheckFontCompatibility()
voidsetCheckFontCompatibility(boolean value)
           Indicates whether check font compatibility for every character in text.
booleangetClearData()→ inherited from SaveOptions
voidsetClearData(boolean value)
           Make the workbook empty after saving the file.
intgetCompliance()
voidsetCompliance(int value)
           Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.
booleangetCreateDirectory()→ inherited from SaveOptions
voidsetCreateDirectory(boolean value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
DateTimegetCreatedTime()
voidsetCreatedTime(DateTime value)
           Gets and sets the time of generating the pdf document.
java.lang.StringgetDefaultFont()
voidsetDefaultFont(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.
booleangetEmbedStandardWindowsFonts()
voidsetEmbedStandardWindowsFonts(boolean value)
           True to embed true type fonts. Affects only ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. PDFA1B must embeded font. Default is true.
booleangetEnableHTTPCompression()→ inherited from SaveOptions
voidsetEnableHTTPCompression(boolean value)
           Indicates if http compression is to be used in user's IIS.
ImageFormatgetImageType()
voidsetImageType(ImageFormat value)
           Represents the image type when converting the chart and shape .
booleanisFontSubstitutionCharGranularity()
voidsetFontSubstitutionCharGranularity(boolean value)
           Indicates whether only substitute the font of character when the cell font is not compatibility for it.
booleangetMergeAreas()→ inherited from SaveOptions
voidsetMergeAreas(boolean value)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
booleangetOnePagePerSheet()
voidsetOnePagePerSheet(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.
intgetOptimizationType()
voidsetOptimizationType(int value)
           Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.
intgetPageCount()
voidsetPageCount(int value)
           Gets or sets the number of pages to save.
intgetPageIndex()
voidsetPageIndex(int value)
           Gets or sets the 0-based index of the first page to save.
intgetPdfCompression()
voidsetPdfCompression(int value)
           Indcate the compression algorithm The value of the property is PdfCompressionCore integer constant.
java.lang.StringgetPdfExportImagesFolder()→ inherited from SaveOptions
voidsetPdfExportImagesFolder(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.
intgetPrintingPageType()
voidsetPrintingPageType(int value)
           Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
booleangetRefreshChartCache()→ inherited from SaveOptions
voidsetRefreshChartCache(boolean value)
           Indicates whether refreshing chart cache data
intgetSaveFormat()→ inherited from SaveOptions
           Gets the save file format. The value of the property is SaveFormat integer constant.
PdfSecurityOptionsgetSecurityOptions()
voidsetSecurityOptions(PdfSecurityOptions value)
           Set this options, when security is need in xls2pdf result.
booleangetSortNames()→ inherited from SaveOptions
voidsetSortNames(boolean value)
           Indicates whether sorting defined names before saving file.
booleangetValidateMergedAreas()→ inherited from SaveOptions
voidsetValidateMergedAreas(boolean value)
           Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback value)
           Gets or sets warning callback.
 
Method Summary
voidsetImageResample(int desiredPPI, int jpegQuality)
           Set 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.
 

Constructor Detail

PdfSaveOptions

public PdfSaveOptions()
Creates the options for saving pdf file.

PdfSaveOptions

public PdfSaveOptions(int saveFormat)
Creates the options for saving pdf file.
Parameters:
saveFormat - A SaveFormat value. The save format.It must be pdf.

Property Getters/Setters Detail

getPrintingPageType/setPrintingPageType

public int getPrintingPageType() / public void setPrintingPageType(int value)
Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.

getEmbedStandardWindowsFonts/setEmbedStandardWindowsFonts

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. PDFA1B must embeded font. Default is true.

getBookmark/setBookmark

public PdfBookmarkEntry getBookmark() / public void setBookmark(PdfBookmarkEntry value)
Gets and sets the PdfBookmarkEntry object.

getCompliance/setCompliance

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.

getDefaultFont/setDefaultFont

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.

getSecurityOptions/setSecurityOptions

public PdfSecurityOptions getSecurityOptions() / public void setSecurityOptions(PdfSecurityOptions value)
Set this options, when security is need in xls2pdf result.

getOnePagePerSheet/setOnePagePerSheet

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.

getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet

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.

getImageType/setImageType

public ImageFormat getImageType() / public void setImageType(ImageFormat value)
Represents the image type when converting the chart and shape .

getCalculateFormula/setCalculateFormula

public boolean getCalculateFormula() / public void setCalculateFormula(boolean value)
Indicates whether calculate formulas before saving pdf file. The default value is false.

getPdfCompression/setPdfCompression

public int getPdfCompression() / public void setPdfCompression(int value)
Indcate the compression algorithm The value of the property is PdfCompressionCore integer constant.

getCheckFontCompatibility/setCheckFontCompatibility

public boolean getCheckFontCompatibility() / public void setCheckFontCompatibility(boolean value)
Indicates whether 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;

getPageIndex/setPageIndex

public int getPageIndex() / public void setPageIndex(int value)
Gets or sets the 0-based index of the first page to save. Default is 0.

getPageCount/setPageCount

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

getCreatedTime/setCreatedTime

public DateTime getCreatedTime() / public void setCreatedTime(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.

getOptimizationType/setOptimizationType

public int getOptimizationType() / public void setOptimizationType(int value)
Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.

isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity

public boolean isFontSubstitutionCharGranularity() / public void setFontSubstitutionCharGranularity(boolean value)
Indicates whether 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.

getSaveFormat

→ inherited from SaveOptions
public int getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.

getClearData/setClearData

→ inherited from SaveOptions
public boolean getClearData() / public void setClearData(boolean value)
Make the workbook empty after saving the file.

getCachedFileFolder/setCachedFileFolder

→ inherited from SaveOptions
public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)
The cached file folder is used to store some large data.

getValidateMergedAreas/setValidateMergedAreas

→ inherited from SaveOptions
public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file. The default value is false.

getMergeAreas/setMergeAreas

→ inherited from SaveOptions
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.

getCreateDirectory/setCreateDirectory

→ inherited from SaveOptions
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.

getSortNames/setSortNames

→ inherited from SaveOptions
public boolean getSortNames() / public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.

getRefreshChartCache/setRefreshChartCache

→ inherited from SaveOptions
public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data

getPdfExportImagesFolder/setPdfExportImagesFolder

→ inherited from SaveOptions
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.

getEnableHTTPCompression/setEnableHTTPCompression

→ inherited from SaveOptions
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.

getWarningCallback/setWarningCallback

→ inherited from SaveOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Gets or sets warning callback.

Method Detail

setImageResample

public void setImageResample(int desiredPPI, int jpegQuality)
Set 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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.