com.aspose.cells
Class TxtSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by com.aspose.cells.TxtSaveOptions

public class TxtSaveOptions 
extends SaveOptions

Represents the save options for csv/tab delimited/other text format.


Constructor Summary
TxtSaveOptions()
           Creates text file save options.
TxtSaveOptions(int format)
           Creates text file save options.
 
Property Getters/Setters Summary
booleangetAlwaysQuoted()
voidsetAlwaysQuoted(boolean)
           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.
java.lang.StringgetCachedFileFolder()→ inherited from SaveOptions
voidsetCachedFileFolder(java.lang.String)
           The cached file folder is used to store some large data.
booleangetClearData()→ inherited from SaveOptions
voidsetClearData(boolean)
           Make the workbook empty after saving the file.
booleangetCreateDirectory()→ inherited from SaveOptions
voidsetCreateDirectory(boolean)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
com.aspose.cells.EncodinggetEncoding()
voidsetEncoding(com.aspose.cells.Encoding)
           Gets and sets the default encoding.
booleangetExportAllSheets()
voidsetExportAllSheets(boolean)
           Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
CellAreagetExportArea()
voidsetExportArea(CellArea)
           The range of cells to be exported.
booleangetExportQuotePrefix()
voidsetExportQuotePrefix(boolean)
           Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix is true for it. Default is false.
intgetFormatStrategy()
voidsetFormatStrategy(int)
           Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
booleangetKeepSeparatorsForBlankRow()
voidsetKeepSeparatorsForBlankRow(boolean)
           Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.
LightCellsDataProvidergetLightCellsDataProvider()
voidsetLightCellsDataProvider(LightCellsDataProvider)
           The Data provider to provide cells data for saving workbook in light mode.
booleangetMergeAreas()→ inherited from SaveOptions
voidsetMergeAreas(boolean)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
intgetQuoteType()
voidsetQuoteType(int)
           Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
booleangetRefreshChartCache()→ inherited from SaveOptions
voidsetRefreshChartCache(boolean)
           Indicates whether refreshing chart cache data
intgetSaveFormat()→ inherited from SaveOptions
           Gets the save file format. The value of the property is SaveFormat integer constant.
chargetSeparator()
voidsetSeparator(char)
           Gets and sets char Delimiter of text file.
java.lang.StringgetSeparatorString()
voidsetSeparatorString(java.lang.String)
           Gets and sets a string value as separator.
booleangetSortExternalNames()→ inherited from SaveOptions
voidsetSortExternalNames(boolean)
           Indicates whether sorting external defined names before saving file.
booleangetSortNames()→ inherited from SaveOptions
voidsetSortNames(boolean)
           Indicates whether sorting defined names before saving file.
booleangetTrimLeadingBlankRowAndColumn()
voidsetTrimLeadingBlankRowAndColumn(boolean)
           Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
booleangetTrimTailingBlankCells()
voidsetTrimTailingBlankCells(boolean)
           Indicates whether tailing blank cells in one row should be trimmed. Default is false.
booleangetUpdateSmartArt()→ inherited from SaveOptions
voidsetUpdateSmartArt(boolean)
           Indicates whether updating smart art setting. The default value is false.
booleangetValidateMergedAreas()→ inherited from SaveOptions
voidsetValidateMergedAreas(boolean)
           Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback)
           Gets or sets warning callback.
 

Constructor Detail

TxtSaveOptions

public TxtSaveOptions()
Creates text file save options.

TxtSaveOptions

public TxtSaveOptions(int format)
Creates text file save options.
Parameters:
format - A SaveFormat value. The save format of the text file.

Property Getters/Setters Detail

getSeparator/setSeparator

public char getSeparator() / public void setSeparator(char value)
Gets and sets char Delimiter of text file.

setSeparator

public void setSeparator(char value)
Gets and sets char Delimiter of text file.

getSeparatorString/setSeparatorString

public java.lang.String getSeparatorString() / public void setSeparatorString(java.lang.String value)
Gets and sets a string value as separator.

setSeparatorString

public void setSeparatorString(java.lang.String value)
Gets and sets a string value as separator.

getEncoding/setEncoding

public com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)
Gets and sets the default encoding.

setEncoding

public void setEncoding(com.aspose.cells.Encoding value)
Gets and sets the default encoding.

getAlwaysQuoted/setAlwaysQuoted

public boolean getAlwaysQuoted() / 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. 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)
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. 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/setQuoteType

public int getQuoteType() / public void setQuoteType(int value)
Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.

setQuoteType

public void setQuoteType(int value)
Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.

getFormatStrategy/setFormatStrategy

public int getFormatStrategy() / public void setFormatStrategy(int value)
Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.

setFormatStrategy

public void setFormatStrategy(int value)
Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.

getLightCellsDataProvider/setLightCellsDataProvider

public LightCellsDataProvider getLightCellsDataProvider() / public void setLightCellsDataProvider(LightCellsDataProvider value)
The Data provider to provide cells data for saving workbook in light mode.

setLightCellsDataProvider

public void setLightCellsDataProvider(LightCellsDataProvider value)
The Data provider to provide cells data for saving workbook in light mode.

getTrimLeadingBlankRowAndColumn/setTrimLeadingBlankRowAndColumn

public boolean getTrimLeadingBlankRowAndColumn() / public void setTrimLeadingBlankRowAndColumn(boolean value)
Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true. 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 LightCellsDataProvider or by speicifing ExportArea

setTrimLeadingBlankRowAndColumn

public void setTrimLeadingBlankRowAndColumn(boolean value)
Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true. 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 LightCellsDataProvider or by speicifing ExportArea

getTrimTailingBlankCells/setTrimTailingBlankCells

public boolean getTrimTailingBlankCells() / public void setTrimTailingBlankCells(boolean value)
Indicates whether tailing blank cells in one row should be trimmed. Default is false. When saving with LightCells mode and the ExportArea has not been specified, this option takes no effect and one row will be extended to just the last cell provided by the implementation LightCellsDataProvider

setTrimTailingBlankCells

public void setTrimTailingBlankCells(boolean value)
Indicates whether tailing blank cells in one row should be trimmed. Default is false. When saving with LightCells mode and the ExportArea has not been specified, this option takes no effect and one row will be extended to just the last cell provided by the implementation LightCellsDataProvider

getKeepSeparatorsForBlankRow/setKeepSeparatorsForBlankRow

public boolean getKeepSeparatorsForBlankRow() / 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.

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/setExportArea

public CellArea getExportArea() / public void setExportArea(CellArea value)
The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.

setExportArea

public void setExportArea(CellArea value)
The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.

getExportQuotePrefix/setExportQuotePrefix

public boolean getExportQuotePrefix() / public void setExportQuotePrefix(boolean value)
Indicates whether the single quote sign should be exported as part of the value of one cell when Style.QuotePrefix 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.QuotePrefix is true for it. Default is false.

getExportAllSheets/setExportAllSheets

public boolean getExportAllSheets() / 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. 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. The defult value is false.

getSaveFormat

→ inherited from SaveOptions
public int getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.

getClearData/setClearData

→ inherited from SaveOptions
public boolean getClearData() / public void setClearData(boolean value)
Make the workbook empty after saving the file.

setClearData

→ inherited from SaveOptions
public void setClearData(boolean value)
Make the workbook empty after saving the file.

getCachedFileFolder/setCachedFileFolder

→ inherited from SaveOptions
public java.lang.String getCachedFileFolder() / public void setCachedFileFolder(java.lang.String value)
The cached file folder is used to store some large data.

setCachedFileFolder

→ inherited from SaveOptions
public void setCachedFileFolder(java.lang.String value)
The cached file folder is used to store some large data.

getValidateMergedAreas/setValidateMergedAreas

→ inherited from SaveOptions
public boolean getValidateMergedAreas() / public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file. The default value is false.

setValidateMergedAreas

→ inherited from SaveOptions
public void setValidateMergedAreas(boolean value)
Indicates whether validate merged cells before saving the file. The default value is false.

getMergeAreas/setMergeAreas

→ inherited from SaveOptions
public boolean getMergeAreas() / public void setMergeAreas(boolean value)
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

setMergeAreas

→ inherited from SaveOptions
public void setMergeAreas(boolean value)
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

getCreateDirectory/setCreateDirectory

→ inherited from SaveOptions
public boolean getCreateDirectory() / public void setCreateDirectory(boolean value)
If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

setCreateDirectory

→ inherited from SaveOptions
public void setCreateDirectory(boolean value)
If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

getSortNames/setSortNames

→ inherited from SaveOptions
public boolean getSortNames() / public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.

setSortNames

→ inherited from SaveOptions
public void setSortNames(boolean value)
Indicates whether sorting defined names before saving file.

getSortExternalNames/setSortExternalNames

→ inherited from SaveOptions
public boolean getSortExternalNames() / public void setSortExternalNames(boolean value)
Indicates whether sorting external defined names before saving file.

setSortExternalNames

→ inherited from SaveOptions
public void setSortExternalNames(boolean value)
Indicates whether sorting external defined names before saving file.

getRefreshChartCache/setRefreshChartCache

→ inherited from SaveOptions
public boolean getRefreshChartCache() / public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data

setRefreshChartCache

→ inherited from SaveOptions
public void setRefreshChartCache(boolean value)
Indicates whether refreshing chart cache data

getWarningCallback/setWarningCallback

→ inherited from SaveOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Gets or sets warning callback.

setWarningCallback

→ inherited from SaveOptions
public void setWarningCallback(IWarningCallback value)
Gets or sets warning callback.

getUpdateSmartArt/setUpdateSmartArt

→ inherited from SaveOptions
public boolean getUpdateSmartArt() / public void setUpdateSmartArt(boolean value)
Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

setUpdateSmartArt

→ inherited from SaveOptions
public void setUpdateSmartArt(boolean value)
Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.