com.groupdocs.editor.options

Class MarkdownSaveOptions

java.lang.Object

com.groupdocs.editor.options.MarkdownSaveOptions

All Implemented Interfaces:

ISaveOptions

public final class MarkdownSaveOptions
extends Object
implements ISaveOptions

Allows to specify custom options for generating and saving Markdown documents

MarkdownSaveOptions class must be applied by the user when there is an instance of EditableDocument class, that contains an edited document content, and it is required to save this content to the new document of Markdown format.

Constructor Summary

Constructors

Constructor and Description
MarkdownSaveOptions()

Method Summary

Modifier and Type	Method and Description
boolean	getExportImagesAsBase64() Specifies whether images are saved in Base64 format to the output file.
String	getImagesFolder() Specifies the physical folder where images are saved when exporting a document to the Markdown format.
boolean	getOptimizeMemoryUsage() Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
int	getTableContentAlignment() Allow specifies how to align contents in tables when exporting into the Markdown format.
void	setExportImagesAsBase64(boolean value) Specifies whether images are saved in Base64 format to the output file.
void	setImagesFolder(String value) Specifies the physical folder where images are saved when exporting a document to the Markdown format.
void	setOptimizeMemoryUsage(boolean value) Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage.
void	setTableContentAlignment(int value) Allow specifies how to align contents in tables when exporting into the Markdown format.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownSaveOptions

public MarkdownSaveOptions()

Method Detail

getExportImagesAsBase64

public final boolean getExportImagesAsBase64()

Specifies whether images are saved in Base64 format to the output file. Default is false.

When this property is set to true, then images data are exported directly into the image elements ![]() and separate files are not created. This property, if set to true, has the higher priority than the MarkdownSaveOptions.ImagesFolder(getImagesFolder()/setImagesFolder(String)) property.

getImagesFolder

public final String getImagesFolder()

Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null.

If neither the ImagesFolder(getImagesFolder()/setImagesFolder(String)) nor ExportImagesAsBase64(getExportImagesAsBase64()/setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the ImagesFolder(getImagesFolder()/setImagesFolder(String)) by itself and apply it on success

getOptimizeMemoryUsage

public final boolean getOptimizeMemoryUsage()

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

getTableContentAlignment

public final int getTableContentAlignment()

Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is MarkdownTableContentAlignment.Auto.

Value: The table content alignment

setExportImagesAsBase64

public final void setExportImagesAsBase64(boolean value)

Specifies whether images are saved in Base64 format to the output file. Default is false.

When this property is set to true, then images data are exported directly into the image elements ![]() and separate files are not created. This property, if set to true, has the higher priority than the MarkdownSaveOptions.ImagesFolder(getImagesFolder()/setImagesFolder(String)) property.

setImagesFolder

public final void setImagesFolder(String value)

Specifies the physical folder where images are saved when exporting a document to the Markdown format. Default is null.

If neither the ImagesFolder(getImagesFolder()/setImagesFolder(String)) nor ExportImagesAsBase64(getExportImagesAsBase64()/setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the ImagesFolder(getImagesFolder()/setImagesFolder(String)) by itself and apply it on success

setOptimizeMemoryUsage

public final void setOptimizeMemoryUsage(boolean value)

Enables memory optimization mechanisms during document generation from HTML, which degrades performance in as a cost of decreasing memory usage. Setting this option to true can significantly decrease memory consumption while generating large documents at the cost of slower saving time. Default is false (memory optimization is disabled for the sake of better performance).

setTableContentAlignment

public final void setTableContentAlignment(int value)

Allow specifies how to align contents in tables when exporting into the Markdown format. The default value is MarkdownTableContentAlignment.Auto.

Value: The table content alignment