JsonSaveOptions

JsonSaveOptions class

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

Constructors

Name	Description
JsonSaveOptions	Creates options for saving json file.

Properties

Name	Type	Description
ExportStylePool	boolean
ExportHyperlinkType	int	Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constan
SkipEmptyRows	boolean	Indicates whether skipping emtpy rows.
SheetIndexes	int[]	Represents the indexes of exported sheets.
Schemas	String[]
ExportArea	CellArea	Gets or sets the exporting range.
HasHeaderRow	boolean	Indicates whether the range contains header row.
ExportAsString	boolean	Exports the string value of the cells to json.
Indent	String	Indicates the indent. If the indent is null or empty, the exported json is not formatted.
ExportNestedStructure	boolean	Exported as parent-child hierarchy Json structure.
ExportEmptyCells	boolean	Indicates whether exporting empty cells as null.
AlwaysExportAsJsonObject	boolean	Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
ToExcelStruct	boolean	Indicates whether converting to json struct of the Excel file. Only for converting range to JSON.
SaveFormat	int	Gets the save file format. The value of the property is SaveFormat integer constant.
ClearData	boolean	Make the workbook empty after saving the file.
CachedFileFolder	String	The cached file folder is used to store some large data.
ValidateMergedAreas	boolean	Indicates whether validate merged cells before saving the file. The default value is false.
MergeAreas	boolean	Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is
CreateDirectory	boolean	If true and the directory does not exist, the directory will be automatically created before saving the file. The defaul
SortNames	boolean	Indicates whether sorting defined names before saving file.
SortExternalNames	boolean	Indicates whether sorting external defined names before saving file.
RefreshChartCache	boolean	Indicates whether refreshing chart cache data
WarningCallback	IWarningCallback	Gets or sets warning callback.
CheckExcelRestriction	boolean
UpdateSmartArt	boolean	Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm
EncryptDocumentProperties	boolean

JsonSaveOptions()

Creates options for saving json file.

JsonSaveOptions.ExportStylePool property

Type: boolean

JsonSaveOptions.ExportHyperlinkType property

Represents the type of exporting hyperlink to json. The value of the property is JsonExportHyperlinkType integer constant. The default value is JsonExportHyperlinkType.DISPLAY_STRING ;

Type: int

JsonSaveOptions.SkipEmptyRows property

Indicates whether skipping emtpy rows.

Type: boolean

JsonSaveOptions.SheetIndexes property

Represents the indexes of exported sheets.

Type: int[]

JsonSaveOptions.Schemas property

Type: String[]

JsonSaveOptions.ExportArea property

Gets or sets the exporting range.

Type: CellArea

JsonSaveOptions.HasHeaderRow property

Indicates whether the range contains header row.

Type: boolean

JsonSaveOptions.ExportAsString property

Exports the string value of the cells to json.

Type: boolean

JsonSaveOptions.Indent property

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

Type: String

JsonSaveOptions.ExportNestedStructure property

Exported as parent-child hierarchy Json structure.

Type: boolean

JsonSaveOptions.ExportEmptyCells property

Indicates whether exporting empty cells as null.

Type: boolean

JsonSaveOptions.AlwaysExportAsJsonObject property

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

Type: boolean

JsonSaveOptions.ToExcelStruct property

Indicates whether converting to json struct of the Excel file. Only for converting range to JSON.

Type: boolean

JsonSaveOptions.SaveFormat property

Gets the save file format. The value of the property is SaveFormat integer constant.

Type: int

JsonSaveOptions.ClearData property

Make the workbook empty after saving the file.

Type: boolean

JsonSaveOptions.CachedFileFolder property

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

Type: String

JsonSaveOptions.ValidateMergedAreas property

Indicates whether validate merged cells before saving the file. The default value is false.

Type: boolean

JsonSaveOptions.MergeAreas property

Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

Type: boolean

JsonSaveOptions.CreateDirectory property

If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

Type: boolean

JsonSaveOptions.SortNames property

Indicates whether sorting defined names before saving file.

Type: boolean

JsonSaveOptions.SortExternalNames property

Indicates whether sorting external defined names before saving file.

Type: boolean

JsonSaveOptions.RefreshChartCache property

Indicates whether refreshing chart cache data

Type: boolean

JsonSaveOptions.WarningCallback property

Gets or sets warning callback.

Type: IWarningCallback

JsonSaveOptions.CheckExcelRestriction property

Type: boolean

JsonSaveOptions.UpdateSmartArt property

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.

Type: boolean

JsonSaveOptions.EncryptDocumentProperties property

Type: boolean