Main Content

addHTML

Class: mlreportgen.dom.Document
Namespace: mlreportgen.dom

Append HTML string to document

expand all in page

Syntax

htmlObjOut = addHTML(documentObj,htmlText)

Description

htmlObjOut = addHTML(documentObj,htmlText) converts a string of HTML text to a group of DOM objects and appends the group to the Document object documentObj.

Input Arguments

expand all

Document object to append content to, specified as an mlreportgen.dom.Document object.

HTML text, specified as a character vector or string scalar.

Example: '<p><b>Hello</b> <i style="color:green">World</i></p>'

Output Arguments

expand all

HTML object with appended content, returned as an mlreportgen.dom.HTML object.

Examples

expand all

Create an HTML object from HTML text to use for a Microsoft® Word report.

import mlreportgen.dom.*;
rpt = Document('HTMLToWordReport','docx');     
htmlObj = addHTML(rpt,...
    '<p><b>Hello</b> <i style="color:green">World</i></p>');

Generate the Word report.

close(rpt);
rptview(rpt.OutputPath);

Tips

  • MATLAB® Report Generator™ mlreportgen.dom.HTML or mlreportgen.dom.HTMLFile objects typically cannot accept the raw HTML output of third-party applications, such as Microsoft Word, that export native documents as HTML markup. In these cases, your Report API report generation program can use the mlreportgen.utils.html2dom.prepHTMLString and mlreportgen.utils.html2dom.prepHTMLFile functions to prepare the raw HTML for use with the mlreportgen.dom.HTML or mlreportgen.dom.HTMLFile objects. Typically, your program will have to further process the prepared HTML to remove valid but undesirable objects, such as line feeds that were in the raw content.

  • By default, the DOM API uses a base font size of 12 points to convert em units to actual font sizes. For example, a font size specified as 2em converts to 24 points. To specify a different base font size, add your content to a report by using an mlreportgen.dom.HTML object. Set the EMBaseFontSize property of the object to the base font size. For example, if you set the EMBaseFontSize property to 14, a font size of 2em converts to 28 points.

Version History

Introduced in R2015a

See Also

| | |

Topics