TxtSaveOptions
Source: aspose.
Represents the save options for csv/tab delimited/other text format.
Methods
- constructor_overload$1(saveFormat)
- getAlwaysQuoted()
- getCachedFileFolder()
- getClearData()
- getCreateDirectory()
- getEncoding()
- getExportAllSheets()
- getExportArea()
- getExportQuotePrefix()
- getFormatStrategy()
- getKeepSeparatorsForBlankRow()
- getLightCellsDataProvider()
- getMergeAreas()
- getQuoteType()
- getRefreshChartCache()
- getSaveFormat()
- getSeparator()
- getSeparatorString()
- getSortExternalNames()
- getSortNames()
- getTrimLeadingBlankRowAndColumn()
- getTrimTailingBlankCells()
- getUpdateSmartArt()
- getValidateMergedAreas()
- setAlwaysQuoted()
- setCachedFileFolder()
- setClearData()
- setCreateDirectory()
- setEncoding()
- setExportAllSheets()
- setExportArea()
- setExportQuotePrefix()
- setFormatStrategy()
- setKeepSeparatorsForBlankRow()
- setLightCellsDataProvider()
- setMergeAreas()
- setQuoteType()
- setRefreshChartCache()
- setSeparator()
- setSeparatorString()
- setSortExternalNames()
- setSortNames()
- setTrimLeadingBlankRowAndColumn()
- setTrimTailingBlankCells()
- setUpdateSmartArt()
- setValidateMergedAreas()
new TxtSaveOptions()
Creates text file save options.
Methods
constructor_overload$1(saveFormat)
Creates text file save options.
Parameter
Name | Type | Optional | Description |
---|---|---|---|
saveFormat |
Number |
|
SaveFormat |
getAlwaysQuoted()
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.
getCachedFileFolder()
The cached file folder is used to store some large data.
getClearData()
Make the workbook empty after saving the file.
getCreateDirectory()
If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.
getEncoding()
Gets and sets the default encoding.
getExportAllSheets()
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.
getExportArea()
The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.
getExportQuotePrefix()
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.
getFormatStrategy()
Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
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.
getLightCellsDataProvider()
The data provider for saving workbook in light mode.
getMergeAreas()
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
getQuoteType()
Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
getRefreshChartCache()
Indicates whether refreshing chart cache data
getSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
getSeparator()
Gets and sets char Delimiter of text file.
getSeparatorString()
Gets and sets a string value as separator.
getSortExternalNames()
Indicates whether sorting external defined names before saving file.
getSortNames()
Indicates whether sorting defined names before saving file.
getTrimLeadingBlankRowAndColumn()
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()
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
getUpdateSmartArt()
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.
getValidateMergedAreas()
Indicates whether validate merged cells before saving the file. The default value is false.
setAlwaysQuoted()
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.
setCachedFileFolder()
The cached file folder is used to store some large data.
setClearData()
Make the workbook empty after saving the file.
setCreateDirectory()
If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.
setEncoding()
Gets and sets the default encoding.
setExportAllSheets()
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.
setExportArea()
The range of cells to be exported. If the exported area has been specified, TrimLeadingBlankRowAndColumn will takes no effect.
setExportQuotePrefix()
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.
setFormatStrategy()
Gets and sets the format strategy when exporting the cell value as string. The value of the property is CellValueFormatStrategy integer constant.
setKeepSeparatorsForBlankRow()
Indicates whether separators should be output for blank row. Default value is false so by default the content for blank row will be empty.
setLightCellsDataProvider()
The data provider for saving workbook in light mode.
setMergeAreas()
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
setQuoteType()
Gets or sets how to quote values in the exported text file. The value of the property is TxtValueQuoteType integer constant.
setRefreshChartCache()
Indicates whether refreshing chart cache data
setSeparator()
Gets and sets char Delimiter of text file.
setSeparatorString()
Gets and sets a string value as separator.
setSortExternalNames()
Indicates whether sorting external defined names before saving file.
setSortNames()
Indicates whether sorting defined names before saving file.
setTrimLeadingBlankRowAndColumn()
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
setTrimTailingBlankCells()
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
setUpdateSmartArt()
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.
setValidateMergedAreas()
Indicates whether validate merged cells before saving the file. The default value is false.