TxtSaveOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.SaveOptions
- - com.aspose.cells.TxtSaveOptions

```
public class TxtSaveOptions
extends SaveOptions
```
Represents the save options for csv/tab delimited/other text format.

Constructor Summary

Constructors
Constructor and Description

TxtSaveOptions()
Creates text file save options.

TxtSaveOptions(int saveFormat)
Creates text file save options.

Constructors
Constructor and Description
`TxtSaveOptions()` Creates text file save options.
`TxtSaveOptions(int saveFormat)` Creates text file save options.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAlwaysQuoted()` Deprecated. Use QuoteType property instead.
`Encoding`	`getEncoding()` Gets the default encoding.
`boolean`	`getExportAllSheets()` Indicates whether exporting all sheets to the text file.
`CellArea`	`getExportArea()` The range of cells to be exported.
`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.
`int`	`getFormatStrategy()` Gets the format strategy when exporting the cell value as string.
`boolean`	`getKeepSeparatorsForBlankRow()` Indicates whether separators should be output for blank row.
`LightCellsDataProvider`	`getLightCellsDataProvider()` The data provider for saving workbook in light mode.
`int`	`getQuoteType()` Gets how to quote values in the exported text file.
`char`	`getSeparator()` Gets char Delimiter of text file.
`java.lang.String`	`getSeparatorString()` Gets a string value as separator.
`boolean`	`getTrimLeadingBlankRowAndColumn()` Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
`boolean`	`getTrimTailingBlankCells()` Indicates whether tailing blank cells in one row should be trimmed.
`void`	`setAlwaysQuoted(boolean value)` Deprecated. Use QuoteType property instead.
`void`	`setEncoding(Encoding value)` Sets the default encoding.
`void`	`setExportAllSheets(boolean value)` Indicates whether exporting all sheets to the text file.
`void`	`setExportArea(CellArea value)` The range of cells to be exported.
`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.
`void`	`setFormatStrategy(int value)` Sets the format strategy when exporting the cell value as string.
`void`	`setKeepSeparatorsForBlankRow(boolean value)` Indicates whether separators should be output for blank row.
`void`	`setLightCellsDataProvider(LightCellsDataProvider value)` The data provider for saving workbook in light mode.
`void`	`setQuoteType(int value)` Sets how to quote values in the exported text file.
`void`	`setSeparator(char value)` Sets char Delimiter of text file.
`void`	`setSeparatorString(java.lang.String value)` Sets a string value as separator.
`void`	`setTrimLeadingBlankRowAndColumn(boolean value)` Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
`void`	`setTrimTailingBlankCells(boolean value)` Indicates whether tailing blank cells in one row should be trimmed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TxtSaveOptions
```
public TxtSaveOptions()
```
    Creates text file save options.
  - TxtSaveOptions
```
public TxtSaveOptions(int saveFormat)
```
    Creates text file save options.
    
    Parameters:
    saveFormat - SaveFormat. The file format. It should be SaveFormat.CSV or SaveFormat.TSV, otherwise the saved format will be set as SaveFormat.CSV automatically.
- Method Detail
  - getSeparator
```
public char getSeparator()
```
    Gets char Delimiter of text file.
  - setSeparator
```
public void setSeparator(char value)
```
    Sets char Delimiter of text file.
  - getSeparatorString
```
public java.lang.String getSeparatorString()
```
    Gets a string value as separator.
  - setSeparatorString
```
public void setSeparatorString(java.lang.String value)
```
    Sets a string value as separator.
  - getEncoding
```
public Encoding getEncoding()
```
    Gets the default encoding.
  - setEncoding
```
public void setEncoding(Encoding value)
```
    Sets the default encoding.
  - getAlwaysQuoted
```
public boolean getAlwaysQuoted()
```
    Deprecated. Use QuoteType property instead.
    
    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.
  - setAlwaysQuoted
```
public void setAlwaysQuoted(boolean value)
```
    Deprecated. Use QuoteType property instead.
    
    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.
  - getQuoteType
```
public int getQuoteType()
```
    Gets how to quote values in the exported text file.
    See TxtValueQuoteType.
  - setQuoteType
```
public void setQuoteType(int value)
```
    Sets how to quote values in the exported text file.
    See TxtValueQuoteType.
  - getFormatStrategy
```
public int getFormatStrategy()
```
    Gets the format strategy when exporting the cell value as string.
    See CellValueFormatStrategy.
  - setFormatStrategy
```
public void setFormatStrategy(int value)
```
    Sets the format strategy when exporting the cell value as string.
    See CellValueFormatStrategy.
  - getLightCellsDataProvider
```
public LightCellsDataProvider getLightCellsDataProvider()
```
    The data provider for saving workbook in light mode.
  - setLightCellsDataProvider
```
public void setLightCellsDataProvider(LightCellsDataProvider value)
```
    The data provider for saving workbook in light mode.
  - 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()
  - setTrimLeadingBlankRowAndColumn
```
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()
  - 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()
  - setTrimTailingBlankCells
```
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()
  - 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.
  - setKeepSeparatorsForBlankRow
```
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.
  - getExportArea
```
public CellArea getExportArea()
```
    The range of cells to be exported.
    Remarks
    If the exported area has been specified, getTrimLeadingBlankRowAndColumn() will takes no effect.
  - setExportArea
```
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.
  - 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.
  - setExportQuotePrefix
```
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.
  - 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.
  - setExportAllSheets
```
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.

Class TxtSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.cells.SaveOptions

Methods inherited from class java.lang.Object

Constructor Detail

TxtSaveOptions

TxtSaveOptions

Method Detail

getSeparator

setSeparator

getSeparatorString

setSeparatorString

getEncoding

setEncoding

getAlwaysQuoted

setAlwaysQuoted

getQuoteType

setQuoteType

getFormatStrategy

setFormatStrategy

getLightCellsDataProvider

setLightCellsDataProvider

getTrimLeadingBlankRowAndColumn

setTrimLeadingBlankRowAndColumn

getTrimTailingBlankCells

setTrimTailingBlankCells

getKeepSeparatorsForBlankRow

setKeepSeparatorsForBlankRow

getExportArea

setExportArea

getExportQuotePrefix

setExportQuotePrefix

getExportAllSheets

setExportAllSheets