asposecells.api

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
methodgetAlwaysExportAsJsonObject()
method
           Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
methodgetCachedFileFolder()
method
           The cached file folder is used to store some large data.
methodgetClearData()
method
           Make the workbook empty after saving the file.
methodgetCreateDirectory()
method
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetExportArea()
method
           Gets or sets the exporting range.
methodgetExportAsString()
method
           Exports the string value of the cells to json.
methodgetExportEmptyCells()
method
           Indicates whether exporting empty cells as null.
methodgetExportHyperlinkType()
method
           Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constant.
methodgetExportNestedStructure()
method
           Exported as parent-child hierarchy Json structure.
methodhasHeaderRow()
method
           Indicates whether the range contains header row.
methodgetIndent()
method
setIndent(value)
           Indicates the indent.
methodgetMergeAreas()
method
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetRefreshChartCache()
method
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSheetIndexes()
method
           Represents the indexes of exported sheets.
methodgetSkipEmptyRows()
method
           Indicates whether skipping emtpy rows.
methodgetSortExternalNames()
method
           Indicates whether sorting external defined names before saving file.
methodgetSortNames()
method
           Indicates whether sorting defined names before saving file.
methodgetToExcelStruct()
method
           Indicates whether converting to json struct of the Excel file.
methodgetUpdateSmartArt()
method
           Indicates whether updating smart art setting. The default value is false.
methodgetValidateMergedAreas()
method
           Indicates whether validate merged cells before saving the file.
methodgetWarningCallback()
method
           Gets or sets warning callback.
 

    • Constructor Detail

      • JsonSaveOptions

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

      • getSkipEmptyRows/setSkipEmptyRows : boolean 

        boolean getSkipEmptyRows() / setSkipEmptyRows(value)
        
        Indicates whether skipping emtpy rows.
      • getSheetIndexes/setSheetIndexes : int[] 

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

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

        boolean hasHeaderRow() / setHasHeaderRow(value)
        
        Indicates whether the range contains header row.
      • getExportAsString/setExportAsString : boolean 

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

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

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

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

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

        boolean getToExcelStruct() / setToExcelStruct(value)
        
        Indicates whether converting to json struct of the Excel file. Only for converting range to JSON.
      • getSaveFormat : int 

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

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

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

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

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

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

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

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

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

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

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