MarkdownSaveOptions class

MarkdownSaveOptions class

Class to specify additional options when saving a document into the SaveFormat.MARKDOWN format. To learn more, visit the Specify Save Options documentation article.

Inheritance: MarkdownSaveOptions → TxtSaveOptionsBase → SaveOptions

Constructors

NameDescription
MarkdownSaveOptions()Initializes a new instance of this class that can be used to save a document in the SaveFormat.MARKDOWN format.

Properties

NameDescription
allow_embedding_post_script_fontsGets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is False.
(Inherited from SaveOptions)
default_templateGets or sets path to default template (including filename). Default value for this property is empty string ().
(Inherited from SaveOptions)
dml_3d_effects_rendering_modeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dml_effects_rendering_modeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dml_rendering_modeGets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions)
empty_paragraph_export_modeSpecifies how to export empty paragraphs to Markdown. Default value is MarkdownEmptyParagraphExportMode.EMPTY_LINE.
encodingSpecifies the encoding to use when exporting in text formats. Default value is Encoding.UTF8.
(Inherited from TxtSaveOptionsBase)
export_as_htmlAllows to specify the elements to be exported to Markdown as raw HTML. Default value is MarkdownExportAsHtml.NONE.
export_generator_nameWhen True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.
(Inherited from SaveOptions)
export_headers_footers_modeSpecifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY.
(Inherited from TxtSaveOptionsBase)
export_images_as_base64Specifies whether images are saved in Base64 format to the output file. Default value is False.
export_underline_formattingGets or sets a boolean value indicating either to export underline text formatting as sequence of two plus characters “++”. The default value is False.
force_page_breaksAllows to specify whether the page breaks should be preserved during export.
(Inherited from TxtSaveOptionsBase)
image_resolutionSpecifies the output resolution for images when exporting to Markdown. Default is 96 dpi.
image_saving_callbackAllows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.
images_folderSpecifies the physical folder where images are saved when exporting a document to the SaveFormat.MARKDOWN format. Default is an empty string.
images_folder_aliasSpecifies the name of the folder used to construct image URIs written into a document. Default is an empty string.
iml_rendering_modeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
link_export_modeSpecifies how links will be written to the output file. Default value is MarkdownLinkExportMode.AUTO.
list_export_modeSpecifies how list items will be written to the output file. Default value is MarkdownListExportMode.MARKDOWN_SYNTAX.
memory_optimizationGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.
(Inherited from SaveOptions)
office_math_export_modeSpecifies how OfficeMath will be written to the output file. Default value is MarkdownOfficeMathExportMode.TEXT.
paragraph_breakSpecifies the string to use as a paragraph break when exporting in text formats.
(Inherited from TxtSaveOptionsBase)
pretty_formatWhen True, pretty formats output where applicable. Default value is False.
(Inherited from SaveOptions)
progress_callbackCalled during saving a document and accepts data about saving progress.
(Inherited from SaveOptions)
resource_saving_callbackAllows to control how resources are saved when a document is exported to SaveFormat.MARKDOWN format.
save_formatSpecifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.MARKDOWN.
table_content_alignmentGets or sets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The default value is TableContentAlignment.AUTO.
temp_folderSpecifies the folder for temporary files used when saving to a DOC or DOCX file. By default, this property is None and no temporary files are used.
(Inherited from SaveOptions)
update_ambiguous_text_fontDetermines whether the font attributes will be changed according to the character code being used.
(Inherited from SaveOptions)
update_created_time_propertyGets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;
(Inherited from SaveOptions)
update_fieldsGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is True.
(Inherited from SaveOptions)
update_last_printed_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving.
(Inherited from SaveOptions)
update_last_saved_time_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving.
(Inherited from SaveOptions)
update_ole_control_imagesGets or sets a value determining whether OLE controls presentation image will be updated.
(Inherited from SaveOptions)
use_anti_aliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
use_high_quality_renderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)

Methods

NameDescription
create_save_options(save_format)Creates a save options object of a class suitable for the specified save format.
(Inherited from SaveOptions)
create_save_options(file_name)Creates a save options object of a class suitable for the file extension specified in the given file name.
(Inherited from SaveOptions)

Examples

Shows how to rename the image name during saving into Markdown document.

doc = aw.Document(file_name=MY_DIR + 'Rendering.docx')
save_options = aw.saving.MarkdownSaveOptions()
# If we convert a document that contains images into Markdown, we will end up with one Markdown file which links to several images.
# Each image will be in the form of a file in the local file system.
# There is also a callback that can customize the name and file system location of each image.
save_options.image_saving_callback = self.SavedImageRename('MarkdownSaveOptions.HandleDocument.md')
save_options.save_format = aw.SaveFormat.MARKDOWN
# The ImageSaving() method of our callback will be run at this time.
doc.save(file_name=ARTIFACTS_DIR + 'MarkdownSaveOptions.HandleDocument.md', save_options=save_options)
self.assertEqual(1, len(list(filter(lambda f: f.endswith('.jpeg'), list(filter(lambda s: s.startswith(ARTIFACTS_DIR + 'MarkdownSaveOptions.HandleDocument.md shape'), list(system_helper.io.Directory.get_files(ARTIFACTS_DIR))))))))
self.assertEqual(8, len(list(filter(lambda f: f.endswith('.png'), list(filter(lambda s: s.startswith(ARTIFACTS_DIR + 'MarkdownSaveOptions.HandleDocument.md shape'), list(system_helper.io.Directory.get_files(ARTIFACTS_DIR))))))))

Shows how to rename the image name during saving into Markdown document (SavedImageRename).

class SavedImageRename(aw.saving.IImageSavingCallback):

    def __init__(self, out_file_name):
        self.m_out_file_name = out_file_name
        self.m_count = 0

    def image_saving(self, args):
        from pathlib import Path
        self.m_count += 1
        image_file_name = f'{self.m_out_file_name} shape {self.m_count}, of type {args.current_shape.shape_type}{Path(args.image_file_name).suffix}'
        args.image_file_name = image_file_name
        args.image_stream = system_helper.io.FileStream(ARTIFACTS_DIR + image_file_name, system_helper.io.FileMode.CREATE)
        assert args.is_image_available
        assert not args.keep_image_stream_open

See Also

MarkdownOfficeMathExportMode enumeration MetafileRenderingMode enumeration