aspose.cells

Class JsonSaveOptions

Represents the options of saving the workbook as a json file.

Constructor Summary
JsonSaveOptions()
Creates options for saving json file.
 
Property Getters/Setters Summary
functiongetAlwaysExportAsJsonObject()
function
           Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
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.
functiongetExportArea()
function
           Gets or sets the exporting range.
functiongetExportAsString()
function
           Exports the string value of the cells to json.
functiongetExportEmptyCells()
function
           Indicates whether exporting empty cells as null.
functiongetExportHyperlinkType()
function
           Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constant.
functiongetExportNestedStructure()
function
           Exported as parent-child hierarchy Json structure.
functionhasHeaderRow()
function
           Indicates whether the range contains header row.
functiongetIndent()
function
setIndent(value)
           Indicates the indent.
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.
functiongetSkipEmptyRows()
function
           Indicates whether skipping emtpy rows.
functiongetSortExternalNames()
function
           Indicates whether sorting external defined names before saving file.
functiongetSortNames()
function
           Indicates whether sorting defined names before saving file.
functiongetToExcelStruct()
function
           Indicates whether converting to json struct of the Excel 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.
 

    • Constructor Detail

      • JsonSaveOptions

        function JsonSaveOptions()
        Creates options for saving json file.
    • Property Getters/Setters Detail

      • getExportHyperlinkType/setExportHyperlinkType : Number 

        function getExportHyperlinkType() / function setExportHyperlinkType(value)
        
        Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constant. The default value is JsonExportHyperlinkType.DISPLAY_STRING;
      • getSkipEmptyRows/setSkipEmptyRows : boolean 

        function getSkipEmptyRows() / function setSkipEmptyRows(value)
        
        Indicates whether skipping emtpy rows.
      • 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.
      • getExportAsString/setExportAsString : boolean 

        function getExportAsString() / function setExportAsString(value)
        
        Exports the string value of the cells to json.
      • getIndent/setIndent : String 

        function getIndent() / function setIndent(value)
        
        Indicates the indent. If the indent is null or empty, the exported json is not formatted.
      • getExportNestedStructure/setExportNestedStructure : boolean 

        function getExportNestedStructure() / function setExportNestedStructure(value)
        
        Exported as parent-child hierarchy Json structure.
      • getExportEmptyCells/setExportEmptyCells : boolean 

        function getExportEmptyCells() / function setExportEmptyCells(value)
        
        Indicates whether exporting empty cells as null.
      • getAlwaysExportAsJsonObject/setAlwaysExportAsJsonObject : boolean 

        function getAlwaysExportAsJsonObject() / function setAlwaysExportAsJsonObject(value)
        
        Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
      • getToExcelStruct/setToExcelStruct : boolean 

        function getToExcelStruct() / function setToExcelStruct(value)
        
        Indicates whether converting to json struct of the Excel file. Only for converting range to JSON.
      • 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.