MarkdownExportAsHtml

Inheritance: java.lang.Object

public class MarkdownExportAsHtml

Allows to specify the elements to be exported to Markdown as raw HTML.

Examples:

Shows how to export tables that cannot be correctly represented in pure Markdown as raw HTML.


 String outputPath = getArtifactsDir() + "MarkdownSaveOptions.NonCompatibleTables.md";

 Document doc = new Document(getMyDir() + "Non compatible table.docx");

 // With the "NonCompatibleTables" option, you can export tables that have a complex structure with merged cells
 // or nested tables to raw HTML and leave simple tables in Markdown format.
 MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
 saveOptions.setExportAsHtml(MarkdownExportAsHtml.NON_COMPATIBLE_TABLES);

 doc.save(outputPath, saveOptions);
 

Shows how to export a table to Markdown as raw HTML.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Sample table:");

 // Create table.
 builder.insertCell();
 builder.getParagraphFormat().setAlignment(ParagraphAlignment.RIGHT);
 builder.write("Cell1");
 builder.insertCell();
 builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
 builder.write("Cell2");

 MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
 saveOptions.setExportAsHtml(MarkdownExportAsHtml.TABLES);

 doc.save(getArtifactsDir() + "MarkdownSaveOptions.ExportTableAsHtml.md", saveOptions);
 

Fields

FieldDescription
NONEExport all elements using Markdown syntax without any raw HTML.
NON_COMPATIBLE_TABLESExport tables that cannot be correctly represented in pure Markdown as raw HTML.
TABLESExport tables as raw HTML.
length

Methods

MethodDescription
fromName(String markdownExportAsHtmlName)
fromNames(Set markdownExportAsHtmlNames)
getName(int markdownExportAsHtml)
getNames(int markdownExportAsHtml)
getValues()
toString(int markdownExportAsHtml)
toStringSet(int attr)

NONE

public static int NONE

Export all elements using Markdown syntax without any raw HTML.

NON_COMPATIBLE_TABLES

public static int NON_COMPATIBLE_TABLES

Export tables that cannot be correctly represented in pure Markdown as raw HTML.

Remarks:

When this option is enabled, Aspose.Words will only export tables that have merged cells or nested tables as raw HTML. And all other tables will be exported in Markdown format. Also note, this option will not preserve all formatting of the table, but only preserves corresponding spans of the cells.

If related TABLES flag is set, then this flag will be ignored.

TABLES

public static int TABLES

Export tables as raw HTML.

Remarks:

When this option is enabled, every table will be exported as raw HTML. Aspose.Words will try to preserve all formatting of the tables in this case.

If this flag is set, then related NON_COMPATIBLE_TABLES flag will be ignored.

length

public static int length

fromName(String markdownExportAsHtmlName)

public static int fromName(String markdownExportAsHtmlName)

Parameters:

ParameterTypeDescription
markdownExportAsHtmlNamejava.lang.String

Returns: int

fromNames(Set markdownExportAsHtmlNames)

public static int fromNames(Set markdownExportAsHtmlNames)

Parameters:

ParameterTypeDescription
markdownExportAsHtmlNamesjava.util.Set

Returns: int

getName(int markdownExportAsHtml)

public static String getName(int markdownExportAsHtml)

Parameters:

ParameterTypeDescription
markdownExportAsHtmlint

Returns: java.lang.String

getNames(int markdownExportAsHtml)

public static Set getNames(int markdownExportAsHtml)

Parameters:

ParameterTypeDescription
markdownExportAsHtmlint

Returns: java.util.Set

getValues()

public static int[] getValues()

Returns: int[]

toString(int markdownExportAsHtml)

public static String toString(int markdownExportAsHtml)

Parameters:

ParameterTypeDescription
markdownExportAsHtmlint

Returns: java.lang.String

toStringSet(int attr)

public static String toStringSet(int attr)

Parameters:

ParameterTypeDescription
attrint

Returns: java.lang.String