HtmlMetafileFormat

Inheritance: java.lang.Object

public class HtmlMetafileFormat

Indicates the format in which metafiles are saved to HTML documents.

Examples:

Shows how to convert SVG objects to a different format when saving HTML documents.

 String html =
     "\n                    \n                        Hello world!\n                    \n                ";

 // Use 'ConvertSvgToEmf' to turn back the legacy behavior
 // where all SVG images loaded from an HTML document were converted to EMF.
 // Now SVG images are loaded without conversion
 // if the MS Word version specified in load options supports SVG images natively.
 HtmlLoadOptions loadOptions = new HtmlLoadOptions(); { loadOptions.setConvertSvgToEmf(true); }

 Document doc = new Document(new ByteArrayInputStream(html.getBytes()));

 // This document contains a  element in the form of text.
 // When we save the document to HTML, we can pass a SaveOptions object
 // to determine how the saving operation handles this object.
 // Setting the "MetafileFormat" property to "HtmlMetafileFormat.Png" to convert it to a PNG image.
 // Setting the "MetafileFormat" property to "HtmlMetafileFormat.Svg" preserve it as a SVG object.
 // Setting the "MetafileFormat" property to "HtmlMetafileFormat.EmfOrWmf" to convert it to a metafile.
 HtmlSaveOptions options = new HtmlSaveOptions();
 {
     options.setMetafileFormat(htmlMetafileFormat);
 }

 doc.save(getArtifactsDir() + "HtmlSaveOptions.MetafileFormat.html", options);

 String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.MetafileFormat.html"), StandardCharsets.UTF_8);

 switch (htmlMetafileFormat) {
     case HtmlMetafileFormat.PNG:
         Assert.assertTrue(outDocContents.contains(
                 " " +
                         "" +
                         ""));
         break;
     case HtmlMetafileFormat.SVG:
         Assert.assertTrue(outDocContents.contains(
                 "" +
                         ""));
         break;
     case HtmlMetafileFormat.EMF_OR_WMF:
         Assert.assertTrue(outDocContents.contains(
                 " " +
                         "" +
                         ""));
         break;
 }
 

Fields

Field	Description
EMF_OR_WMF	Metafiles are saved as is, without conversion.
PNG	Metafiles are rendered to raster PNG images.
SVG	Metafiles are converted to vector SVG images.
length

Methods

Method	Description
fromName(String htmlMetafileFormatName)
getName(int htmlMetafileFormat)
getValues()
toString(int htmlMetafileFormat)

EMF_OR_WMF

public static int EMF_OR_WMF

Metafiles are saved as is, without conversion.

PNG

public static int PNG

Metafiles are rendered to raster PNG images.

SVG

public static int SVG

Metafiles are converted to vector SVG images.

length

public static int length

fromName(String htmlMetafileFormatName)

public static int fromName(String htmlMetafileFormatName)

Parameters:

Parameter	Type	Description
htmlMetafileFormatName	java.lang.String

Returns: int

getName(int htmlMetafileFormat)

public static String getName(int htmlMetafileFormat)

Parameters:

Parameter	Type	Description
htmlMetafileFormat	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int htmlMetafileFormat)

public static String toString(int htmlMetafileFormat)

Parameters:

Parameter	Type	Description
htmlMetafileFormat	int

Returns: java.lang.String