Aspose::Cells::TxtSaveOptions class

TxtSaveOptions class

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

class TxtSaveOptions : public Aspose::Cells::SaveOptions

Methods

MethodDescription
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.
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.
GetExportArea()The range of cells to be exported.
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.
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.
GetQuoteType()Gets or sets how to quote values in the exported text file.
GetRefreshChartCache()Indicates whether refreshing chart cache data.
GetSaveFormat()Gets the save file format.
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.
GetTrimTailingBlankCells()Indicates whether tailing blank cells in one row should be trimmed. Default is false.
GetUpdateSmartArt()Indicates whether updating smart art setting. The default value is false.
GetValidateMergedAreas()Indicates whether validate merged cells before saving the file.
GetWarningCallback()Gets or sets warning callback.
IsNull() constChecks whether the implementation object is nullptr.
explicit operator bool() constoperator bool()
operator=(const TxtSaveOptions& src)operator=
operator=(const SaveOptions& src)operator=
SaveOptions(SaveOptions_Impl* impl)Constructs from an implementation object.
SaveOptions(const SaveOptions& src)Copy constructor.
SetCachedFileFolder(const U16String& value)The cached file folder is used to store some large data.
SetCachedFileFolder(const char16_t* value)The cached file folder is used to store some large data.
SetClearData(bool value)Make the workbook empty after saving the file.
SetCreateDirectory(bool value)If true and the directory does not exist, the directory will be automatically created before saving the file.
SetEncoding(EncodingType value)Gets and sets the default encoding.
SetExportAllSheets(bool value)Indicates whether exporting all sheets to the text file. If it is false, only export the activesheet, just like MS Excel.
SetExportArea(const CellArea& value)The range of cells to be exported.
SetExportQuotePrefix(bool 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.
SetFormatStrategy(CellValueFormatStrategy value)Gets and sets the format strategy when exporting the cell value as string.
SetKeepSeparatorsForBlankRow(bool 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.
SetLightCellsDataProvider(LightCellsDataProvider* value)The data provider for saving workbook in light mode.
SetMergeAreas(bool value)Indicates whether merge the areas of conditional formatting and validation before saving the file.
SetQuoteType(TxtValueQuoteType value)Gets or sets how to quote values in the exported text file.
SetRefreshChartCache(bool value)Indicates whether refreshing chart cache data.
SetSeparator(char16_t value)Gets and sets char Delimiter of text file.
SetSeparatorString(const U16String& value)Gets and sets a string value as separator.
SetSeparatorString(const char16_t* value)Gets and sets a string value as separator.
SetSortExternalNames(bool value)Indicates whether sorting external defined names before saving file.
SetSortNames(bool value)Indicates whether sorting defined names before saving file.
SetTrimLeadingBlankRowAndColumn(bool value)Indicates whether leading blank rows and columns should be trimmed like what ms excel does. Default is true.
SetTrimTailingBlankCells(bool value)Indicates whether tailing blank cells in one row should be trimmed. Default is false.
SetUpdateSmartArt(bool value)Indicates whether updating smart art setting. The default value is false.
SetValidateMergedAreas(bool value)Indicates whether validate merged cells before saving the file.
SetWarningCallback(IWarningCallback* value)Gets or sets warning callback.
TxtSaveOptions()Creates text file save options.
explicit TxtSaveOptions(SaveFormat saveFormat)Creates text file save options.
TxtSaveOptions(TxtSaveOptions_Impl* impl)Constructs from an implementation object.
TxtSaveOptions(const TxtSaveOptions& src)Copy constructor.
TxtSaveOptions(const SaveOptions& src)Constructs from a parent object.
~SaveOptions()Destructor.
~TxtSaveOptions()Destructor.

Fields

FieldDescription
_implThe implementation object.

See Also