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
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.
com.aspose.cells.ImageFormatgetChartImageType()
voidsetChartImageType(com.aspose.cells.ImageFormat value)
           Indicate the chart imagetype when converting.
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.
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.
booleangetEnableHTTPCompression()→ inherited from SaveOptions
voidsetEnableHTTPCompression(boolean value)
           Indicates if http compression is to be used in user's IIS.
booleangetExpCellNameToXLSX()→ inherited from SaveOptions
voidsetExpCellNameToXLSX(boolean value)
           Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is false.
com.aspose.cells.ImageFormatgetImageType()
voidsetImageType(com.aspose.cells.ImageFormat value)
           Represents the image type when converting the chart and shape .
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.
PdfBookmarkEntrygetPdfBookmark()→ inherited from SaveOptions
voidsetPdfBookmark(PdfBookmarkEntry value)
           Gets and sets the PdfBookmarkEntry object.
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 areas before saving the file.
 

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.

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.

getImageType/setImageType

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

getChartImageType/setChartImageType

public com.aspose.cells.ImageFormat getChartImageType() / public void setChartImageType(com.aspose.cells.ImageFormat value)
Indicate the chart imagetype when converting. NOTE: This member is now obsolete. Instead, please use PdfSaveOptions.ImageType property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

getCalculateFormula/setCalculateFormula

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

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;

getSaveFormat

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

getExpCellNameToXLSX/setExpCellNameToXLSX

→ inherited from SaveOptions
public boolean getExpCellNameToXLSX() / public void setExpCellNameToXLSX(boolean value)
Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is false. NOTE: This member is now obsolete. Instead, please use OoxmlSaveOptions.ExportCellName property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

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

getPdfBookmark/setPdfBookmark

→ inherited from SaveOptions
public PdfBookmarkEntry getPdfBookmark() / public void setPdfBookmark(PdfBookmarkEntry value)
Gets and sets the PdfBookmarkEntry object. NOTE: This member is now obsolete. Instead, please use PdfSaveOptions.Bookmark property. This property will be removed 12 months later since July 2010. Aspose apologizes for any inconvenience you may have experienced.

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.

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