com.aspose.words

Class MarkdownSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.TxtSaveOptionsBase

com.aspose.words.MarkdownSaveOptions

public class MarkdownSaveOptions
extends TxtSaveOptionsBase

Class to specify additional options when saving a document into the SaveFormat.MARKDOWN format.

To learn more, visit the Specify Save Options documentation article.

Constructor Summary

Constructors

Constructor and Description
MarkdownSaveOptions() Initializes a new instance of this class that can be used to save a document in the SaveFormat.MARKDOWN format.

Method Summary

Modifier and Type	Method and Description
boolean	getExportImagesAsBase64() Specifies whether images are saved in Base64 format to the output file.
IImageSavingCallback	getImageSavingCallback() Allows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.
java.lang.String	getImagesFolder() Specifies the physical folder where images are saved when exporting a document to the SaveFormat.MARKDOWN format.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
int	getTableContentAlignment() Gets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format.
void	setExportImagesAsBase64(boolean value) Specifies whether images are saved in Base64 format to the output file.
void	setImageSavingCallback(IImageSavingCallback value) Allows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.
void	setImagesFolder(java.lang.String value) Specifies the physical folder where images are saved when exporting a document to the SaveFormat.MARKDOWN format.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
void	setTableContentAlignment(int value) Sets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format.

Methods inherited from class com.aspose.words.TxtSaveOptionsBase

getEncoding, getExportHeadersFootersMode, getForcePageBreaks, getParagraphBreak, setEncoding, setExportHeadersFootersMode, setForcePageBreaks, setParagraphBreak

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownSaveOptions

public MarkdownSaveOptions()

Initializes a new instance of this class that can be used to save a document in the SaveFormat.MARKDOWN format.

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.MARKDOWN.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.MARKDOWN.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getTableContentAlignment

public int getTableContentAlignment()

Gets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The default value is TableContentAlignment.AUTO.

Returns:

A value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The returned value is one of TableContentAlignment constants.

setTableContentAlignment

public void setTableContentAlignment(int value)

Sets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The default value is TableContentAlignment.AUTO.

Parameters:

value - A value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The value must be one of TableContentAlignment constants.

getImagesFolder

public java.lang.String getImagesFolder()

Specifies the physical folder where images are saved when exporting a document to the SaveFormat.MARKDOWN format. Default is an empty string.

When you save a Document in SaveFormat.MARKDOWN format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use getImagesFolder() / setImagesFolder(java.lang.String) to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the getImagesFolder() / setImagesFolder(java.lang.String) property.

If the folder specified by getImagesFolder() / setImagesFolder(java.lang.String) doesn't exist, it will be created automatically.

Returns:

The corresponding String value.

setImagesFolder

public void setImagesFolder(java.lang.String value)

Specifies the physical folder where images are saved when exporting a document to the SaveFormat.MARKDOWN format. Default is an empty string.

When you save a Document in SaveFormat.MARKDOWN format, Aspose.Words needs to save all images embedded in the document as standalone files. getImagesFolder() / setImagesFolder(java.lang.String) allows you to specify where the images will be saved.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use getImagesFolder() / setImagesFolder(java.lang.String) to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the getImagesFolder() / setImagesFolder(java.lang.String) property.

If the folder specified by getImagesFolder() / setImagesFolder(java.lang.String) doesn't exist, it will be created automatically.

Parameters:

value - The corresponding String value.

getImageSavingCallback

public IImageSavingCallback getImageSavingCallback()

Allows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.

Returns:

The corresponding IImageSavingCallback value.

setImageSavingCallback

public void setImageSavingCallback(IImageSavingCallback value)

Allows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.

Parameters:

value - The corresponding IImageSavingCallback value.

getExportImagesAsBase64

public boolean getExportImagesAsBase64()

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

When this property is set to true images data are exported directly into the img elements and separate files are not created.

Returns:

The corresponding boolean value.

setExportImagesAsBase64

public 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 images data are exported directly into the img elements and separate files are not created.

Parameters:

value - The corresponding boolean value.