asposecells.api

Class OoxmlSaveOptions

Represents the options of saving office open xml file.

Constructor Summary
OoxmlSaveOptions()
Creates the options for saving office open xml file.
OoxmlSaveOptions(saveFormat)
Creates the options for saving office open xml 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.
methodgetCompressionType()
method
           Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.
methodgetCreateDirectory()
method
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetEmbedOoxmlAsOleObject()
method
           Indicates whether embedding Ooxml files of OleObject as ole object.
methodgetEnableHTTPCompression()
method
           Indicates if http compression is to be used in user's IIS.
methodgetEnableZip64()
method
           Always use ZIP64 extensions when writing zip archives, even when unnecessary.
methodgetExportCellName()
method
           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 true.
methodgetLightCellsDataProvider()
method
           The Data provider to provide cells data for saving workbook in light mode.
methodgetMergeAreas()
method
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
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.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
methodgetUpdateSmartArt()
method
           Indicates whether updating smart art setting. The default value is false.
methodgetUpdateZoom()
method
           Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
methodgetValidateMergedAreas()
method
           Indicates whether validate merged cells before saving the file.
 

    • Constructor Detail

      • OoxmlSaveOptions

        OoxmlSaveOptions()
        Creates the options for saving office open xml file.
      • OoxmlSaveOptions

        OoxmlSaveOptions(saveFormat)
        Creates the options for saving office open xml file.
        Parameters:
        saveFormat: int - A SaveFormat value. The file format. It must be xlsx,xltx,xlsm,xltm.
    • Property Getters/Setters Detail

      • getExportCellName/setExportCellName : boolean 

        boolean getExportCellName() / setExportCellName(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 true.
      • getLightCellsDataProvider/setLightCellsDataProvider : LightCellsDataProvider 

        LightCellsDataProvider getLightCellsDataProvider() / setLightCellsDataProvider(value)
        
        The Data provider to provide cells data for saving workbook in light mode.
      • getUpdateZoom/setUpdateZoom : boolean 

        boolean getUpdateZoom() / setUpdateZoom(value)
        
        Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled. The default value is false for permance.
      • getEnableZip64/setEnableZip64 : boolean 

        boolean getEnableZip64() / setEnableZip64(value)
        
        Always use ZIP64 extensions when writing zip archives, even when unnecessary.
      • 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.
      • getEmbedOoxmlAsOleObject/setEmbedOoxmlAsOleObject : boolean 

        boolean getEmbedOoxmlAsOleObject() / setEmbedOoxmlAsOleObject(value)
        
        Indicates whether embedding Ooxml files of OleObject as ole object. Only for OleObject.
      • getCompressionType/setCompressionType : int 

        int getCompressionType() / setCompressionType(value)
        
        Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.The default value is OoxmlCompressionType.Level2.
      • 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.