MarkdownSaveOptions

Inheritance: java.lang.Object, com.aspose.slides.SaveOptions

public class MarkdownSaveOptions extends SaveOptions

Represents options that control how presentation should be saved to markdown.

Example:
 
 Presentation pres = new Presentation(presentationFileName);
 try {
     FileOutputStream stream = new FileOutputStream("MdFileForGitHubFlavor");
     try {
         MarkdownSaveOptions markdownSaveOptions = new MarkdownSaveOptions();
         markdownSaveOptions.setShowHiddenSlides(true);
         markdownSaveOptions.setShowSlideNumber(true);
         markdownSaveOptions.setFlavor(Flavor.Github);
         markdownSaveOptions.setExportType(MarkdownExportType.Sequential);
         markdownSaveOptions.setNewLineType(NewLineType.Windows);
         markdownSaveOptions.setBasePath(documentResourcesPath);

         pres.save(stream, new int[]{1, 2, 3, 4, 5, 6, 7, 8, 9}, SaveFormat.Md, markdownSaveOptions);
     } finally {
         if (stream != null) stream.close();
     }
 } catch (Exception e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Constructors

Methods

MarkdownSaveOptions()

public MarkdownSaveOptions()

Ctor.

getExportType()

public final int getExportType()

Specifies markdown specification to convert presentation. Default is TextOnly .

Returns: int

setExportType(int value)

public final void setExportType(int value)

Specifies markdown specification to convert presentation. Default is TextOnly .

Parameters:

getBasePath()

public final String getBasePath()

Specifies the base path where document with resources will be saved. Default is the current directory of the application.

Returns: java.lang.String

setBasePath(String value)

public final void setBasePath(String value)

Specifies the base path where document with resources will be saved. Default is the current directory of the application.

Parameters:

getImagesSaveFolderName()

public final String getImagesSaveFolderName()

Specifies folder name to save images. Default is Images .

Returns: java.lang.String

setImagesSaveFolderName(String value)

public final void setImagesSaveFolderName(String value)

Specifies folder name to save images. Default is Images .

Parameters:

getNewLineType()

public final int getNewLineType()

Specifies whether the generated document should have new lines \\r(Macintosh) of \\n(Unix) or \\r\\n(Windows). Default is Unix .

Returns: int

setNewLineType(int value)

public final void setNewLineType(int value)

Specifies whether the generated document should have new lines \\r(Macintosh) of \\n(Unix) or \\r\\n(Windows). Default is Unix .

Parameters:

getShowComments()

public final boolean getShowComments()

Specifies whether the generated document should show comments or not. Default is false.

Returns: boolean

setShowComments(boolean value)

public final void setShowComments(boolean value)

Specifies whether the generated document should show comments or not. Default is false.

Parameters:

getShowHiddenSlides()

public final boolean getShowHiddenSlides()

Specifies whether the generated document should include hidden slides or not. Default is false.

Returns: boolean

setShowHiddenSlides(boolean value)

public final void setShowHiddenSlides(boolean value)

Specifies whether the generated document should include hidden slides or not. Default is false.

Parameters:

getShowSlideNumber()

public final boolean getShowSlideNumber()

Specifies whether the generated document should show number of each slide or not. Default is false.

Returns: boolean

setShowSlideNumber(boolean value)

public final void setShowSlideNumber(boolean value)

Specifies whether the generated document should show number of each slide or not. Default is false.

Parameters:

getFlavor()

public final int getFlavor()

Specifies markdown specification to convert presentation. Default is Multi-markdown .

Returns: int

setFlavor(int value)

public final void setFlavor(int value)

Specifies markdown specification to convert presentation. Default is Multi-markdown .

Parameters:

getSlideNumberFormat()

public final String getSlideNumberFormat()

Gets or sets the format string used for slide number headers in Markdown output. The format must include the “{0}” placeholder, which will be replaced with the slide index during export. Example: “# Slide {0}” will produce “# Slide 1”, “# Slide 2”, etc.

Returns: java.lang.String

setSlideNumberFormat(String value)

public final void setSlideNumberFormat(String value)

Gets or sets the format string used for slide number headers in Markdown output. The format must include the “{0}” placeholder, which will be replaced with the slide index during export. Example: “# Slide {0}” will produce “# Slide 1”, “# Slide 2”, etc.

Parameters:

getHandleRepeatedSpaces()

public final int getHandleRepeatedSpaces()

Specifies how repeated regular space characters should be handled during Markdown export. This property defines whether consecutive spaces are: - preserved as regular space characters, - alternated between regular spaces and non-breaking space entities (�), - or fully replaced (after the first) with a non-breaking space to preserve visual alignment in Markdown output. The default value is HandleRepeatedSpaces.AlternateSpacesToNbsp.

Returns: int

setHandleRepeatedSpaces(int value)

public final void setHandleRepeatedSpaces(int value)

Specifies how repeated regular space characters should be handled during Markdown export. This property defines whether consecutive spaces are: - preserved as regular space characters, - alternated between regular spaces and non-breaking space entities (�), - or fully replaced (after the first) with a non-breaking space to preserve visual alignment in Markdown output. The default value is HandleRepeatedSpaces.AlternateSpacesToNbsp.

Parameters:

getRemoveEmptyLines()

public final boolean getRemoveEmptyLines()

If set to true, removes empty or whitespace-only lines from the final Markdown output. Default is false.

Returns: boolean

setRemoveEmptyLines(boolean value)

public final void setRemoveEmptyLines(boolean value)

If set to true, removes empty or whitespace-only lines from the final Markdown output. Default is false.

Parameters: