MarkdownSaveOptions

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.options.ISaveOptions

public final class MarkdownSaveOptions 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.

Constructors

Constructor Description
MarkdownSaveOptions()

Methods

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

MarkdownSaveOptions()

public MarkdownSaveOptions()

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).

Returns: boolean

setOptimizeMemoryUsage(boolean value)

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).

Parameters:

Parameter Type Description
value boolean

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

Returns: int

setTableContentAlignment(int value)

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

Parameters:

Parameter Type Description
value int

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.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) nor ExportImagesAsBase64 (#getExportImagesAsBase64.getExportImagesAsBase64/#setExportImagesAsBase64(boolean).setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the ImagesFolder (#getImagesFolder.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) by itself and apply it on success

Returns: java.lang.String

setImagesFolder(String value)

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.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) nor ExportImagesAsBase64 (#getExportImagesAsBase64.getExportImagesAsBase64/#setExportImagesAsBase64(boolean).setExportImagesAsBase64(boolean)) are specified by the user, then the GroupDocs.Editor will try to determine the ImagesFolder (#getImagesFolder.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) by itself and apply it on success

Parameters:

Parameter Type Description
value java.lang.String

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.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) property.

Returns: boolean

setExportImagesAsBase64(boolean value)

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.getImagesFolder/#setImagesFolder(String).setImagesFolder(String)) property.

Parameters:

Parameter Type Description
value boolean