OdsSaveOptions
OdsSaveOptions class
Represents the options of saving ods file.
class OdsSaveOptions extends SaveOptions;
Constructors
| Name | Description |
|---|---|
| constructor() | Creates the options of saving ods file. |
| constructor(SaveOptions) | Constructs from a parent object convertible to this. |
| constructor(SaveFormat) | Creates the options of saving ods file. |
Methods
| Method | Description |
|---|---|
| getGeneratorType() | Gets and sets the generator of the ods file. |
| setGeneratorType(OdsGeneratorType) | Gets and sets the generator of the ods file. |
| isStrictSchema11() | Indicates whether the ods file should be saved as ODF format version 1.1. Default is false. |
| setIsStrictSchema11(boolean) | Indicates whether the ods file should be saved as ODF format version 1.1. Default is false. |
| getOdfStrictVersion() | Gets and sets the ODF version. |
| setOdfStrictVersion(OpenDocumentFormatVersionType) | Gets and sets the ODF version. |
| getSaveFormat() | Gets the save file format. |
| getClearData() | Make the workbook empty after saving the file. |
| setClearData(boolean) | Make the workbook empty after saving the file. |
| getCachedFileFolder() | The cached file folder is used to store some large data. |
| setCachedFileFolder(string) | The cached file folder is used to store some large data. |
| getValidateMergedAreas() | Indicates whether validate merged cells before saving the file. |
| setValidateMergedAreas(boolean) | Indicates whether validate merged cells before saving the file. |
| getMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| setMergeAreas(boolean) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getCreateDirectory() | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| setCreateDirectory(boolean) | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| getSortNames() | Indicates whether sorting defined names before saving file. |
| setSortNames(boolean) | Indicates whether sorting defined names before saving file. |
| getSortExternalNames() | Indicates whether sorting external defined names before saving file. |
| setSortExternalNames(boolean) | Indicates whether sorting external defined names before saving file. |
| getRefreshChartCache() | Indicates whether refreshing chart cache data |
| setRefreshChartCache(boolean) | Indicates whether refreshing chart cache data |
| setWarningCallback(IWarningCallback) | Gets or sets warning callback. |
| getWarningCallback() | Gets or sets warning callback. |
| getUpdateSmartArt() | Indicates whether updating smart art setting. The default value is false. |
| setUpdateSmartArt(boolean) | Indicates whether updating smart art setting. The default value is false. |
constructor()
Creates the options of saving ods file.
constructor();
constructor(SaveOptions)
Constructs from a parent object convertible to this.
constructor(obj: SaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | SaveOptions | The parent object. |
constructor(SaveFormat)
Creates the options of saving ods file.
constructor(saveFormat: SaveFormat);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | SaveFormat | The file format. /// It should be SaveFormat.Ods, SaveFormat.Ods, /// SaveFormat.Ods or SaveFormat.Ods, /// otherwise the saved format will be set as SaveFormat.Ods automatically. |
getGeneratorType()
Gets and sets the generator of the ods file.
getGeneratorType() : OdsGeneratorType;
Returns
setGeneratorType(OdsGeneratorType)
Gets and sets the generator of the ods file.
setGeneratorType(value: OdsGeneratorType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | OdsGeneratorType | The value to set. |
isStrictSchema11()
Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
isStrictSchema11() : boolean;
Remarks
NOTE: This member is now obsolete. Instead, please use OdsSaveOptions.OdfStrictVersion property. This method will be removed 12 months later since February 2024. Aspose apologizes for any inconvenience you may have experienced.
setIsStrictSchema11(boolean)
Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
setIsStrictSchema11(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
NOTE: This member is now obsolete. Instead, please use OdsSaveOptions.OdfStrictVersion property. This method will be removed 12 months later since February 2024. Aspose apologizes for any inconvenience you may have experienced.
getOdfStrictVersion()
Gets and sets the ODF version.
getOdfStrictVersion() : OpenDocumentFormatVersionType;
Returns
setOdfStrictVersion(OpenDocumentFormatVersionType)
Gets and sets the ODF version.
setOdfStrictVersion(value: OpenDocumentFormatVersionType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | OpenDocumentFormatVersionType | The value to set. |
getSaveFormat()
Gets the save file format.
getSaveFormat() : SaveFormat;
Returns
getClearData()
Make the workbook empty after saving the file.
getClearData() : boolean;
setClearData(boolean)
Make the workbook empty after saving the file.
setClearData(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCachedFileFolder()
The cached file folder is used to store some large data.
getCachedFileFolder() : string;
setCachedFileFolder(string)
The cached file folder is used to store some large data.
setCachedFileFolder(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getValidateMergedAreas()
Indicates whether validate merged cells before saving the file.
getValidateMergedAreas() : boolean;
Remarks
The default value is false.
setValidateMergedAreas(boolean)
Indicates whether validate merged cells before saving the file.
setValidateMergedAreas(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getMergeAreas()
Indicates whether merge the areas of conditional formatting and validation before saving the file.
getMergeAreas() : boolean;
Remarks
The default value is false.
setMergeAreas(boolean)
Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeAreas(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getCreateDirectory()
If true and the directory does not exist, the directory will be automatically created before saving the file.
getCreateDirectory() : boolean;
Remarks
The default value is false.
setCreateDirectory(boolean)
If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateDirectory(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getSortNames()
Indicates whether sorting defined names before saving file.
getSortNames() : boolean;
setSortNames(boolean)
Indicates whether sorting defined names before saving file.
setSortNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSortExternalNames()
Indicates whether sorting external defined names before saving file.
getSortExternalNames() : boolean;
setSortExternalNames(boolean)
Indicates whether sorting external defined names before saving file.
setSortExternalNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshChartCache()
Indicates whether refreshing chart cache data
getRefreshChartCache() : boolean;
setRefreshChartCache(boolean)
Indicates whether refreshing chart cache data
setRefreshChartCache(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
setWarningCallback(IWarningCallback)
Gets or sets warning callback.
setWarningCallback(value: IWarningCallback) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback | The value to set. |
getWarningCallback()
Gets or sets warning callback.
getWarningCallback() : IWarningCallback;
Returns
getUpdateSmartArt()
Indicates whether updating smart art setting. The default value is false.
getUpdateSmartArt() : boolean;
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
setUpdateSmartArt(boolean)
Indicates whether updating smart art setting. The default value is false.
setUpdateSmartArt(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.