asposecells.api

Classes

Constants

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
`method`	`getAlwaysExportAsJsonObject()`
`method`	`setAlwaysExportAsJsonObject(value)`
	Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
`method`	`getCachedFileFolder()`
`method`	`setCachedFileFolder(value)`
	The cached file folder is used to store some large data.
`method`	`getClearData()`
`method`	`setClearData(value)`
	Make the workbook empty after saving the file.
`method`	`getCreateDirectory()`
`method`	`setCreateDirectory(value)`
	If true and the directory does not exist, the directory will be automatically created before saving the file.
`method`	`getExportArea()`
`method`	`setExportArea(value)`
	Gets or sets the exporting range.
`method`	`getExportAsString()`
`method`	`setExportAsString(value)`
	Exports the string value of the cells to json.
`method`	`getExportEmptyCells()`
`method`	`setExportEmptyCells(value)`
	Indicates whether exporting empty cells as null.
`method`	`getExportHyperlinkType()`
`method`	`setExportHyperlinkType(value)`
	Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constant.
`method`	`getExportNestedStructure()`
`method`	`setExportNestedStructure(value)`
	Exported as parent-child hierarchy Json structure.
`method`	`hasHeaderRow()`
`method`	`setHasHeaderRow(value)`
	Indicates whether the range contains header row.
`method`	`getIndent()`
`method`	`setIndent(value)`
	Indicates the indent.
`method`	`getMergeAreas()`
`method`	`setMergeAreas(value)`
	Indicates whether merge the areas of conditional formatting and validation before saving the file.
`method`	`getRefreshChartCache()`
`method`	`setRefreshChartCache(value)`
	Indicates whether refreshing chart cache data
`method`	`getSaveFormat()`
	Gets the save file format. The value of the property is SaveFormat integer constant.
`method`	`getSheetIndexes()`
`method`	`setSheetIndexes(value)`
	Represents the indexes of exported sheets.
`method`	`getSkipEmptyRows()`
`method`	`setSkipEmptyRows(value)`
	Indicates whether skipping emtpy rows.
`method`	`getSortExternalNames()`
`method`	`setSortExternalNames(value)`
	Indicates whether sorting external defined names before saving file.
`method`	`getSortNames()`
`method`	`setSortNames(value)`
	Indicates whether sorting defined names before saving file.
`method`	`getToExcelStruct()`
`method`	`setToExcelStruct(value)`
	Indicates whether converting to json struct of the Excel file.
`method`	`getUpdateSmartArt()`
`method`	`setUpdateSmartArt(value)`
	Indicates whether updating smart art setting. The default value is false.
`method`	`getValidateMergedAreas()`
`method`	`setValidateMergedAreas(value)`
	Indicates whether validate merged cells before saving the file.
`method`	`getWarningCallback()`
`method`	`setWarningCallback(value)`
	Gets or sets warning callback.

- Constructor Detail
  - JsonSaveOptions
```
JsonSaveOptions()
```
    Creates options for saving json file.
- Property Getters/Setters Detail
  - getExportHyperlinkType/setExportHyperlinkType : int
```
int getExportHyperlinkType() / 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
```
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.

asposecells.api

Classes

Constants

Class JsonSaveOptions

Constructor Detail

JsonSaveOptions

Property Getters/Setters Detail

getExportHyperlinkType/setExportHyperlinkType : int

getSkipEmptyRows/setSkipEmptyRows : boolean

getSheetIndexes/setSheetIndexes : int[]

getExportArea/setExportArea : CellArea

hasHeaderRow/setHasHeaderRow : boolean

getExportAsString/setExportAsString : boolean

getIndent/setIndent : String

getExportNestedStructure/setExportNestedStructure : boolean

getExportEmptyCells/setExportEmptyCells : boolean

getAlwaysExportAsJsonObject/setAlwaysExportAsJsonObject : boolean

getToExcelStruct/setToExcelStruct : boolean

getSaveFormat : int

getClearData/setClearData : boolean

getCachedFileFolder/setCachedFileFolder : String

getValidateMergedAreas/setValidateMergedAreas : boolean

getMergeAreas/setMergeAreas : boolean

getCreateDirectory/setCreateDirectory : boolean

getSortNames/setSortNames : boolean

getSortExternalNames/setSortExternalNames : boolean

getRefreshChartCache/setRefreshChartCache : boolean

getWarningCallback/setWarningCallback : IWarningCallback

getUpdateSmartArt/setUpdateSmartArt : boolean