XmlSaveOptions

XmlSaveOptions class

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

class XmlSaveOptions extends SaveOptions;

Constructors

Name	Description
constructor()	Creates options for saving xml file.
constructor(SaveOptions)	Constructs from a parent object convertible to this.

Methods

Method	Description
getSheetIndexes()	Represents the indexes of exported sheets.
setSheetIndexes(number[])	Represents the indexes of exported sheets.
getExportArea()	Gets or sets the exporting range.
setExportArea(CellArea)	Gets or sets the exporting range.
getHasHeaderRow()	Indicates whether the range contains header row.
setHasHeaderRow(boolean)	Indicates whether the range contains header row.
getXmlMapName()	Indicates whether exporting xml map in the file.
setXmlMapName(string)	Indicates whether exporting xml map in the file.
getSheetNameAsElementName()	Indicates whether exporting sheet’s name as the name of the element.
setSheetNameAsElementName(boolean)	Indicates whether exporting sheet’s name as the name of the element.
getDataAsAttribute()	Indicates whether exporting data as attributes of element.
setDataAsAttribute(boolean)	Indicates whether exporting data as attributes of element.
getSaveFormat()	Gets the save file format.
getClearData()	Make the workbook empty after saving the file.
setClearData(boolean)	Make the workbook empty after saving the file.
getCachedFileFolder()	The cached file folder is used to store some large data.
setCachedFileFolder(string)	The cached file folder is used to store some large data.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
setValidateMergedAreas(boolean)	Indicates whether validate merged cells before saving the file.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeAreas(boolean)	Indicates whether merge the areas of conditional formatting and validation before saving the file.
getCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateDirectory(boolean)	If true and the directory does not exist, the directory will be automatically created before saving the file.
getSortNames()	Indicates whether sorting defined names before saving file.
setSortNames(boolean)	Indicates whether sorting defined names before saving file.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
setSortExternalNames(boolean)	Indicates whether sorting external defined names before saving file.
getRefreshChartCache()	Indicates whether refreshing chart cache data
setRefreshChartCache(boolean)	Indicates whether refreshing chart cache data
setWarningCallback(IWarningCallback)	Gets or sets warning callback.
getWarningCallback()	Gets or sets warning callback.
getUpdateSmartArt()	Indicates whether updating smart art setting. The default value is false.
setUpdateSmartArt(boolean)	Indicates whether updating smart art setting. The default value is false.

constructor()

Creates options for saving xml file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

Parameter	Type	Description
obj	SaveOptions	The parent object.

getSheetIndexes()

Represents the indexes of exported sheets.

getSheetIndexes() : number[];

Returns

number[]

setSheetIndexes(number[])

Represents the indexes of exported sheets.

setSheetIndexes(value: number[]) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

getExportArea()

Gets or sets the exporting range.

getExportArea() : CellArea;

Returns

CellArea

setExportArea(CellArea)

Gets or sets the exporting range.

setExportArea(value: CellArea) : void;

Parameters:

Parameter	Type	Description
value	CellArea	The value to set.

getHasHeaderRow()

Indicates whether the range contains header row.

getHasHeaderRow() : boolean;

setHasHeaderRow(boolean)

Indicates whether the range contains header row.

setHasHeaderRow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getXmlMapName()

Indicates whether exporting xml map in the file.

getXmlMapName() : string;

setXmlMapName(string)

Indicates whether exporting xml map in the file.

setXmlMapName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getSheetNameAsElementName()

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

getSheetNameAsElementName() : boolean;

setSheetNameAsElementName(boolean)

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

setSheetNameAsElementName(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getDataAsAttribute()

Indicates whether exporting data as attributes of element.

getDataAsAttribute() : boolean;

setDataAsAttribute(boolean)

Indicates whether exporting data as attributes of element.

setDataAsAttribute(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSaveFormat()

Gets the save file format.

getSaveFormat() : SaveFormat;

Returns

SaveFormat

getClearData()

Make the workbook empty after saving the file.

getClearData() : boolean;

setClearData(boolean)

Make the workbook empty after saving the file.

setClearData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCachedFileFolder()

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

getCachedFileFolder() : string;

setCachedFileFolder(string)

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

setCachedFileFolder(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

getValidateMergedAreas() : boolean;

Remarks

The default value is false.

setValidateMergedAreas(boolean)

Indicates whether validate merged cells before saving the file.

setValidateMergedAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getMergeAreas()

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

getMergeAreas() : boolean;

Remarks

The default value is false.

setMergeAreas(boolean)

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

setMergeAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getCreateDirectory()

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

getCreateDirectory() : boolean;

Remarks

The default value is false.

setCreateDirectory(boolean)

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

setCreateDirectory(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getSortNames()

Indicates whether sorting defined names before saving file.

getSortNames() : boolean;

setSortNames(boolean)

Indicates whether sorting defined names before saving file.

setSortNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSortExternalNames()

Indicates whether sorting external defined names before saving file.

getSortExternalNames() : boolean;

setSortExternalNames(boolean)

Indicates whether sorting external defined names before saving file.

setSortExternalNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshChartCache()

Indicates whether refreshing chart cache data

getRefreshChartCache() : boolean;

setRefreshChartCache(boolean)

Indicates whether refreshing chart cache data

setRefreshChartCache(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

setWarningCallback(IWarningCallback)

Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

Parameter	Type	Description
value	IWarningCallback	The value to set.

getWarningCallback()

Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getUpdateSmartArt()

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

getUpdateSmartArt() : boolean;

Remarks

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

setUpdateSmartArt(boolean)

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

setUpdateSmartArt(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

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