OdsSaveOptions

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

public class OdsSaveOptions extends SaveOptions

Represents the options of saving ods file.

Constructors

ConstructorDescription
OdsSaveOptions()Creates the options of saving ods file.
OdsSaveOptions(int saveFormat)Creates the options of saving ods file.

Methods

MethodDescription
equals(Object arg0)
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.
getGeneratorType()Gets the generator of the ods file.
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.
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.
setGeneratorType(int value)Sets the generator of the ods file.
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:

ParameterTypeDescription
saveFormatintSaveFormat. 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:

ParameterTypeDescription
arg0java.lang.Object

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

getGeneratorType()

public int getGeneratorType()

Gets the generator of the ods file.

See OdsGeneratorType.

Returns: int

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:

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

setGeneratorType(int value)

public void setGeneratorType(int value)

Sets the generator of the ods file.

See OdsGeneratorType.

Parameters:

ParameterTypeDescription
valueint

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

setOdfStrictVersion(int value)

public void setOdfStrictVersion(int value)

Sets the ODF version.

See OpenDocumentFormatVersionType.

Parameters:

ParameterTypeDescription
valueint

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

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

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:

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