OdsSaveOptions
Inheritance: java.lang.Object, com.aspose.cells.SaveOptions
public class OdsSaveOptions extends SaveOptions
Represents the options of saving ods file.
Constructors
| Constructor | Description |
|---|---|
| OdsSaveOptions() | Creates the options of saving ods file. |
| OdsSaveOptions(int saveFormat) | Creates the options of saving ods file. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| 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. |
| 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. |
| getEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. |
| getGeneratorType() | Gets the generator of the ods file. |
| getIgnorePivotTables() | Indicates whether saving pivot tables. |
| getMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getOdfStrictVersion() | Gets the ODF version. |
| getRefreshChartCache() | Indicates whether refreshing chart cache data |
| getSaveFormat() | Gets the save file format. |
| 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. |
| hashCode() | |
| isStrictSchema11() | Indicates whether the ods file should be saved as ODF format version 1.1. |
| notify() | |
| notifyAll() | |
| setCachedFileFolder(String value) | The cached file folder is used to store some large data. |
| setCheckExcelRestriction(boolean value) | Whether check restriction of excel file when user modify cells related objects. |
| 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. |
| setEncryptDocumentProperties(boolean value) | Indicates whether encrypt document properties when saving as .xls file. |
| setGeneratorType(int value) | Sets the generator of the ods file. |
| setIgnorePivotTables(boolean value) | Indicates whether saving pivot tables. |
| setMergeAreas(boolean value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| setOdfStrictVersion(int value) | Sets the ODF version. |
| setRefreshChartCache(boolean value) | Indicates whether refreshing chart cache data |
| setSortExternalNames(boolean value) | Indicates whether sorting external defined names before saving file. |
| setSortNames(boolean value) | Indicates whether sorting defined names before saving file. |
| setStrictSchema11(boolean value) | Indicates whether the ods file should be saved as ODF format version 1.1. |
| 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) |
OdsSaveOptions()
public OdsSaveOptions()
Creates the options of saving ods file.
OdsSaveOptions(int saveFormat)
public OdsSaveOptions(int saveFormat)
Creates the options of saving ods file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | SaveFormat. The file format. It should be SaveFormat.ODS, SaveFormat.OTS, SaveFormat.FODS or SaveFormat.SXC, otherwise the saved format will be set as SaveFormat.ODS automatically. |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCachedFileFolder()
public String getCachedFileFolder()
The cached file folder is used to store some large data.
Returns: java.lang.String
getCheckExcelRestriction()
public boolean 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.
Returns: boolean
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
getEncryptDocumentProperties()
public boolean getEncryptDocumentProperties()
Indicates whether encrypt document properties when saving as .xls file. The default value is true.
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
Returns: boolean
getGeneratorType()
public int getGeneratorType()
Gets the generator of the ods file.
See OdsGeneratorType.
Returns: int
getIgnorePivotTables()
public boolean getIgnorePivotTables()
Indicates whether saving pivot tables.
Remarks
The pivot table feature of OpenOffice has fewer settings compared to Excel, so their results of pivot table have many differences. Sometimes it’s better to ingore these pivot tables when saving .ods file.
Returns: boolean
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
getOdfStrictVersion()
public int getOdfStrictVersion()
Gets the ODF version.
See OpenDocumentFormatVersionType.
Returns: int
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
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
hashCode()
public native int hashCode()
Returns: int
isStrictSchema11()
public boolean isStrictSchema11()
Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
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.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCachedFileFolder(String value)
public void setCachedFileFolder(String value)
The cached file folder is used to store some large data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCheckExcelRestriction(boolean value)
public void setCheckExcelRestriction(boolean 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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setClearData(boolean value)
public void setClearData(boolean value)
Make the workbook empty after saving the file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setEncryptDocumentProperties(boolean value)
public void setEncryptDocumentProperties(boolean value)
Indicates whether encrypt document properties when saving as .xls file. The default value is true.
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setGeneratorType(int value)
public void setGeneratorType(int value)
Sets the generator of the ods file.
See OdsGeneratorType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setIgnorePivotTables(boolean value)
public void setIgnorePivotTables(boolean value)
Indicates whether saving pivot tables.
Remarks
The pivot table feature of OpenOffice has fewer settings compared to Excel, so their results of pivot table have many differences. Sometimes it’s better to ingore these pivot tables when saving .ods file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setOdfStrictVersion(int value)
public void setOdfStrictVersion(int value)
Sets the ODF version.
See OpenDocumentFormatVersionType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRefreshChartCache(boolean value)
public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSortExternalNames(boolean value)
public void setSortExternalNames(boolean value)
Indicates whether sorting external defined names before saving file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSortNames(boolean value)
public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setStrictSchema11(boolean value)
public void setStrictSchema11(boolean value)
Indicates whether the ods file should be saved as ODF format version 1.1. Default is false.
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setValidateMergedAreas(boolean value)
public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file.
Remarks
The default value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Sets warning callback.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |