ImageSaveOptions

ImageSaveOptions class

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

new ImageSaveOptions()

Creates the options for saving image file. The default type is Tiff.

Methods

Name	Description
constructor_overload$1(saveFormat)	Creates the options for saving image file.
getCachedFileFolder()	The cached file folder is used to store some large data.
getCheckExcelRestriction()
getClearData()	Make the workbook empty after saving the file.
getCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file. The defaul
getEncryptDocumentProperties()
getImageOrPrintOptions()	Additional image creation options. For advanced usage, please use WorkbookRender or SheetRender.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is
getRefreshChartCache()	Indicates whether refreshing chart cache data
getSaveFormat()	Gets the save file format. The value of the property is SaveFormat integer constant.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
getSortNames()	Indicates whether sorting defined names before saving file.
getStreamProvider()	Gets or sets the IStreamProvider for exporting objects. If saving as Tiff, this property is ignored. Otherwise, if more
getUpdateSmartArt()	Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file. The default value is false.
setCachedFileFolder()	The cached file folder is used to store some large data.
setCheckExcelRestriction()
setClearData()	Make the workbook empty after saving the file.
setCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file. The defaul
setEncryptDocumentProperties()
setMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is
setRefreshChartCache()	Indicates whether refreshing chart cache data
setSortExternalNames()	Indicates whether sorting external defined names before saving file.
setSortNames()	Indicates whether sorting defined names before saving file.
setStreamProvider()	Gets or sets the IStreamProvider for exporting objects. If saving as Tiff, this property is ignored. Otherwise, if more
setUpdateSmartArt()	Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm
setValidateMergedAreas()	Indicates whether validate merged cells before saving the file. The default value is false.

constructor_overload$1(saveFormat)

Creates the options for saving image file.

Parameter	Type	Description
saveFormat	Number	SaveFormat

getCachedFileFolder()

The cached file folder is used to store some large data.

getCheckExcelRestriction()

getClearData()

Make the workbook empty after saving the file.

getCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

getEncryptDocumentProperties()

getImageOrPrintOptions()

Additional image creation options. For advanced usage, please use WorkbookRender or SheetRender.

getMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

getRefreshChartCache()

Indicates whether refreshing chart cache data

getSaveFormat()

Gets the save file format. The value of the property is SaveFormat integer constant.

getSortExternalNames()

Indicates whether sorting external defined names before saving file.

getSortNames()

Indicates whether sorting defined names before saving file.

getStreamProvider()

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.

getUpdateSmartArt()

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.

getValidateMergedAreas()

Indicates whether validate merged cells before saving the file. The default value is false.

setCachedFileFolder()

The cached file folder is used to store some large data.

setCheckExcelRestriction()

setClearData()

Make the workbook empty after saving the file.

setCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

setEncryptDocumentProperties()

setMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

setRefreshChartCache()

Indicates whether refreshing chart cache data

setSortExternalNames()

Indicates whether sorting external defined names before saving file.

setSortNames()

Indicates whether sorting defined names before saving file.

setStreamProvider()

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.

setUpdateSmartArt()

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.

setValidateMergedAreas()

Indicates whether validate merged cells before saving the file. The default value is false.