aspose.cells

Class XmlSaveOptions

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

Constructor Summary
XmlSaveOptions()
Creates options for saving xml file.
 
Property Getters/Setters Summary
functiongetCachedFileFolder()
function
           The cached file folder is used to store some large data.
functiongetClearData()
function
           Make the workbook empty after saving the file.
functiongetCreateDirectory()
function
           If true and the directory does not exist, the directory will be automatically created before saving the file.
functiongetDataAsAttribute()
function
           Indicates whether exporting data as attributes of element.
functiongetExportArea()
function
           Gets or sets the exporting range.
functionhasHeaderRow()
function
           Indicates whether the range contains header row.
functiongetMergeAreas()
function
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
functiongetRefreshChartCache()
function
           Indicates whether refreshing chart cache data
functiongetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
functiongetSheetIndexes()
function
           Represents the indexes of exported sheets.
functiongetSheetNameAsElementName()
function
           Indicates whether exporting sheet's name as the name of the element.
functiongetSortExternalNames()
function
           Indicates whether sorting external defined names before saving file.
functiongetSortNames()
function
           Indicates whether sorting defined names before saving file.
functiongetUpdateSmartArt()
function
           Indicates whether updating smart art setting. The default value is false.
functiongetValidateMergedAreas()
function
           Indicates whether validate merged cells before saving the file.
functiongetWarningCallback()
function
           Gets or sets warning callback.
functiongetXmlMapName()
function
           Indicates whether exporting xml map in the file.
 

    • Constructor Detail

      • XmlSaveOptions

        function XmlSaveOptions()
        Creates options for saving xml file.
    • Property Getters/Setters Detail

      • getSheetIndexes/setSheetIndexes : int[] 

        function getSheetIndexes() / function setSheetIndexes(value)
        
        Represents the indexes of exported sheets.
      • getExportArea/setExportArea : CellArea 

        function getExportArea() / function setExportArea(value)
        
        Gets or sets the exporting range.
      • hasHeaderRow/setHasHeaderRow : boolean 

        function hasHeaderRow() / function setHasHeaderRow(value)
        
        Indicates whether the range contains header row.
      • getXmlMapName/setXmlMapName : String 

        function getXmlMapName() / function setXmlMapName(value)
        
        Indicates whether exporting xml map in the file.
      • getSheetNameAsElementName/setSheetNameAsElementName : boolean 

        function getSheetNameAsElementName() / function setSheetNameAsElementName(value)
        
        Indicates whether exporting sheet's name as the name of the element.
      • getDataAsAttribute/setDataAsAttribute : boolean 

        function getDataAsAttribute() / function setDataAsAttribute(value)
        
        Indicates whether exporting data as attributes of element.
      • getSaveFormat : Number 

        function getSaveFormat()
        
        Gets the save file format. The value of the property is SaveFormat integer constant.
      • getClearData/setClearData : boolean 

        function getClearData() / function setClearData(value)
        
        Make the workbook empty after saving the file.
      • getCachedFileFolder/setCachedFileFolder : String 

        function getCachedFileFolder() / function setCachedFileFolder(value)
        
        The cached file folder is used to store some large data.
      • getValidateMergedAreas/setValidateMergedAreas : boolean 

        function getValidateMergedAreas() / function setValidateMergedAreas(value)
        
        Indicates whether validate merged cells before saving the file. The default value is false.
      • getMergeAreas/setMergeAreas : boolean 

        function getMergeAreas() / function setMergeAreas(value)
        
        Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
      • getCreateDirectory/setCreateDirectory : boolean 

        function getCreateDirectory() / function 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 

        function getSortNames() / function setSortNames(value)
        
        Indicates whether sorting defined names before saving file.
      • getSortExternalNames/setSortExternalNames : boolean 

        function getSortExternalNames() / function setSortExternalNames(value)
        
        Indicates whether sorting external defined names before saving file.
      • getRefreshChartCache/setRefreshChartCache : boolean 

        function getRefreshChartCache() / function setRefreshChartCache(value)
        
        Indicates whether refreshing chart cache data
      • getWarningCallback/setWarningCallback : IWarningCallback 

        function getWarningCallback() / function setWarningCallback(value)
        
        Gets or sets warning callback.
      • getUpdateSmartArt/setUpdateSmartArt : boolean 

        function getUpdateSmartArt() / function 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.