asposecells.api
Class TxtSaveOptions

Repesents the save options for csv/tab delimitered/other text format.

Constructor Summary
TxtSaveOptions()
           Creates text file save options.
TxtSaveOptions(format)
           Creates text file save options.
 
Property Getters/Setters Summary
methodgetAlwaysQuoted()
methodsetAlwaysQuoted(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.
methodgetCachedFileFolder()
methodsetCachedFileFolder(value)
           The cached file folder is used to store some large data.
methodgetClearData()
methodsetClearData(value)
           Make the workbook empty after saving the file.
methodgetCreateDirectory()
methodsetCreateDirectory(value)
           If true and the directory does not exist, the directory will be automatically created before saving the file.
methodgetEnableHTTPCompression()
methodsetEnableHTTPCompression(value)
           Indicates if http compression is to be used in user's IIS.
methodgetEncoding()
methodsetEncoding(value)
           Gets and sets the default encoding.
methodgetFormatStrategy()
methodsetFormatStrategy(value)
           Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
methodgetKeepSeparatorsForBlankRow()
methodsetKeepSeparatorsForBlankRow(value)
           Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.
methodgetLightCellsDataProvider()
methodsetLightCellsDataProvider(value)
           The Data provider to provide cells data for saving workbook in light mode.
methodgetMergeAreas()
methodsetMergeAreas(value)
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
methodgetPdfExportImagesFolder()
methodsetPdfExportImagesFolder(value)
           The physical folder where images will be saved when exporting a workbook to Aspose.Pdf XML format. Default is an empty string.
methodgetQuoteType()
methodsetQuoteType(value)
           Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
methodgetRefreshChartCache()
methodsetRefreshChartCache(value)
           Indicates whether refreshing chart cache data
methodgetSaveFormat()
           Gets the save file format. The value of the property is SaveFormat integer constant.
methodgetSeparator()
methodsetSeparator(value)
           Gets and sets char Delimiter of text file.
methodgetSeparatorString()
methodsetSeparatorString(value)
           Gets and sets the a string value as separator.
methodgetSortNames()
methodsetSortNames(value)
           Indicates whether sorting defined names before saving file.
methodgetTrimLeadingBlankRowAndColumn()
methodsetTrimLeadingBlankRowAndColumn(value)
           Indicates whether leading blank rows and columns should be trimmed like what ms excel does.
methodgetValidateMergedAreas()
methodsetValidateMergedAreas(value)
           Indicates whether validate merged cells before saving the file.
 

Constructor Detail

TxtSaveOptions

TxtSaveOptions()
Creates text file save options.

TxtSaveOptions

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

Property Getters/Setters Detail

getSeparator/setSeparator : char 

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

getSeparatorString/setSeparatorString : String 

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

getEncoding/setEncoding : Encoding 

Encoding getEncoding() / setEncoding(value)
Gets and sets the default encoding.

getAlwaysQuoted/setAlwaysQuoted : boolean 

boolean getAlwaysQuoted() / setAlwaysQuoted(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 : int 

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

getFormatStrategy/setFormatStrategy : int 

int getFormatStrategy() / setFormatStrategy(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 : LightCellsDataProvider 

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

getTrimLeadingBlankRowAndColumn/setTrimLeadingBlankRowAndColumn : boolean 

boolean getTrimLeadingBlankRowAndColumn() / setTrimLeadingBlankRowAndColumn(value)
Indicates whether leading blank rows and columns should be trimmed like what ms excel does.

getKeepSeparatorsForBlankRow/setKeepSeparatorsForBlankRow : boolean 

boolean getKeepSeparatorsForBlankRow() / setKeepSeparatorsForBlankRow(value)
Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.

getSaveFormat : int 

int getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.

getClearData/setClearData : boolean 

boolean getClearData() / setClearData(value)
Make the workbook empty after saving the file.

getCachedFileFolder/setCachedFileFolder : String 

String getCachedFileFolder() / setCachedFileFolder(value)
The cached file folder is used to store some large data.

getValidateMergedAreas/setValidateMergedAreas : boolean 

boolean getValidateMergedAreas() / setValidateMergedAreas(value)
Indicates whether validate merged cells before saving the file. The default value is false.

getMergeAreas/setMergeAreas : boolean 

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

getCreateDirectory/setCreateDirectory : boolean 

boolean getCreateDirectory() / setCreateDirectory(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 : boolean 

boolean getSortNames() / setSortNames(value)
Indicates whether sorting defined names before saving file.

getRefreshChartCache/setRefreshChartCache : boolean 

boolean getRefreshChartCache() / setRefreshChartCache(value)
Indicates whether refreshing chart cache data

getPdfExportImagesFolder/setPdfExportImagesFolder : String 

String getPdfExportImagesFolder() / setPdfExportImagesFolder(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 : boolean 

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

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