asposecells.api
Class PdfSaveOptions

Represents the options for saving pdf file.

Constructor Summary
PdfSaveOptions()
           Creates the options for saving pdf file.
PdfSaveOptions(saveFormat)
           Creates the options for saving pdf file.
 
Property Getters/Setters Summary
methodgetAllColumnsInOnePagePerSheet()
methodsetAllColumnsInOnePagePerSheet(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.
methodgetBookmark()
methodsetBookmark(value)
           Gets and sets the PdfBookmarkEntry object.
methodgetCachedFileFolder()
methodsetCachedFileFolder(value)
           The cached file folder is used to store some large data.
methodgetCalculateFormula()
methodsetCalculateFormula(value)
           Indicates whether calculate formulas before saving pdf file.
methodgetCheckFontCompatibility()
methodsetCheckFontCompatibility(value)
           Indicates whether check font compatibility for every character in text.
methodgetCheckWorkbookDefaultFont()
methodsetCheckWorkbookDefaultFont(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.
methodgetClearData()
methodsetClearData(value)
           Make the workbook empty after saving the file.
methodgetCompliance()
methodsetCompliance(value)
           Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.
methodgetCreateDirectory()
methodsetCreateDirectory(value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetCreatedTime()
methodsetCreatedTime(value)
           Gets and sets the time of generating the pdf document.
methodgetCustomPropertiesExport()
methodsetCustomPropertiesExport(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.
methodgetDefaultFont()
methodsetDefaultFont(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.
methodgetDrawObjectEventHandler()
methodsetDrawObjectEventHandler(value)
           Implements this interface to get DrawObject and Bound when rendering.
methodgetEmbedStandardWindowsFonts()
methodsetEmbedStandardWindowsFonts(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.
methodgetEmfRenderSetting()
methodsetEmfRenderSetting(value)
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
methodgetEnableHTTPCompression()
methodsetEnableHTTPCompression(value)
           Indicates if http compression is to be used in user's IIS.
methodgetExportDocumentStructure()
methodsetExportDocumentStructure(value)
           Gets or sets a value determining whether or not to export document structure.
methodgetGridlineType()
methodsetGridlineType(value)
           Gets or sets gridline type. The value of the property is GridlineType integer constant.
methodgetIgnoreError()
methodsetIgnoreError(value)
           Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
methodgetImageType()
methodsetImageType(value)
           Represents the image type when converting the chart and shape .
methodisFontSubstitutionCharGranularity()
methodsetFontSubstitutionCharGranularity(value)
           Indicates whether only substitute the font of character when the cell font is not compatibility for it.
methodgetMergeAreas()
methodsetMergeAreas(value)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetOnePagePerSheet()
methodsetOnePagePerSheet(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.
methodgetOptimizationType()
methodsetOptimizationType(value)
           Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.
methodgetOutputBlankPageWhenNothingToPrint()
methodsetOutputBlankPageWhenNothingToPrint(value)
           Indicates whether to output a blank page when there is nothing to print.
methodgetPageCount()
methodsetPageCount(value)
           Gets or sets the number of pages to save.
methodgetPageIndex()
methodsetPageIndex(value)
           Gets or sets the 0-based index of the first page to save.
methodgetPageSavingCallback()
methodsetPageSavingCallback(value)
           Control/Indicate progress of page saving process.
methodgetPdfCompression()
methodsetPdfCompression(value)
           Indcate the compression algorithm The value of the property is PdfCompressionCore integer constant.
methodgetPdfExportImagesFolder()
methodsetPdfExportImagesFolder(value)
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
methodgetPrintingPageType()
methodsetPrintingPageType(value)
           Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
methodgetRefreshChartCache()
methodsetRefreshChartCache(value)
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
           Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSecurityOptions()
methodsetSecurityOptions(value)
           Set this options, when security is need in xls2pdf result.
methodgetSortNames()
methodsetSortNames(value)
           Indicates whether sorting defined names before saving file.
methodgetStreamProvider()
methodsetStreamProvider(value)
           Gets or sets the IStreamProvider for exporting objects.
methodgetTextCrossType()
methodsetTextCrossType(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.
methodgetValidateMergedAreas()
methodsetValidateMergedAreas(value)
           Indicates whether validate merged cells before saving the file.
 
Method Summary
methodsetImageResample(desiredPPI, 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

PdfSaveOptions()
Creates the options for saving pdf file.

PdfSaveOptions

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

Property Getters/Setters Detail

getPrintingPageType/setPrintingPageType : int 

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

getEmbedStandardWindowsFonts/setEmbedStandardWindowsFonts : boolean 

boolean getEmbedStandardWindowsFonts() / setEmbedStandardWindowsFonts(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 : PdfBookmarkEntry 

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

getCompliance/setCompliance : int 

int getCompliance() / setCompliance(value)
Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.

getDefaultFont/setDefaultFont : String 

String getDefaultFont() / setDefaultFont(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.

getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont : boolean 

boolean getCheckWorkbookDefaultFont() / setCheckWorkbookDefaultFont(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.

getSecurityOptions/setSecurityOptions : PdfSecurityOptions 

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

getOnePagePerSheet/setOnePagePerSheet : boolean 

boolean getOnePagePerSheet() / setOnePagePerSheet(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 : boolean 

boolean getAllColumnsInOnePagePerSheet() / setAllColumnsInOnePagePerSheet(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 : ImageFormat 

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

getCalculateFormula/setCalculateFormula : boolean 

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

getPdfCompression/setPdfCompression : int 

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

getStreamProvider/setStreamProvider : IStreamProvider 

IStreamProvider getStreamProvider() / setStreamProvider(value)
Gets or sets the IStreamProvider for exporting objects. NOTE: This member is now obsolete. Instead, please use Border property. This property will be removed 12 months later since January 2018. Aspose apologizes for any inconvenience you may have experienced.

getCheckFontCompatibility/setCheckFontCompatibility : boolean 

boolean getCheckFontCompatibility() / setCheckFontCompatibility(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 : int 

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

getPageCount/setPageCount : int 

int getPageCount() / setPageCount(value)
Gets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered..

getCreatedTime/setCreatedTime : DateTime 

DateTime getCreatedTime() / setCreatedTime(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 : int 

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

isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean 

boolean isFontSubstitutionCharGranularity() / setFontSubstitutionCharGranularity(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.

getGridlineType/setGridlineType : int 

int getGridlineType() / setGridlineType(value)
Gets or sets gridline type. The value of the property is GridlineType integer constant. Default is Dotted type.

getTextCrossType/setTextCrossType : int 

int getTextCrossType() / setTextCrossType(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.

getIgnoreError/setIgnoreError : boolean 

boolean getIgnoreError() / setIgnoreError(value)
Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint : boolean 

boolean getOutputBlankPageWhenNothingToPrint() / setOutputBlankPageWhenNothingToPrint(value)
Indicates whether to output a blank page when there is nothing to print. Default is true.

getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler 

DrawObjectEventHandler getDrawObjectEventHandler() / setDrawObjectEventHandler(value)
Implements this interface to get DrawObject and Bound when rendering.

getCustomPropertiesExport/setCustomPropertiesExport : int 

int getCustomPropertiesExport() / setCustomPropertiesExport(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.

getExportDocumentStructure/setExportDocumentStructure : boolean 

boolean getExportDocumentStructure() / setExportDocumentStructure(value)
Gets or sets a value determining whether or not to export document structure.

getPageSavingCallback/setPageSavingCallback : IPageSavingCallback 

IPageSavingCallback getPageSavingCallback() / setPageSavingCallback(value)
Control/Indicate progress of page saving process.

getEmfRenderSetting/setEmfRenderSetting : int 

int getEmfRenderSetting() / setEmfRenderSetting(value)
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.

getSaveFormat : int 

int getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.

getClearData/setClearData : boolean 

boolean getClearData() / setClearData(value)
Make the workbook empty after saving the file.

getCachedFileFolder/setCachedFileFolder : String 

String getCachedFileFolder() / setCachedFileFolder(value)
The cached file folder is used to store some large data.

getValidateMergedAreas/setValidateMergedAreas : boolean 

boolean getValidateMergedAreas() / setValidateMergedAreas(value)
Indicates whether validate merged cells before saving the file. The default value is false.

getMergeAreas/setMergeAreas : boolean 

boolean getMergeAreas() / setMergeAreas(value)
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

getCreateDirectory/setCreateDirectory : boolean 

boolean getCreateDirectory() / setCreateDirectory(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 : boolean 

boolean getSortNames() / setSortNames(value)
Indicates whether sorting defined names before saving file.

getRefreshChartCache/setRefreshChartCache : boolean 

boolean getRefreshChartCache() / setRefreshChartCache(value)
Indicates whether refreshing chart cache data

getPdfExportImagesFolder/setPdfExportImagesFolder : String 

String getPdfExportImagesFolder() / setPdfExportImagesFolder(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 : boolean 

boolean getEnableHTTPCompression() / setEnableHTTPCompression(value)
Indicates if http compression is to be used in user's IIS. Please specify this property to true if http compression is used.

Method Detail

setImageResample

 setImageResample(desiredPPI, 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: int - Desired pixels per inch. 220 high quality. 150 screen quality. 96 email quality.
jpegQuality: int - 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.