ImageSaveOptions

Inheritance: java.lang.Object, com.aspose.cells.SaveOptions

public class ImageSaveOptions extends SaveOptions

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

Constructors

Constructor	Description
ImageSaveOptions()	Creates the options for saving image file.
ImageSaveOptions(int saveFormat)	Creates the options for saving image file.

Methods

Method	Description
equals(Object arg0)
getCachedFileFolder()	The cached file folder is used to store some large data.
getCheckExcelRestriction()	Whether check restriction of excel file when user modify cells related objects.
getClass()
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.
getEncryptDocumentProperties()	Indicates whether encrypt document properties when saving as .xls file.
getImageOrPrintOptions()	Additional image creation options.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file.
getRefreshChartCache()	Indicates whether refreshing chart cache data
getSaveFormat()	Gets the save file format.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
getSortNames()	Indicates whether sorting defined names before saving file.
getStreamProvider()	Gets the IStreamProvider for exporting objects.
getUpdateSmartArt()	Indicates whether updating smart art setting.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
getWarningCallback()	Gets warning callback.
hashCode()
notify()
notifyAll()
setCachedFileFolder(String value)	The cached file folder is used to store some large data.
setCheckExcelRestriction(boolean value)	Whether check restriction of excel file when user modify cells related objects.
setClearData(boolean value)	Make the workbook empty after saving the file.
setCreateDirectory(boolean value)	If true and the directory does not exist, the directory will be automatically created before saving the file.
setEncryptDocumentProperties(boolean value)	Indicates whether encrypt document properties when saving as .xls file.
setMergeAreas(boolean value)	Indicates whether merge the areas of conditional formatting and validation before saving the file.
setRefreshChartCache(boolean value)	Indicates whether refreshing chart cache data
setSortExternalNames(boolean value)	Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)	Indicates whether sorting defined names before saving file.
setStreamProvider(IStreamProvider value)	Sets the IStreamProvider for exporting objects.
setUpdateSmartArt(boolean value)	Indicates whether updating smart art setting.
setValidateMergedAreas(boolean value)	Indicates whether validate merged cells before saving the file.
setWarningCallback(IWarningCallback value)	Sets warning callback.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

ImageSaveOptions()

public ImageSaveOptions()

Creates the options for saving image file.

Remarks

The default type is Tiff.

ImageSaveOptions(int saveFormat)

public ImageSaveOptions(int saveFormat)

Creates the options for saving image file.

Parameters:

Parameter	Type	Description
saveFormat	int	SaveFormat. The file format. It should be one of following types: SaveFormat.TIFF, SaveFormat.SVG, SaveFormat.BMP, SaveFormat.PNG, SaveFormat.JPG, SaveFormat.EMF or SaveFormat.GIF, otherwise the saved format will be set as SaveFormat.TIFF automatically.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getCachedFileFolder()

public String getCachedFileFolder()

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

Returns: java.lang.String

getCheckExcelRestriction()

public boolean getCheckExcelRestriction()

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClearData()

public boolean getClearData()

Make the workbook empty after saving the file.

Returns: boolean

getCreateDirectory()

public boolean getCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Returns: boolean

getEncryptDocumentProperties()

public boolean getEncryptDocumentProperties()

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Returns: boolean

getImageOrPrintOptions()

public ImageOrPrintOptions getImageOrPrintOptions()

Additional image creation options.

Remarks

For advanced usage, please use WorkbookRender or SheetRender.

Returns: ImageOrPrintOptions

getMergeAreas()

public boolean getMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Returns: boolean

getRefreshChartCache()

public boolean getRefreshChartCache()

Indicates whether refreshing chart cache data

Returns: boolean

getSaveFormat()

public int getSaveFormat()

Gets the save file format.

See SaveFormat.

Returns: int

getSortExternalNames()

public boolean getSortExternalNames()

Indicates whether sorting external defined names before saving file.

Returns: boolean

getSortNames()

public boolean getSortNames()

Indicates whether sorting defined names before saving file.

Returns: boolean

getStreamProvider()

public IStreamProvider getStreamProvider()

Gets the IStreamProvider for exporting objects.

Remarks

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.

Returns: IStreamProvider

getUpdateSmartArt()

public boolean getUpdateSmartArt()

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Returns: boolean

getValidateMergedAreas()

public boolean getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Returns: boolean

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCachedFileFolder(String value)

public void setCachedFileFolder(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setCheckExcelRestriction(boolean value)

public void setCheckExcelRestriction(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setClearData(boolean value)

public void setClearData(boolean value)

Make the workbook empty after saving the file.

Parameters:

Parameter	Type	Description
value	boolean

setCreateDirectory(boolean value)

public void setCreateDirectory(boolean value)

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setEncryptDocumentProperties(boolean value)

public void setEncryptDocumentProperties(boolean value)

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Parameters:

Parameter	Type	Description
value	boolean

setMergeAreas(boolean value)

public void setMergeAreas(boolean value)

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

Parameters:

Parameter	Type	Description
value	boolean

setSortExternalNames(boolean value)

public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setSortNames(boolean value)

public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setStreamProvider(IStreamProvider value)

public void setStreamProvider(IStreamProvider value)

Sets the IStreamProvider for exporting objects.

Remarks

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.

Parameters:

Parameter	Type	Description
value	IStreamProvider

setUpdateSmartArt(boolean value)

public void setUpdateSmartArt(boolean value)

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Parameters:

Parameter	Type	Description
value	boolean

setValidateMergedAreas(boolean value)

public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

Parameter	Type	Description
value	IWarningCallback

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int