MarkdownSaveOptions class

MarkdownSaveOptions class

Represents the save options for markdown.

Inheritance: MarkdownSaveOptions → SaveOptions

The MarkdownSaveOptions type exposes the following members:

Constructors

ConstructorDescription
__init__(self)Creates options for saving markdown document

Properties

PropertyDescription
save_formatGets the save file format.
clear_dataMake the workbook empty after saving the file.
cached_file_folderThe folder for temporary files that may be used as data cache.
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.
check_excel_restrictionWhether check restriction of excel file when user modify cells related objects.
For example, excel does not allow inputting string value longer than 32K.
When you input a value longer than 32K, it will be truncated.
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.
encodingGets and sets the default encoding.
format_strategyGets and sets the format strategy when exporting the cell value as string.
light_cells_data_providerThe Data provider to provide cells data for saving workbook in light mode.
line_separatorGets and sets the line separator.
table_header_typeGets and sets how set the header of the table.
sheet_setGets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.active.
image_optionsGet the ImageOrPrintOptions object before exporting
export_images_as_base64Specifies whether images are saved in Base64 format to Markdown.
The default value is true.
stream_providerGets or sets the IStreamProvider for exporting objects.
If null, the exported objects will be saved to the same directory as the output file.
calculate_formulaIndicates whether to calculate formulas before saving markdown file.
export_hyperlink_as_referenceIndicates whether to export hyperlink using reference definitions instead of inline format.
The default value is false.
align_column_paddingIndicates whether column alignment is enabled for generated Markdown tables.
When enabled, columns are aligned by padding cell content with the specified character(typically ’ ’ for spaces).
Set to ‘\0’ to disable column alignment (default).
split_tables_by_blank_rowIndicates whether blank rows in the worksheet should be treated as table separators when exporting to Markdown.
The default value is false.

See Also

MarkdownLoadOptions class MemoryFontSource class