XmlSaveOptions

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

public class XmlSaveOptions extends SaveOptions

Represents the options of saving the workbook as an xml file.

Constructors

Constructor	Description
XmlSaveOptions()	Creates options for saving xml 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.
getDataAsAttribute()	Indicates whether exporting data as attributes of element.
getEncryptDocumentProperties()	Indicates whether encrypt document properties when saving as .xls file.
getExportArea()	Gets the exporting range.
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.
getSheetIndexes()	Represents the indexes of exported sheets.
getSheetNameAsElementName()	Indicates whether exporting sheet’s name as the name of the element.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
getSortNames()	Indicates whether sorting defined names before saving file.
getUpdateSmartArt()	Indicates whether updating smart art setting.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
getWarningCallback()	Gets warning callback.
getXmlMapName()	Indicates whether exporting xml map in the file.
hasHeaderRow()	Indicates whether the range contains header row.
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.
setDataAsAttribute(boolean value)	Indicates whether exporting data as attributes of element.
setEncryptDocumentProperties(boolean value)	Indicates whether encrypt document properties when saving as .xls file.
setExportArea(CellArea value)	Sets the exporting range.
setHasHeaderRow(boolean value)	Indicates whether the range contains header row.
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
setSheetIndexes(int[] value)	Represents the indexes of exported sheets.
setSheetNameAsElementName(boolean value)	Indicates whether exporting sheet’s name as the name of the element.
setSortExternalNames(boolean value)	Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)	Indicates whether sorting defined names before saving file.
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.
setXmlMapName(String value)	Indicates whether exporting xml map in the file.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

XmlSaveOptions()

public XmlSaveOptions()

Creates options for saving xml file.

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

getDataAsAttribute()

public boolean getDataAsAttribute()

Indicates whether exporting data as attributes of element.

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

getExportArea()

public CellArea getExportArea()

Gets the exporting range.

Returns: CellArea

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

getSheetIndexes()

public int[] getSheetIndexes()

Represents the indexes of exported sheets.

Returns: int[]

getSheetNameAsElementName()

public boolean getSheetNameAsElementName()

Indicates whether exporting sheet’s name as the name of the element.

Returns: boolean

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

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

getXmlMapName()

public String getXmlMapName()

Indicates whether exporting xml map in the file.

Returns: java.lang.String

hasHeaderRow()

public boolean hasHeaderRow()

Indicates whether the range contains header row.

Returns: boolean

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)

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.

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

setDataAsAttribute(boolean value)

public void setDataAsAttribute(boolean value)

Indicates whether exporting data as attributes of element.

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

setExportArea(CellArea value)

public void setExportArea(CellArea value)

Sets the exporting range.

Parameters:

Parameter	Type	Description
value	CellArea

setHasHeaderRow(boolean value)

public void setHasHeaderRow(boolean value)

Indicates whether the range contains header row.

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

setSheetIndexes(int[] value)

public void setSheetIndexes(int[] value)

Represents the indexes of exported sheets.

Parameters:

Parameter	Type	Description
value	int[]

setSheetNameAsElementName(boolean value)

public void setSheetNameAsElementName(boolean value)

Indicates whether exporting sheet’s name as the name of the element.

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

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

setXmlMapName(String value)

public void setXmlMapName(String value)

Indicates whether exporting xml map in the file.

Parameters:

Parameter	Type	Description
value	java.lang.String

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