com.aspose.cells
Class TxtSaveOptions

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

public class TxtSaveOptions 
extends SaveOptions

Repesents the save options for csv/tab delimitered/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 value)
           Indicates whether always adding '"' for each field. If true then all values will be quoted; If false then only quote values when needed(when values contain special characters such as '"' , '\n' or separator character). Default is false.
java.lang.StringgetCachedFileFolder()→ inherited from SaveOptions
voidsetCachedFileFolder(java.lang.String value)
           The cached file folder is used to store some large data.
booleangetClearData()→ inherited from SaveOptions
voidsetClearData(boolean value)
           Make the workbook empty after saving the file.
booleangetCreateDirectory()→ inherited from SaveOptions
voidsetCreateDirectory(boolean value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
booleangetEnableHTTPCompression()→ inherited from SaveOptions
voidsetEnableHTTPCompression(boolean value)
           Indicates if http compression is to be used in user's IIS.
EncodinggetEncoding()
voidsetEncoding(Encoding value)
           Gets and sets the default encoding.Only applies for csv file.
intgetFormatStrategy()
voidsetFormatStrategy(int value)
           Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
LightCellsDataProvidergetLightCellsDataProvider()
voidsetLightCellsDataProvider(LightCellsDataProvider value)
           The Data provider to provide cells data for saving workbook in light mode.
booleangetMergeAreas()→ inherited from SaveOptions
voidsetMergeAreas(boolean value)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
java.lang.StringgetPdfExportImagesFolder()→ inherited from SaveOptions
voidsetPdfExportImagesFolder(java.lang.String value)
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
intgetQuoteType()
voidsetQuoteType(int value)
           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 value)
           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 value)
           Gets and sets char Delimiter of text file.
java.lang.StringgetSeparatorString()
voidsetSeparatorString(java.lang.String value)
           Gets and sets the a string value as separator.
booleangetSortNames()→ inherited from SaveOptions
voidsetSortNames(boolean value)
           Indicates whether sorting defined names before saving file.
booleangetTrimLeadingBlankRowAndColumn()
voidsetTrimLeadingBlankRowAndColumn(boolean value)
           Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
booleangetValidateMergedAreas()→ inherited from SaveOptions
voidsetValidateMergedAreas(boolean value)
           Indicates whether validate merged cells before saving the file.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback value)
           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 foramt 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.

getSeparatorString/setSeparatorString

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

getEncoding/setEncoding

public Encoding getEncoding() / public void setEncoding(Encoding value)
Gets and sets the default encoding.Only applies for csv file.

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 only quote values when needed(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.

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.

getLightCellsDataProvider/setLightCellsDataProvider

public LightCellsDataProvider getLightCellsDataProvider() / 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.

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.

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.

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.

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.

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.

getSortNames/setSortNames

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

getRefreshChartCache/setRefreshChartCache

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

getPdfExportImagesFolder/setPdfExportImagesFolder

→ inherited from SaveOptions
public java.lang.String getPdfExportImagesFolder() / public void setPdfExportImagesFolder(java.lang.String value)
The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.

getEnableHTTPCompression/setEnableHTTPCompression

→ inherited from SaveOptions
public boolean getEnableHTTPCompression() / public void setEnableHTTPCompression(boolean value)
Indicates if http compression is to be used in user's IIS. Please specify this property to true if http compression is used.

getWarningCallback/setWarningCallback

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

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