asposecells.api

Class PaginatedSaveOptions

Represents the options for pagination.

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.
methodgetCachedFileFolder()
method
           The cached file folder is used to store some large data.
methodgetCheckFontCompatibility()
method
           Indicates whether to 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.
methodgetCreateDirectory()
method
           If true and the directory does not exist, the directory will be automatically created before saving the file.
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.
methodgetDrawObjectEventHandler()
method
           Implements this interface to get DrawObject and Bound when rendering.
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.
methodisFontSubstitutionCharGranularity()
method
           Indicates whether to 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.
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.
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.
methodgetSheetSet()
method
           Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
methodgetSortExternalNames()
method
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
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.
methodgetWarningCallback()
method
           Gets or sets warning callback.
 

    • Property Getters/Setters Detail

      • 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.
      • getCheckFontCompatibility/setCheckFontCompatibility : boolean 

        boolean getCheckFontCompatibility() / setCheckFontCompatibility(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;
      • isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean 

        boolean isFontSubstitutionCharGranularity() / setFontSubstitutionCharGranularity(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.
      • 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.
      • 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.
      • 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..
      • getPrintingPageType/setPrintingPageType : int 

        int getPrintingPageType() / setPrintingPageType(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.
      • 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.
      • 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 DefaultEditLanguage.AUTO.
      • getSheetSet/setSheetSet : SheetSet 

        SheetSet getSheetSet() / setSheetSet(value)
        
        Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
      • getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler 

        DrawObjectEventHandler getDrawObjectEventHandler() / setDrawObjectEventHandler(value)
        
        Implements this interface to get DrawObject and Bound when rendering.
      • getPageSavingCallback/setPageSavingCallback : IPageSavingCallback 

        IPageSavingCallback getPageSavingCallback() / setPageSavingCallback(value)
        
        Control/Indicate progress of page saving process.
      • 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
      • getWarningCallback/setWarningCallback : IWarningCallback 

        IWarningCallback getWarningCallback() / setWarningCallback(value)
        
        Gets or sets warning callback.
      • 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.