images_folder_alias property

MarkdownSaveOptions.images_folder_alias property

Specifies the name of the folder used to construct image URIs written into a document. Default is an empty string.

@property
def images_folder_alias(self) -> str:
    ...

@images_folder_alias.setter
def images_folder_alias(self, value: str):
    ...

Remarks

When you save a Document in SaveFormat.MARKDOWN format, Aspose.Words needs to save all images embedded in the document as standalone files. MarkdownSaveOptions.images_folder allows you to specify where the images will be saved and MarkdownSaveOptions.images_folder_alias allows to specify how the image URIs will be constructed.

If MarkdownSaveOptions.images_folder_alias is not an empty string, then the image URI written to Markdown will be ImagesFolderAlias + <image file name>.

If MarkdownSaveOptions.images_folder_alias is an empty string, then the image URI written to Markdown will be ImagesFolder + <image file name>.

If MarkdownSaveOptions.images_folder_alias is set to ‘.’ (dot), then the image file name will be written to Markdown without path regardless of other options.

Examples

Shows how to specifies the name of the folder used to construct image URIs.

builder = aw.DocumentBuilder()

builder.writeln("Some image below:")
builder.insert_image(IMAGE_DIR + "Logo.jpg")

saveOptions = aw.saving.MarkdownSaveOptions()
# Use the "ImagesFolder" property to assign a folder in the local file system into which
# Aspose.Words will save all the document's linked images.
saveOptions.images_folder = ARTIFACTS_DIR + "ImagesDir/"
# Use the "ImagesFolderAlias" property to use this folder
# when constructing image URIs instead of the images folder's name.
saveOptions.images_folder_alias = "http://example.com/images"
builder.document.save(ARTIFACTS_DIR + "MarkdownSaveOptions.ImagesFolder.md", saveOptions)

See Also

MarkdownSaveOptions.images_folder property MarkdownSaveOptions.list_export_mode property