TxtSaveOptions class

TxtSaveOptions class

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

Inheritance: TxtSaveOptions → SaveOptions

The TxtSaveOptions type exposes the following members:

Constructors

ConstructorDescription
initCreates text file save options.
initCreates text file save options.

Properties

PropertyDescription
save_formatGets the save file format.
clear_dataMake the workbook empty after saving the file.
cached_file_folderThe cached file folder is used to store some large data.
validate_merged_areasIndicates whether validate merged cells before saving the file.
merge_areasIndicates whether merge the areas of conditional formatting and validation before saving the file.
create_directoryIf true and the directory does not exist, the directory will be automatically created before saving the file.
sort_namesIndicates whether sorting defined names before saving file.
sort_external_namesIndicates whether sorting external defined names before saving file.
refresh_chart_cacheIndicates whether refreshing chart cache data
warning_callbackGets or sets warning callback.
update_smart_artIndicates whether updating smart art setting.
The default value is false.
encrypt_document_propertiesIndicates whether encrypt document properties when saving as .xls file.
The default value is true.
separatorGets and sets char Delimiter of text file.
separator_stringGets and sets a string value as separator.
encodingGets and sets the default encoding.
always_quotedIndicates 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.
quote_typeGets or sets how to quote values in the exported text file.
format_strategyGets and sets the format strategy when exporting the cell value as string.
light_cells_data_providerThe data provider for saving workbook in light mode.
trim_leading_blank_row_and_columnIndicates whether leading blank rows and columns should be trimmed like what ms excel does.
Default is true.
trim_tailing_blank_cellsIndicates whether tailing blank cells in one row should be trimmed. Default is false.
keep_separators_for_blank_rowIndicates whether separators should be output for blank row.
Default value is false so by default the content for blank row will be empty.
export_areaThe range of cells to be exported.
export_quote_prefixIndicates whether the single quote sign should be exported as part of the value of one cell
when Style.quote_prefix is true for it. Default is false.
export_all_sheetsIndicates whether exporting all sheets to the text file.
If it is false, only export the activesheet, just like MS Excel.

See Also

TxtLoadOptions class UnionRange class