Aspose::Cells::JsonSaveOptions class
Contents
[
Hide
]JsonSaveOptions class
Represents the options of saving the workbook as a json file.
class JsonSaveOptions : public Aspose::Cells::SaveOptions
Methods
| Method | Description |
|---|---|
| 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. |
| GetCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| 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. |
| GetEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| GetExportArea() | Gets or sets 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. |
| GetHasHeaderRow() | Indicates whether the range contains header row. |
| 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. |
| GetSchemas() | The original json schema of each worksheet. |
| 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. |
| GetToExcelStruct() | Indicates whether converting to json struct of the Excel file. |
| GetUpdateSmartArt() | Indicates whether updating smart art setting. The default value is false. |
| GetValidateMergedAreas() | Indicates whether validate merged cells before saving the file. |
| GetWarningCallback() | Gets or sets warning callback. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| JsonSaveOptions() | Creates options for saving json file. |
| JsonSaveOptions(JsonSaveOptions_Impl* impl) | Constructs from an implementation object. |
| JsonSaveOptions(const JsonSaveOptions& src) | Copy constructor. |
| JsonSaveOptions(const SaveOptions& src) | Constructs from a parent object. |
| explicit operator bool() const | operator bool() |
| operator=(const JsonSaveOptions& src) | operator= |
| operator=(const SaveOptions& src) | operator= |
| SaveOptions(SaveOptions_Impl* impl) | Constructs from an implementation object. |
| SaveOptions(const SaveOptions& src) | Copy constructor. |
| SetAlwaysExportAsJsonObject(bool value) | Indicates whether always exporting excel to json as object, even there is only a worksheet in the file. |
| SetCachedFileFolder(const U16String& value) | The cached file folder is used to store some large data. |
| SetCachedFileFolder(const char16_t* value) | The cached file folder is used to store some large data. |
| SetCheckExcelRestriction(bool value) | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| SetClearData(bool value) | Make the workbook empty after saving the file. |
| SetCreateDirectory(bool value) | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| SetEncryptDocumentProperties(bool value) | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| SetExportArea(const CellArea& value) | Gets or sets the exporting range. |
| SetExportAsString(bool value) | Exports the string value of the cells to json. |
| SetExportEmptyCells(bool value) | Indicates whether exporting empty cells as null. |
| SetExportHyperlinkType(JsonExportHyperlinkType value) | Represents the type of exporting hyperlink to json. |
| SetExportNestedStructure(bool value) | Exported as parent-child hierarchy Json structure. |
| SetHasHeaderRow(bool value) | Indicates whether the range contains header row. |
| SetIndent(const U16String& value) | Indicates the indent. |
| SetIndent(const char16_t* value) | Indicates the indent. |
| SetMergeAreas(bool value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| SetRefreshChartCache(bool value) | Indicates whether refreshing chart cache data. |
| SetSchemas(const Vector <U16String>& value) | The original json schema of each worksheet. |
| SetSheetIndexes(const Vector <int32_t>& value) | Represents the indexes of exported sheets. |
| SetSkipEmptyRows(bool value) | Indicates whether skipping emtpy rows. |
| SetSortExternalNames(bool value) | Indicates whether sorting external defined names before saving file. |
| SetSortNames(bool value) | Indicates whether sorting defined names before saving file. |
| SetToExcelStruct(bool value) | Indicates whether converting to json struct of the Excel file. |
| SetUpdateSmartArt(bool value) | Indicates whether updating smart art setting. The default value is false. |
| SetValidateMergedAreas(bool value) | Indicates whether validate merged cells before saving the file. |
| SetWarningCallback(IWarningCallback* value) | Gets or sets warning callback. |
| ~JsonSaveOptions() | Destructor. |
| ~SaveOptions() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class SaveOptions
- Namespace Aspose::Cells
- Library Aspose.Cells for C++