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()
method
           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()
method
           Gets and sets the PdfBookmarkEntry object.
methodgetCachedFileFolder()
method
           The cached file folder is used to store some large data.
methodgetCalculateFormula()
method
           Indicates whether calculate formulas before saving pdf file.
methodgetCheckFontCompatibility()
method
           Indicates whether check font compatibility for every character in text.
methodgetCheckWorkbookDefaultFont()
method
           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()
method
           Make the workbook empty after saving the file.
methodgetCompliance()
method
           Workbook converts to pdf will according to PdfCompliance in this property. The value of the property is PdfCompliance integer constant.
methodgetCreateDirectory()
method
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetCreatedTime()
method
           Gets and sets the time of generating the pdf document.
methodgetCustomPropertiesExport()
method
           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.
methodgetDefaultEditLanguage()
method
           Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.
methodgetDefaultFont()
method
           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.
methodgetDisplayDocTitle()
method
           Indicate whether the window's title bar should display the document title.
methodgetDrawObjectEventHandler()
method
           Implements this interface to get DrawObject and Bound when rendering.
methodgetEmbedStandardWindowsFonts()
method
           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.
methodgetEmfRenderSetting()
method
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
methodgetEnableHTTPCompression()
method
           Indicates if http compression is to be used in user's IIS.
methodgetExportDocumentStructure()
method
           Gets or sets a value determining whether or not to export document structure.
methodgetFontEncoding()
method
           Gets or sets embedded font encoding in pdf. The value of the property is PdfFontEncoding integer constant.
methodgetGridlineType()
method
           Gets or sets gridline type. The value of the property is GridlineType integer constant.
methodgetIgnoreError()
method
           Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
methodgetImageType()
method
           Represents the image type when converting the chart and shape .
methodisFontSubstitutionCharGranularity()
method
           Indicates whether only substitute the font of character when the cell font is not compatibility for it.
methodgetMergeAreas()
method
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetOnePagePerSheet()
method
           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()
method
           Gets and sets pdf optimization type. The value of the property is PdfOptimizationType integer constant.
methodgetOutputBlankPageWhenNothingToPrint()
method
           Indicates whether to output a blank page when there is nothing to print.
methodgetPageCount()
method
           Gets or sets the number of pages to save.
methodgetPageIndex()
method
           Gets or sets the 0-based index of the first page to save.
methodgetPageSavingCallback()
method
           Control/Indicate progress of page saving process.
methodgetPdfCompression()
method
           Indicate the compression algorithm The value of the property is PdfCompressionCore integer constant.
methodgetPdfExportImagesFolder()
method
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
methodgetPrintingPageType()
method
           Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
methodgetRefreshChartCache()
method
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSecurityOptions()
method
           Set this options, when security is need in xls2pdf result.
methodgetSortExternalNames()
method
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
methodgetStreamProvider()
method
           Gets or sets the IStreamProvider for exporting objects.
methodgetTextCrossType()
method
           Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.
methodgetUpdateSmartArt()
method
           Indicates whether updating smart art setting. The default value is false.
methodgetValidateMergedAreas()
method
           Indicates whether validate merged cells before saving the file.
 
Method Summary
methodsetImageResample(desiredPPI, 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.
 

    • Constructor Detail

      • PdfSaveOptions

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

        PdfSaveOptions(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: 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. Fonts are always embedded for PDF/A-1a, PDF/A-1b standard. Default is true.
      • 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)
        
        Indicate 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. Default value is PdfOptimizationType.STANDARD
      • 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. 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.
      • getDisplayDocTitle/setDisplayDocTitle : boolean 

        boolean getDisplayDocTitle() / setDisplayDocTitle(value)
        
        Indicate 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.
      • getDefaultEditLanguage/setDefaultEditLanguage : int 

        int getDefaultEditLanguage() / setDefaultEditLanguage(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.
      • getFontEncoding/setFontEncoding : int 

        int getFontEncoding() / setFontEncoding(value)
        
        Gets or sets embedded font encoding in pdf. The value of the property is PdfFontEncoding integer constant. Default value is PdfFontEncoding.IDENTITY
      • 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.
      • getSortExternalNames/setSortExternalNames : boolean 

        boolean getSortExternalNames() / setSortExternalNames(value)
        
        Indicates whether sorting external 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.
      • getUpdateSmartArt/setUpdateSmartArt : boolean 

        boolean getUpdateSmartArt() / setUpdateSmartArt(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.
    • Method Detail

      • setImageResample

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