asposecells.api

Class XpsSaveOptions

Represents the additional options when saving the file as the Xps.

Constructor Summary
XpsSaveOptions()
Creates options for saving xps file.
XpsSaveOptions(saveFormat)
Creates options for saving xps file.
 
Property Getters/Setters Summary
methodgetCachedFileFolder()
method
           The cached file folder is used to store some large data.
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.
methodgetEnableHTTPCompression()
method
           Indicates if http compression is to be used in user's IIS.
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.
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.
methodgetPdfExportImagesFolder()
method
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
methodgetRefreshChartCache()
method
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSortExternalNames()
method
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
methodgetUpdateSmartArt()
method
           Indicates whether updating smart art setting. The default value is false.
methodgetValidateMergedAreas()
method
           Indicates whether validate merged cells before saving the file.
 

    • Constructor Detail

      • XpsSaveOptions

        XpsSaveOptions()
        Creates options for saving xps file.
      • XpsSaveOptions

        XpsSaveOptions(saveFormat)
        Creates options for saving xps file.
        Parameters:
        saveFormat: int - A SaveFormat value. The save format, it must be xps format.
    • Property Getters/Setters Detail

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