JsonSaveOptions

Inheritance: java.lang.Object, com.aspose.cells.SaveOptions

public class JsonSaveOptions extends SaveOptions

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

Constructors

ConstructorDescription
JsonSaveOptions()Creates options for saving json file.

Methods

MethodDescription
equals(Object arg0)
getAlwaysExportAsJsonObject()Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
getCachedFileFolder()The cached file folder is used to store some large data.
getClass()
getClearData()Make the workbook empty after saving the file.
getCreateDirectory()If true and the directory does not exist, the directory will be automatically created before saving the file.
getExportArea()Gets the exporting range.
getExportAsString()Exports the string value of the cells to json.
getExportEmptyCells()Indicates whether exporting empty cells as null.
getExportHyperlinkType()Represents the type of exporting hyperlink to json.
getExportNestedStructure()Exported as parent-child hierarchy Json structure.
getIndent()Indicates the indent.
getMergeAreas()Indicates whether merge the areas of conditional formatting and validation before saving the file.
getRefreshChartCache()Indicates whether refreshing chart cache data
getSaveFormat()Gets the save file format.
getSheetIndexes()Represents the indexes of exported sheets.
getSkipEmptyRows()Indicates whether skipping emtpy rows.
getSortExternalNames()Indicates whether sorting external defined names before saving file.
getSortNames()Indicates whether sorting defined names before saving file.
getUpdateSmartArt()Indicates whether updating smart art setting.
getValidateMergedAreas()Indicates whether validate merged cells before saving the file.
getWarningCallback()Gets warning callback.
hasHeaderRow()Indicates whether the range contains header row.
hashCode()
notify()
notifyAll()
setAlwaysExportAsJsonObject(boolean value)Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
setCachedFileFolder(String value)The cached file folder is used to store some large data.
setClearData(boolean value)Make the workbook empty after saving the file.
setCreateDirectory(boolean value)If true and the directory does not exist, the directory will be automatically created before saving the file.
setExportArea(CellArea value)Sets the exporting range.
setExportAsString(boolean value)Exports the string value of the cells to json.
setExportEmptyCells(boolean value)Indicates whether exporting empty cells as null.
setExportHyperlinkType(int value)Represents the type of exporting hyperlink to json.
setExportNestedStructure(boolean value)Exported as parent-child hierarchy Json structure.
setHasHeaderRow(boolean value)Indicates whether the range contains header row.
setIndent(String value)Indicates the indent.
setMergeAreas(boolean value)Indicates whether merge the areas of conditional formatting and validation before saving the file.
setRefreshChartCache(boolean value)Indicates whether refreshing chart cache data
setSheetIndexes(int[] value)Represents the indexes of exported sheets.
setSkipEmptyRows(boolean value)Indicates whether skipping emtpy rows.
setSortExternalNames(boolean value)Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)Indicates whether sorting defined names before saving file.
setUpdateSmartArt(boolean value)Indicates whether updating smart art setting.
setValidateMergedAreas(boolean value)Indicates whether validate merged cells before saving the file.
setWarningCallback(IWarningCallback value)Sets warning callback.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

JsonSaveOptions()

public JsonSaveOptions()

Creates options for saving json file.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getAlwaysExportAsJsonObject()

public boolean getAlwaysExportAsJsonObject()

Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.

Returns: boolean

getCachedFileFolder()

public String getCachedFileFolder()

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

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClearData()

public boolean getClearData()

Make the workbook empty after saving the file.

Returns: boolean

getCreateDirectory()

public boolean getCreateDirectory()

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

Remarks

The default value is false.

Returns: boolean

getExportArea()

public CellArea getExportArea()

Gets the exporting range.

Returns: CellArea

getExportAsString()

public boolean getExportAsString()

Exports the string value of the cells to json.

Returns: boolean

getExportEmptyCells()

public boolean getExportEmptyCells()

Indicates whether exporting empty cells as null.

Returns: boolean

getExportHyperlinkType()

public int getExportHyperlinkType()

Represents the type of exporting hyperlink to json.

See JsonExportHyperlinkType.

Remarks

The default value is JsonExportHyperlinkType.DISPLAY_STRING;

Returns: int

getExportNestedStructure()

public boolean getExportNestedStructure()

Exported as parent-child hierarchy Json structure.

Remarks

Returns: boolean

getIndent()

public String getIndent()

Indicates the indent.

Remarks

If the indent is null or empty, the exported json is not formatted.

Returns: java.lang.String

getMergeAreas()

public boolean getMergeAreas()

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

Remarks

The default value is false.

Returns: boolean

getRefreshChartCache()

public boolean getRefreshChartCache()

Indicates whether refreshing chart cache data

Returns: boolean

getSaveFormat()

public int getSaveFormat()

Gets the save file format.

See SaveFormat.

Returns: int

getSheetIndexes()

public int[] getSheetIndexes()

Represents the indexes of exported sheets.

Returns: int[]

getSkipEmptyRows()

public boolean getSkipEmptyRows()

Indicates whether skipping emtpy rows.

Returns: boolean

getSortExternalNames()

public boolean getSortExternalNames()

Indicates whether sorting external defined names before saving file.

Returns: boolean

getSortNames()

public boolean getSortNames()

Indicates whether sorting defined names before saving file.

Returns: boolean

getUpdateSmartArt()

public boolean getUpdateSmartArt()

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

Remarks

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

Returns: boolean

getValidateMergedAreas()

public boolean getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Returns: boolean

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

hasHeaderRow()

public boolean hasHeaderRow()

Indicates whether the range contains header row.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAlwaysExportAsJsonObject(boolean value)

public void setAlwaysExportAsJsonObject(boolean value)

Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.

Parameters:

ParameterTypeDescription
valueboolean

setCachedFileFolder(String value)

public void setCachedFileFolder(String value)

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

Parameters:

ParameterTypeDescription
valuejava.lang.String

setClearData(boolean value)

public void setClearData(boolean value)

Make the workbook empty after saving the file.

Parameters:

ParameterTypeDescription
valueboolean

setCreateDirectory(boolean value)

public void setCreateDirectory(boolean value)

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

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setExportArea(CellArea value)

public void setExportArea(CellArea value)

Sets the exporting range.

Parameters:

ParameterTypeDescription
valueCellArea

setExportAsString(boolean value)

public void setExportAsString(boolean value)

Exports the string value of the cells to json.

Parameters:

ParameterTypeDescription
valueboolean

setExportEmptyCells(boolean value)

public void setExportEmptyCells(boolean value)

Indicates whether exporting empty cells as null.

Parameters:

ParameterTypeDescription
valueboolean

setExportHyperlinkType(int value)

public void setExportHyperlinkType(int value)

Represents the type of exporting hyperlink to json.

See JsonExportHyperlinkType.

Remarks

The default value is JsonExportHyperlinkType.DISPLAY_STRING;

Parameters:

ParameterTypeDescription
valueint

setExportNestedStructure(boolean value)

public void setExportNestedStructure(boolean value)

Exported as parent-child hierarchy Json structure.

Remarks

Parameters:

ParameterTypeDescription
valueboolean

setHasHeaderRow(boolean value)

public void setHasHeaderRow(boolean value)

Indicates whether the range contains header row.

Parameters:

ParameterTypeDescription
valueboolean

setIndent(String value)

public void setIndent(String value)

Indicates the indent.

Remarks

If the indent is null or empty, the exported json is not formatted.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setMergeAreas(boolean value)

public void setMergeAreas(boolean value)

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

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

Parameters:

ParameterTypeDescription
valueboolean

setSheetIndexes(int[] value)

public void setSheetIndexes(int[] value)

Represents the indexes of exported sheets.

Parameters:

ParameterTypeDescription
valueint[]

setSkipEmptyRows(boolean value)

public void setSkipEmptyRows(boolean value)

Indicates whether skipping emtpy rows.

Parameters:

ParameterTypeDescription
valueboolean

setSortExternalNames(boolean value)

public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

Parameters:

ParameterTypeDescription
valueboolean

setSortNames(boolean value)

public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

Parameters:

ParameterTypeDescription
valueboolean

setUpdateSmartArt(boolean value)

public void setUpdateSmartArt(boolean value)

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

Remarks

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

Parameters:

ParameterTypeDescription
valueboolean

setValidateMergedAreas(boolean value)

public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

ParameterTypeDescription
valueIWarningCallback

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int