XlsSaveOptions
Inheritance: java.lang.Object, com.aspose.cells.SaveOptions
public class XlsSaveOptions extends SaveOptions
Represents the save options for the Excel 97-2003 file format: xls and xlt.
Constructors
| Constructor | Description |
|---|---|
| XlsSaveOptions() | Creates options for saving Excel 97-2003 xls file. |
| XlsSaveOptions(int saveFormat) | Creates options for saving Excel 97-2003 xls/xlt 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. |
| getLightCellsDataProvider() | The data provider for saving workbook in light mode. |
| getMatchColor() | Indicates whether matching font color because there are 56 colors in the standard color palette. |
| 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. |
| 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. |
| getWpsCompatibility() | Indicates whether to make the xls more compatible with WPS. |
| hashCode() | |
| isTemplate() | Indicates whether saving a template file. |
| 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. |
| setLightCellsDataProvider(LightCellsDataProvider value) | The data provider for saving workbook in light mode. |
| setMatchColor(boolean value) | Indicates whether matching font color because there are 56 colors in the standard color palette. |
| setMergeAreas(boolean value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| 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. |
| setTemplate(boolean value) | Indicates whether saving a template file. |
| 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. |
| setWpsCompatibility(boolean value) | Indicates whether to make the xls more compatible with WPS. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
XlsSaveOptions()
public XlsSaveOptions()
Creates options for saving Excel 97-2003 xls file.
XlsSaveOptions(int saveFormat)
public XlsSaveOptions(int saveFormat)
Creates options for saving Excel 97-2003 xls/xlt file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | SaveFormat. The file format. It should be SaveFormat.EXCEL_97_TO_2003 or SaveFormat.XLT, otherwise the saved format will be set as SaveFormat.EXCEL_97_TO_2003 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
getLightCellsDataProvider()
public LightCellsDataProvider getLightCellsDataProvider()
The data provider for saving workbook in light mode.
Returns: LightCellsDataProvider
getMatchColor()
public boolean getMatchColor()
Indicates whether matching font color because there are 56 colors in the standard color palette.
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
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
getWpsCompatibility()
public boolean getWpsCompatibility()
Indicates whether to make the xls more compatible with WPS.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
isTemplate()
public boolean isTemplate()
Indicates whether saving a template file.
Remarks
NOTE: This member is now obsolete. Instead, please create XlsSaveOptions with corresponding save format(xlt for true and xls for false). This method will be removed 12 months later since August 2020. 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 |
setLightCellsDataProvider(LightCellsDataProvider value)
public void setLightCellsDataProvider(LightCellsDataProvider value)
The data provider for saving workbook in light mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LightCellsDataProvider |
setMatchColor(boolean value)
public void setMatchColor(boolean value)
Indicates whether matching font color because there are 56 colors in the standard color palette.
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 |
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 |
setTemplate(boolean value)
public void setTemplate(boolean value)
Indicates whether saving a template file.
Remarks
NOTE: This member is now obsolete. Instead, please create XlsSaveOptions with corresponding save format(xlt for true and xls for false). This method will be removed 12 months later since August 2020. 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 |
setWpsCompatibility(boolean value)
public void setWpsCompatibility(boolean value)
Indicates whether to make the xls more compatible with WPS.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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 |