com.groupdocs.markdown

Class ExportImagesToFileSystemStrategy

java.lang.Object

com.groupdocs.markdown.ExportImagesToFileSystemStrategy

All Implemented Interfaces:

IImageExportStrategy

public class ExportImagesToFileSystemStrategy
extends Object
implements IImageExportStrategy

Saves images to a folder on disk during conversion.

By default, the Markdown output references images using the full imagesFolder path. Set imagesRelativePath to control the path that appears in the Markdown image links — typically a path relative to the output .md file.

Example:

 ExportImagesToFileSystemStrategy strategy =
     new ExportImagesToFileSystemStrategy("c:/output/images");

 strategy.setImagesRelativePath("images");

 ConvertOptions options = new ConvertOptions();
 options.setImageExportStrategy(strategy);

 MarkdownConverter.toFile("document.docx", "c:/output/doc.md", options);
 // Markdown: ![](images/img-001.png)
 // File:     c:/output/images/img-001.png
 

Constructor Summary

Constructors

Constructor and Description
ExportImagesToFileSystemStrategy(String imagesFolder) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
String	getImagesFolder() Gets the physical folder where images will be saved on disk.
String	getImagesRelativePath() Gets or sets the path used in Markdown image references.
OutputStream	getImageStream(ImageExportContext context) Gets a stream for writing the exported image to the file system.
void	setImagesRelativePath(String imagesRelativePath)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportImagesToFileSystemStrategy

public ExportImagesToFileSystemStrategy(String imagesFolder)

Initializes a new instance.

Parameters:

imagesFolder - physical folder where images will be saved

Method Detail

getImagesFolder

public String getImagesFolder()

Gets the physical folder where images will be saved on disk.

Specified by:

getImagesFolder in interface IImageExportStrategy

Returns:

a relative or absolute folder path. This value is used to construct image URIs in the Markdown output.

getImagesRelativePath

public String getImagesRelativePath()

Gets or sets the path used in Markdown image references.

setImagesRelativePath

public void setImagesRelativePath(String imagesRelativePath)

getImageStream

public OutputStream getImageStream(ImageExportContext context)

Gets a stream for writing the exported image to the file system.

Specified by:

getImageStream in interface IImageExportStrategy

Parameters:

context - The image export context containing the default image file name and other metadata. You may modify imageFileName before returning the stream to change the file name that appears in the Markdown output.

Returns:

a writable stream where the image data will be written, or null to use the default behavior