asposecells.api

Class ImageSaveOptions

Represents image save options. For advanced usage, please use WorkbookRender or SheetRender.

Constructor Summary
ImageSaveOptions()
Creates the options for saving image file.
ImageSaveOptions(saveFormat)
Creates the options for saving image 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.
methodgetImageOrPrintOptions()
Additional image creation options.
methodgetMergeAreas()
method
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
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.
methodgetStreamProvider()
method
           Gets or sets the IStreamProvider for exporting objects.
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

      • ImageSaveOptions

        ImageSaveOptions()
        Creates the options for saving image file. The default type is Tiff.
      • ImageSaveOptions

        ImageSaveOptions(saveFormat)
        Creates the options for saving image file.
        Parameters:
        saveFormat: int - A SaveFormat value. The file format. It must be Tiff , Svg, Bmp, Png, Jpg, Emf and Gif.
    • Property Getters/Setters Detail

      • getStreamProvider/setStreamProvider : IStreamProvider 

        IStreamProvider getStreamProvider() / setStreamProvider(value)
        
        Gets or sets the IStreamProvider for exporting objects. If saving as Tiff, this property is ignored. Otherwise, if more than one image should be saving, we will write other images by this. For advanced usage, please use WorkbookRender or SheetRender.
      • 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.