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

ConstructorDescription
MarkdownSaveOptions()Ctor.

Methods

MethodDescription
getExportType()Specifies markdown specification to convert presentation.
setExportType(int value)Specifies markdown specification to convert presentation.
getBasePath()Specifies the base path where document with resources will be saved.
setBasePath(String value)Specifies the base path where document with resources will be saved.
getImagesSaveFolderName()Specifies folder name to save images.
setImagesSaveFolderName(String value)Specifies folder name to save images.
getNewLineType()Specifies whether the generated document should have new lines \r(Macintosh) of \n(Unix) or \r\n(Windows).
setNewLineType(int value)Specifies whether the generated document should have new lines \r(Macintosh) of \n(Unix) or \r\n(Windows).
getShowComments()Specifies whether the generated document should show comments or not.
setShowComments(boolean value)Specifies whether the generated document should show comments or not.
getShowHiddenSlides()Specifies whether the generated document should include hidden slides or not.
setShowHiddenSlides(boolean value)Specifies whether the generated document should include hidden slides or not.
getShowSlideNumber()Specifies whether the generated document should show number of each slide or not.
setShowSlideNumber(boolean value)Specifies whether the generated document should show number of each slide or not.
getFlavor()Specifies markdown specification to convert presentation.
setFlavor(int value)Specifies markdown specification to convert presentation.

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:

ParameterTypeDescription
valueint

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:

ParameterTypeDescription
valuejava.lang.String

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:

ParameterTypeDescription
valuejava.lang.String

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:

ParameterTypeDescription
valueint

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:

ParameterTypeDescription
valueboolean

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:

ParameterTypeDescription
valueboolean

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:

ParameterTypeDescription
valueboolean

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:

ParameterTypeDescription
valueint