TextSaveOptions module

class TextSaveOptions.TextSaveOptions

Bases: SpireObject

Options for saving Excel files to text formats.

This class provides configuration options for controlling how Excel files are exported to text-based formats such as CSV or TSV. It allows customization of separator characters, encoding, and data inclusion settings.

property Encoding: Encoding

Gets or sets the character encoding for the output text file.

This determines the character encoding used when writing the text file. Default is UTF-8.

Returns:: The character encoding object.
Return type:: Encoding

property RetainBlankRowsAndCols: bool

Gets or sets whether to retain blank rows and columns in the output text file.

When set to True, empty rows and columns will be included in the exported text file. Default is False.

Returns:: True if blank rows and columns should be retained; otherwise, False.
Return type:: bool

property RetainHiddenData: bool

Gets or sets whether to retain hidden data in the output text file.

When set to True, hidden rows, columns, and sheets will be included in the exported text file. Default is True.

Returns:: True if hidden data should be retained; otherwise, False.
Return type:: bool

property Separator: str

Gets or sets the separator character for the output text file.

This character is used to separate values in the text file. Default is a comma (“,”).

Returns:: The separator character.
Return type:: str