asposecells.api

Classes

Constants

Class TxtSaveOptions

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

Constructor Summary
`TxtSaveOptions()` Creates text file save options.
`TxtSaveOptions(saveFormat)` Creates text file save options.

Property Getters/Setters Summary
`method`	`getAlwaysQuoted()`
`method`	`setAlwaysQuoted(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.
`method`	`getCachedFileFolder()`
`method`	`setCachedFileFolder(value)`
	The cached file folder is used to store some large data.
`method`	`getClearData()`
`method`	`setClearData(value)`
	Make the workbook empty after saving the file.
`method`	`getCreateDirectory()`
`method`	`setCreateDirectory(value)`
	If true and the directory does not exist, the directory will be automatically created before saving the file.
`method`	`getEncoding()`
`method`	`setEncoding(value)`
	Gets and sets the default encoding.
`method`	`getExportAllSheets()`
`method`	`setExportAllSheets(value)`
	Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
`method`	`getExportArea()`
`method`	`setExportArea(value)`
	The range of cells to be exported.
`method`	`getExportQuotePrefix()`
`method`	`setExportQuotePrefix(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.
`method`	`getFormatStrategy()`
`method`	`setFormatStrategy(value)`
	Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
`method`	`getKeepSeparatorsForBlankRow()`
`method`	`setKeepSeparatorsForBlankRow(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.
`method`	`getLightCellsDataProvider()`
`method`	`setLightCellsDataProvider(value)`
	The data provider for saving workbook in light mode.
`method`	`getMergeAreas()`
`method`	`setMergeAreas(value)`
	Indicates whether merge the areas of conditional formatting and validation before saving the file.
`method`	`getQuoteType()`
`method`	`setQuoteType(value)`
	Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
`method`	`getRefreshChartCache()`
`method`	`setRefreshChartCache(value)`
	Indicates whether refreshing chart cache data
`method`	`getSaveFormat()`
	Gets the save file format. The value of the property is SaveFormat integer constant.
`method`	`getSeparator()`
`method`	`setSeparator(value)`
	Gets and sets char Delimiter of text file.
`method`	`getSeparatorString()`
`method`	`setSeparatorString(value)`
	Gets and sets a string value as separator.
`method`	`getSortExternalNames()`
`method`	`setSortExternalNames(value)`
	Indicates whether sorting external defined names before saving file.
`method`	`getSortNames()`
`method`	`setSortNames(value)`
	Indicates whether sorting defined names before saving file.
`method`	`getTrimLeadingBlankRowAndColumn()`
`method`	`setTrimLeadingBlankRowAndColumn(value)`
	Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
`method`	`getTrimTailingBlankCells()`
`method`	`setTrimTailingBlankCells(value)`
	Indicates whether tailing blank cells in one row should be trimmed. Default is false.
`method`	`getUpdateSmartArt()`
`method`	`setUpdateSmartArt(value)`
	Indicates whether updating smart art setting. The default value is false.
`method`	`getValidateMergedAreas()`
`method`	`setValidateMergedAreas(value)`
	Indicates whether validate merged cells before saving the file.

- Constructor Detail
  - TxtSaveOptions
```
TxtSaveOptions()
```
    Creates text file save options.
  - TxtSaveOptions
```
TxtSaveOptions(saveFormat)
```
    Creates text file save options.
    Parameters:
    saveFormat: int - A SaveFormat value. The file format. It should be SaveFormat.CSV or SaveFormat.TSV, otherwise the saved format will be set as SaveFormat.CSV automatically.
- 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 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 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 : 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 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. 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 : boolean
```
boolean getTrimTailingBlankCells() / setTrimTailingBlankCells(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 : boolean
```
boolean getKeepSeparatorsForBlankRow() / setKeepSeparatorsForBlankRow(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 : CellArea
```
CellArea getExportArea() / setExportArea(value)
```
    The range of cells to be exported.
    If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.
  - getExportQuotePrefix/setExportQuotePrefix : boolean
```
boolean getExportQuotePrefix() / setExportQuotePrefix(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 : boolean
```
boolean getExportAllSheets() / setExportAllSheets(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 : 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.
  - getSortExternalNames/setSortExternalNames : boolean
```
boolean getSortExternalNames() / setSortExternalNames(value)
```
    Indicates whether sorting external defined names before saving file.
  - getRefreshChartCache/setRefreshChartCache : boolean
```
boolean getRefreshChartCache() / setRefreshChartCache(value)
```
    Indicates whether refreshing chart cache data
  - getUpdateSmartArt/setUpdateSmartArt : boolean
```
boolean getUpdateSmartArt() / setUpdateSmartArt(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.

asposecells.api

Classes

Constants

Class TxtSaveOptions

Constructor Detail

TxtSaveOptions

TxtSaveOptions

Property Getters/Setters Detail

getSeparator/setSeparator : char

getSeparatorString/setSeparatorString : String

getEncoding/setEncoding : Encoding

getAlwaysQuoted/setAlwaysQuoted : boolean

getQuoteType/setQuoteType : int

getFormatStrategy/setFormatStrategy : int

getLightCellsDataProvider/setLightCellsDataProvider : LightCellsDataProvider

getTrimLeadingBlankRowAndColumn/setTrimLeadingBlankRowAndColumn : boolean

getTrimTailingBlankCells/setTrimTailingBlankCells : boolean

getKeepSeparatorsForBlankRow/setKeepSeparatorsForBlankRow : boolean

getExportArea/setExportArea : CellArea

getExportQuotePrefix/setExportQuotePrefix : boolean

getExportAllSheets/setExportAllSheets : boolean

getSaveFormat : int

getClearData/setClearData : boolean

getCachedFileFolder/setCachedFileFolder : String

getValidateMergedAreas/setValidateMergedAreas : boolean

getMergeAreas/setMergeAreas : boolean

getCreateDirectory/setCreateDirectory : boolean

getSortNames/setSortNames : boolean

getSortExternalNames/setSortExternalNames : boolean

getRefreshChartCache/setRefreshChartCache : boolean

getUpdateSmartArt/setUpdateSmartArt : boolean