TxtSaveOptions
Inheritance: java.lang.Object, com.aspose.cells.SaveOptions
public class TxtSaveOptions extends SaveOptions
Represents the save options for csv/tab delimited/other text format.
Constructors
| Constructor | Description |
|---|---|
| TxtSaveOptions() | Creates text file save options. |
| TxtSaveOptions(int saveFormat) | Creates text file save options. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAlwaysQuoted() | Indicates whether always adding ‘"’ for each field. |
| 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. |
| getEncoding() | Gets the default encoding. |
| getEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. |
| getExportAllSheets() | Indicates whether exporting all sheets to the text file. |
| getExportArea() | The range of cells to be exported. |
| getExportQuotePrefix() | Indicates whether the single quote sign should be exported as part of the value of one cell when Style.getQuotePrefix() is true for it. |
| getFormatStrategy() | Gets the format strategy when exporting the cell value as string. |
| getKeepSeparatorsForBlankRow() | Indicates whether separators should be output for blank row. |
| getLightCellsDataProvider() | The data provider for saving workbook in light mode. |
| getMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getQuoteType() | Gets how to quote values in the exported text file. |
| getRefreshChartCache() | Indicates whether refreshing chart cache data |
| getSaveFormat() | Gets the save file format. |
| getSeparator() | Gets char Delimiter of text file. |
| getSeparatorString() | Gets a string value as separator. |
| getSortExternalNames() | Indicates whether sorting external defined names before saving file. |
| getSortNames() | Indicates whether sorting defined names before saving file. |
| getTrimLeadingBlankRowAndColumn() | Indicates whether leading blank rows and columns should be trimmed like what ms excel does. |
| getTrimTailingBlankCells() | Indicates whether tailing blank cells in one row should be trimmed. |
| getUpdateSmartArt() | Indicates whether updating smart art setting. |
| getValidateMergedAreas() | Indicates whether validate merged cells before saving the file. |
| getWarningCallback() | Gets warning callback. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setAlwaysQuoted(boolean value) | Indicates whether always adding ‘"’ for each field. |
| 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. |
| setEncoding(Encoding value) | Sets the default encoding. |
| setEncryptDocumentProperties(boolean value) | Indicates whether encrypt document properties when saving as .xls file. |
| setExportAllSheets(boolean value) | Indicates whether exporting all sheets to the text file. |
| setExportArea(CellArea value) | The range of cells to be exported. |
| setExportQuotePrefix(boolean value) | Indicates whether the single quote sign should be exported as part of the value of one cell when Style.getQuotePrefix() is true for it. |
| setFormatStrategy(int value) | Sets the format strategy when exporting the cell value as string. |
| setKeepSeparatorsForBlankRow(boolean value) | Indicates whether separators should be output for blank row. |
| setLightCellsDataProvider(LightCellsDataProvider value) | The data provider for saving workbook in light mode. |
| setMergeAreas(boolean value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| setQuoteType(int value) | Sets how to quote values in the exported text file. |
| setRefreshChartCache(boolean value) | Indicates whether refreshing chart cache data |
| setSeparator(char value) | Sets char Delimiter of text file. |
| setSeparatorString(String value) | Sets a string value as separator. |
| setSortExternalNames(boolean value) | Indicates whether sorting external defined names before saving file. |
| setSortNames(boolean value) | Indicates whether sorting defined names before saving file. |
| setTrimLeadingBlankRowAndColumn(boolean value) | Indicates whether leading blank rows and columns should be trimmed like what ms excel does. |
| setTrimTailingBlankCells(boolean value) | Indicates whether tailing blank cells in one row should be trimmed. |
| 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) |
TxtSaveOptions()
public TxtSaveOptions()
Creates text file save options.
TxtSaveOptions(int saveFormat)
public TxtSaveOptions(int saveFormat)
Creates text file save options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | SaveFormat. The file format. It should be SaveFormat.CSV or SaveFormat.TSV, otherwise the saved format will be set as SaveFormat.CSV automatically. |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAlwaysQuoted()
public boolean getAlwaysQuoted()
Indicates whether always adding ‘"’ for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as ‘"’ , ‘\n’ or separator character). Default is false.
Remarks
NOTE: This member is now obsolete. Instead, please use QuoteType property instead. This property will be removed 12 months later since August 2012. Aspose apologizes for any inconvenience you may have experienced.
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
getEncoding()
public Encoding getEncoding()
Gets the default encoding.
Returns: Encoding
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
getExportAllSheets()
public boolean getExportAllSheets()
Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
Remarks
The defult value is false.
Returns: boolean
getExportArea()
public CellArea getExportArea()
The range of cells to be exported.
Remarks
If the exported area has been specified, getTrimLeadingBlankRowAndColumn() will takes no effect.
Returns: CellArea
getExportQuotePrefix()
public boolean getExportQuotePrefix()
Indicates whether the single quote sign should be exported as part of the value of one cell when Style.getQuotePrefix() is true for it. Default is false.
Returns: boolean
getFormatStrategy()
public int getFormatStrategy()
Gets the format strategy when exporting the cell value as string.
Returns: int
getKeepSeparatorsForBlankRow()
public boolean getKeepSeparatorsForBlankRow()
Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.
Returns: boolean
getLightCellsDataProvider()
public LightCellsDataProvider getLightCellsDataProvider()
The data provider for saving workbook in light mode.
Returns: LightCellsDataProvider
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
getQuoteType()
public int getQuoteType()
Gets how to quote values in the exported text file.
See TxtValueQuoteType.
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
getSeparator()
public char getSeparator()
Gets char Delimiter of text file.
Returns: char
getSeparatorString()
public String getSeparatorString()
Gets a string value as separator.
Returns: java.lang.String
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
getTrimLeadingBlankRowAndColumn()
public boolean getTrimLeadingBlankRowAndColumn()
Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
Remarks
Same with the rule in ms excel, a row/column will not be taken as blank if it has custom style, even if it contains no cell data. When saving with LightCells mode, this option takes no effect. User should control the output range by the implementation of getLightCellsDataProvider() or by speicifing getExportArea()
Returns: boolean
getTrimTailingBlankCells()
public boolean getTrimTailingBlankCells()
Indicates whether tailing blank cells in one row should be trimmed. Default is false.
Remarks
When saving with LightCells mode and the getExportArea() has not been specified, this option takes no effect and one row will be extended to just the last cell provided by the implementation getLightCellsDataProvider()
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
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAlwaysQuoted(boolean value)
public void setAlwaysQuoted(boolean value)
Indicates whether always adding ‘"’ for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as ‘"’ , ‘\n’ or separator character). Default is false.
Remarks
NOTE: This member is now obsolete. Instead, please use QuoteType property instead. This property will be removed 12 months later since August 2012. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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 |
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 |
setEncoding(Encoding value)
public void setEncoding(Encoding value)
Sets the default encoding.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Encoding |
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 |
setExportAllSheets(boolean value)
public void setExportAllSheets(boolean value)
Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
Remarks
The defult value is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportArea(CellArea value)
public void setExportArea(CellArea value)
The range of cells to be exported.
Remarks
If the exported area has been specified, getTrimLeadingBlankRowAndColumn() will takes no effect.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CellArea |
setExportQuotePrefix(boolean value)
public void setExportQuotePrefix(boolean value)
Indicates whether the single quote sign should be exported as part of the value of one cell when Style.getQuotePrefix() is true for it. Default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setFormatStrategy(int value)
public void setFormatStrategy(int value)
Sets the format strategy when exporting the cell value as string.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setKeepSeparatorsForBlankRow(boolean value)
public void setKeepSeparatorsForBlankRow(boolean value)
Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.
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 |
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 |
setQuoteType(int value)
public void setQuoteType(int value)
Sets how to quote values in the exported text file.
See TxtValueQuoteType.
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 |
setSeparator(char value)
public void setSeparator(char value)
Sets char Delimiter of text file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | char |
setSeparatorString(String value)
public void setSeparatorString(String value)
Sets a string value as separator.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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 |
setTrimLeadingBlankRowAndColumn(boolean value)
public void setTrimLeadingBlankRowAndColumn(boolean value)
Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
Remarks
Same with the rule in ms excel, a row/column will not be taken as blank if it has custom style, even if it contains no cell data. When saving with LightCells mode, this option takes no effect. User should control the output range by the implementation of getLightCellsDataProvider() or by speicifing getExportArea()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setTrimTailingBlankCells(boolean value)
public void setTrimTailingBlankCells(boolean value)
Indicates whether tailing blank cells in one row should be trimmed. Default is false.
Remarks
When saving with LightCells mode and the getExportArea() has not been specified, this option takes no effect and one row will be extended to just the last cell provided by the implementation getLightCellsDataProvider()
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 |