com.groupdocs.markdown

Class DocumentConverterOptions

java.lang.Object

com.groupdocs.markdown.LoadOptions

com.groupdocs.markdown.DocumentConverterOptions

public class DocumentConverterOptions
extends LoadOptions

Provides options for customizing the document conversion process to Markdown format.

This class allows configuration of how documents are converted to Markdown, particularly how images are handled during the conversion process. By default, images are embedded as Base64 strings in the Markdown output.

Examples:

 // Example 1: Using default options (images embedded as Base64)
 DocumentConverterOptions defaultOptions = new DocumentConverterOptions();
 // Images will be embedded as Base64 strings in the Markdown

 // Example 2: Saving images to a folder
 DocumentConverterOptions fileSystemOptions = new DocumentConverterOptions();
 fileSystemOptions.setImageExportStrategy(new ExportImagesToFileSystemStrategy("output/images"));

 // Example 3: Skipping image export
 DocumentConverterOptions skipImagesOptions = new DocumentConverterOptions();
 skipImagesOptions.setImageExportStrategy(new SkipImagesStrategy());

 // Example 4: Using a custom image export strategy
 DocumentConverterOptions customOptions = new DocumentConverterOptions();
 customOptions.setImageExportStrategy(new CustomImageExportStrategy());
 

Constructor Summary

Constructors

Constructor and Description
DocumentConverterOptions() Initializes a new instance of the DocumentConverterOptions class.

Method Summary

Modifier and Type	Method and Description
IImageExportStrategy	getImageExportStrategy() Gets the current image export strategy.
List<Integer>	getPageNumbers() Gets the array of page or worksheet numbers to convert.
void	setImageExportStrategy(IImageExportStrategy imageExportStrategy) Sets the image export strategy.
void	setPageNumbers(List<Integer> pageNumbers) Sets the array of page or worksheet numbers to convert.

Methods inherited from class com.groupdocs.markdown.LoadOptions

getExtension, getFileFormat, getMimeType, getPassword, setExtension, setFileFormat, setMimeType, setPassword

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentConverterOptions

public DocumentConverterOptions()

Initializes a new instance of the DocumentConverterOptions class.

By default, the getImageExportStrategy() is set to ExportImagesAsBase64Strategy, which embeds images as Base64 strings directly in the Markdown output.

Method Detail

getImageExportStrategy

public IImageExportStrategy getImageExportStrategy()

Gets the current image export strategy.

Returns:

The image export strategy.

setImageExportStrategy

public void setImageExportStrategy(IImageExportStrategy imageExportStrategy)

Sets the image export strategy.

Parameters:

imageExportStrategy - The strategy to use for image export.

getPageNumbers

public List<Integer> getPageNumbers()

Gets the array of page or worksheet numbers to convert.

Returns:

An array of page numbers, or null if not set.

setPageNumbers

public void setPageNumbers(List<Integer> pageNumbers)

Sets the array of page or worksheet numbers to convert.

Parameters:

pageNumbers - The page or worksheet numbers to convert.