asposecells.api

asposecells.api

Class XlsSaveOptions

Represents the save options for the Excel 97-2003 file format: xls and xlt.

Constructor Summary
XlsSaveOptions()
Creates options for saving Excel 97-2003 xls file.
XlsSaveOptions(saveFormat)
Creates options for saving Excel 97-2003 xls/xlt file.
 
Property Getters/Setters Summary
methodgetCachedFileFolder()
method
setCachedFileFolder(value)
           The cached file folder is used to store some large data.
methodgetClearData()
method
setClearData(value)
           Make the workbook empty after saving the file.
methodgetCreateDirectory()
method
setCreateDirectory(value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodisTemplate()
method
setTemplate(value)
           Indicates whether saving a template file.
methodgetLightCellsDataProvider()
method
setLightCellsDataProvider(value)
           The data provider for saving workbook in light mode.
methodgetMatchColor()
method
setMatchColor(value)
           Indicates whether matching font color because there are 56 colors in the standard color palette.
methodgetMergeAreas()
method
setMergeAreas(value)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetRefreshChartCache()
method
setRefreshChartCache(value)
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSortExternalNames()
method
setSortExternalNames(value)
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
setSortNames(value)
           Indicates whether sorting defined names before saving file.
methodgetUpdateSmartArt()
method
setUpdateSmartArt(value)
           Indicates whether updating smart art setting. The default value is false.
methodgetValidateMergedAreas()
method
setValidateMergedAreas(value)
           Indicates whether validate merged cells before saving the file.
 

    • Constructor Detail

      • XlsSaveOptions

        XlsSaveOptions()
        Creates options for saving Excel 97-2003 xls file.

    • Property Getters/Setters Detail

      • getLightCellsDataProvider/setLightCellsDataProvider : LightCellsDataProvider 

        LightCellsDataProvider getLightCellsDataProvider() / setLightCellsDataProvider(value)
        The data provider for saving workbook in light mode.

      • isTemplate/setTemplate : boolean 

        boolean isTemplate() / setTemplate(value)
        Indicates whether saving a template file. NOTE: This member is now obsolete. Instead, please create XlsSaveOptions with corresponding save format(xlt for true and xls for false). This method will be removed 12 months later since August 2020. Aspose apologizes for any inconvenience you may have experienced.

      • getMatchColor/setMatchColor : boolean 

        boolean getMatchColor() / setMatchColor(value)
        Indicates whether matching font color because there are 56 colors in the standard color palette.

      • 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

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