Advance HTML Documents Saving Options with Aspose.Words Java
In this tutorial, we will explore the advanced HTML document saving options provided by Aspose.Words for Java. Aspose.Words is a powerful Java API for working with Word documents, and it offers a wide range of features for document manipulation and conversion.
1. Introduction
Aspose.Words for Java allows you to work with Word documents programmatically. In this tutorial, we will focus on advanced HTML document saving options, which enable you to control how Word documents are converted to HTML.
2. Export Roundtrip Information
The exportRoundtripInformation method allows you to export Word documents to HTML while preserving roundtrip information. This information can be useful when you want to convert HTML back to Word format without losing any document-specific details.
public void exportRoundtripInformation() throws Exception {
Document doc = new Document("Your Directory Path" + "Rendering.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setExportRoundtripInformation(true);
doc.save("Your Directory Path" + "WorkingWithHtmlSaveOptions.ExportRoundtripInformation.html", saveOptions);
}
3. Export Fonts as Base64
With the exportFontsAsBase64 method, you can export fonts used in the document as Base64-encoded data in the HTML. This ensures that the HTML representation retains the same font styles as the original Word document.
public void exportFontsAsBase64() throws Exception {
Document doc = new Document("Your Directory Path" + "Rendering.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setExportFontsAsBase64(true);
doc.save("Your Directory Path" + "WorkingWithHtmlSaveOptions.ExportFontsAsBase64.html", saveOptions);
}
4. Export Resources
The exportResources method allows you to specify the type of CSS stylesheet and export font resources. You can also set a resource folder and an alias for resources in the HTML.
public void exportResources() throws Exception {
Document doc = new Document("Your Directory Path" + "Rendering.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
saveOptions.setExportFontResources(true);
saveOptions.setResourceFolder("Your Directory Path" + "Resources");
saveOptions.setResourceFolderAlias("http://example.com/resources");
doc.save("Your Directory Path" + "WorkingWithHtmlSaveOptions.ExportResources.html", saveOptions);
}
5. Convert Metafiles to EMF or WMF
The convertMetafilesToEmfOrWmf method allows you to convert metafiles in the document to either EMF or WMF format, ensuring compatibility and smooth rendering in HTML.
public void convertMetafilesToEmfOrWmf() throws Exception {
string dataDir = "Your Document Directory";
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Here is an image as is: ");
builder.insertHtml(
"<img src=\"data:image/png;base64,\r\n iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAABGdBTUEAALGP\r\n C/xhBQAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9YGARc5KB0XV+IA\r\n AAAddEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIFRoZSBHSU1Q72QlbgAAAF1J\r\n REFUGNO9zL0NglAAxPEfdLTs4BZM4DIO4C7OwQg2JoQ9LE1exdlYvBBeZ7jq\r\n ch9//q1uH4TLzw4d6+ErXMMcXuHWxId3KOETnnXXV6MJpcq2MLaI97CER3N0\r\n vr4MkhoXe0rZigAAAABJRU5ErkJggg==\" alt=\"Red dot\" />");
HtmlSaveOptions saveOptions = new HtmlSaveOptions(); { saveOptions.setMetafileFormat(HtmlMetafileFormat.EMF_OR_WMF); }
doc.save(dataDir + "WorkingWithHtmlSaveOptions.ConvertMetafilesToEmfOrWmf.html", saveOptions);
}
6. Convert Metafiles to SVG
Use the convertMetafilesToSvg method to convert metafiles to SVG format. This format is ideal for displaying vector graphics in HTML documents.
public void convertMetafilesToSvg() throws Exception {
string dataDir = "Your Document Directory";
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Here is an SVG image: ");
builder.insertHtml(
"<svg height='210' width='500'>\r\n <polygon points='100,10 40,198 190,78 10,78 160,198' \r\n style='fill:lime;stroke:purple;stroke-width:5;fill-rule:evenodd;' />\r\n </svg> ");
HtmlSaveOptions saveOptions = new HtmlSaveOptions(); { saveOptions.setMetafileFormat(HtmlMetafileFormat.SVG); }
doc.save(dataDir + "WorkingWithHtmlSaveOptions.ConvertMetafilesToSvg.html", saveOptions);
}
7. Add CSS Class Name Prefix
With the addCssClassNamePrefix method, you can add a prefix to CSS class names in the exported HTML. This helps prevent conflicts with existing styles.
public void addCssClassNamePrefix() throws Exception {
Document doc = new Document("Your Directory Path" + "Rendering.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setCssStyleSheetType(CssStyleSheetType.EXTERNAL);
saveOptions.setCssClassNamePrefix("pfx_");
doc.save("Your Directory Path" + "WorkingWithHtmlSaveOptions.AddCssClassNamePrefix.html", saveOptions);
}
8. Export CID URLs for MHTML Resources
The exportCidUrlsForMhtmlResources method is used when saving documents in MHTML format. It allows exporting Content-ID URLs for resources.
public void exportCidUrlsForMhtmlResources() throws Exception {
string dataDir = "Your Document Directory";
Document doc = new Document(dataDir + "Content-ID.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions(SaveFormat.MHTML);
{
saveOptions.setPrettyFormat(true); saveOptions.setExportCidUrlsForMhtmlResources(true);
}
doc.save(dataDir + "WorkingWithHtmlSaveOptions.ExportCidUrlsForMhtmlResources.mhtml", saveOptions);
}
9. Resolve Font Names
The resolveFontNames method helps resolve font names when saving documents in HTML format, ensuring consistent rendering across different platforms.
public void resolveFontNames() throws Exception {
string dataDir = "Your Document Directory";
Document doc = new Document(dataDir + "Missing font.docx");
HtmlSaveOptions saveOptions = new HtmlSaveOptions(SaveFormat.HTML);
{
saveOptions.setPrettyFormat(true); saveOptions.setResolveFontNames(true);
}
doc.save(dataDir + "WorkingWithHtmlSaveOptions.ResolveFontNames.html", saveOptions);
}
10. Export Text Input Form Field as Text
The exportTextInputFormFieldAsText method exports form fields as plain text in the HTML, making them easily readable and editable.
public void exportTextInputFormFieldAsText() throws Exception {
string dataDir = "Your Document Directory";
Document doc = new Document(dataDir + "Rendering.docx");
String imagesDir = Path.combine(dataDir, "Images");
// The folder specified needs to exist and should be empty.
if (Directory.exists(imagesDir))
Directory.delete(imagesDir, true);
Directory.createDirectory(imagesDir);
// Set an option to export form fields as plain text, not as HTML input elements.
HtmlSaveOptions saveOptions = new HtmlSaveOptions(SaveFormat.HTML);
{
saveOptions.setExportTextInputFormFieldAsText(true); saveOptions.setImagesFolder(imagesDir);
}
doc.save(dataDir + "WorkingWithHtmlSaveOptions.ExportTextInputFormFieldAsText.html", saveOptions);
}
Conclusion
In this tutorial, we explored the advanced HTML document saving options provided by Aspose.Words for Java. These options give you fine-grained control over the conversion process, allowing you to create HTML documents that closely resemble the original Word documents.
FAQ’s
Here are some frequently asked questions about working with Aspose.Words for Java and HTML document saving options:
Q1: How can I convert HTML back to Word format using Aspose.Words for Java?
To convert HTML back to Word format, you can use the Aspose.Words API’s load method to load the HTML document and then save it in Word format.
Q2: Can I customize the CSS styles when exporting to HTML?
Yes, you can customize CSS styles by modifying the stylesheets used in the HTML or by using the addCssClassNamePrefix method to add a prefix to CSS class names.
Q3: Is there a way to optimize the HTML output for web display?
Yes, you can optimize the HTML output for web display by configuring options like exporting fonts as Base64 and converting metafiles to SVG.
Q4: Are there any limitations when converting complex Word documents to HTML?
While Aspose.Words for Java provides powerful conversion capabilities, complex Word documents with intricate layouts may require additional post-processing to achieve the desired HTML output.
