append

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

Append DOM or MATLAB object to document

Syntax

domObjOut = append(docObj,textContent)

domObjOut = append(docObj,listContent)

domObjOut = append(docObj,tableContent)

domObjOut = append(docObj,paraObj,pageLayoutObj)

domObjOut = append(___,styleName)

domObjOut = append(docObj,domObj)

Description

domObjOut = append(docObj,textContent) appends text or numbers, textContent, to a document, docObj, and returns a text object. In Microsoft^® Word and PDF output, the text is wrapped in a paragraph because Word and PDF do not permit unwrapped text to be added to the body of a document. In HTML output, the text is not wrapped in a paragraph.

domObjOut = append(docObj,listContent) appends an unordered list,listContent, and returns an unordered list object.

domObjOut = append(docObj,tableContent) appends a table, tableContent, and returns a table object.

domObjOut = append(docObj,paraObj,pageLayoutObj) appends a paragraph,paraObj, starts a new page layout section whose properties are specified by the pageLayoutObject, and returns a paragraph object.

domObjOut = append(___,styleName) appends the specified content, using the style, styleName.

domObjOut = append(docObj,domObj) appends a DOM object, domObj, to the document and returns that object.

Input Arguments

docObj — Document to which to append content

mlreportgen.dom.Document object

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

textContent — Text to append to document

character vector | string scalar

Text to append to document, specified as a character vector or string scalar. The text object is wrapped in a paragraph object and the paragraph is appended to the document. The text is wrapped in a paragraph to be consistent with Microsoft Word, which does not allow text to be added to the body of a document. For HTML, text wrapping can cause unexpected behavior.

listContent — List object to append to document

mlreportgen.dom.OrderedList object | mlreportgen.dom.UnorderedList object | array

List object to append to document, specified as one of these:

• mlreportgen.dom.OrderedList object

• mlreportgen.dom.UnorderedList object

• 1D horizontal array of double values or strings — Appends and returns a mlreportgen.dom.UnorderedList object

• 1D categorical array — Appends and returns a mlreportgen.dom.UnorderedList object

tableContent — Table object to append to document

array | header array and body array | MATLAB table

Table object to append to document, specified as one of:

• 2D array of double values — Appends and returns a mlreportgen.dom.Table object

• 2D array of strings — Appends and returns a mlreportgen.dom.Table object

• 2D categorical array — Appends and returns a mlreportgen.dom.Table object

• Cell array of strings for the table header and a numeric, cell, or categorical array for the table body — Appends and returns a mlreportgen.dom.FormalTable object

• MATLAB table — Appends and returns a mlreportgen.dom.MATLABTable object

paraObj — Paragraph to append to document

Paragraph object

Paragraph to append to document, specified as a paragraph object. It also starts a new page layout section with properties specified by the pageLayoutObj input.

pageLayoutObj — Page layout to apply to the appended page layout section

PageLayout object

Page layout to apply to the appended page layout section, specified as a mlreportgen.dom.DOCXPageLayout or mlreportgen.dom.PDFPageLayout object.

styleName — Style to apply to input

style name

Style to apply to text, table or list input, specified as a character vector or a string scalar.

domObj — DOM object to append to document

mlreportgen.dom object

DOM object to append to document, specified as one of these DOM objects:

• mlreportgen.dom.AutoNumber

• mlreportgen.dom.CharEntity

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageLayout (Word)

• mlreportgen.dom.DOCXSubDoc (Word)

• mlreportgen.dom.EmbeddedObject

• mlreportgen.dom.ExternalLink

• mlreportgen.dom.FormalTable

• mlreportgen.dom.Group

• mlreportgen.dom.Heading

• mlreportgen.dom.Heading1

• mlreportgen.dom.Heading2

• mlreportgen.dom.Heading3

• mlreportgen.dom.Heading4

• mlreportgen.dom.Heading5

• mlreportgen.dom.Heading6

• mlreportgen.dom.HorizontalRule

• mlreportgen.dom.HTML

• mlreportgen.dom.HTMLFile

• mlreportgen.dom.Image

• mlreportgen.dom.InternalLink

• mlreportgen.dom.LineBreak (PDF, Word)

• mlreportgen.dom.LinkTarget

• mlreportgen.dom.LOC

• mlreportgen.dom.LOF

• mlreportgen.dom.LOT

• mlreportgen.dom.MATLABTable

• mlreportgen.dom.Number

• mlreportgen.dom.NumPages (PDF, Word)

• mlreportgen.dom.OrderedList

• mlreportgen.dom.Page (PDF, Word)

• mlreportgen.dom.PageBreak (PDF, Word)

• mlreportgen.dom.PageRef (PDF, Word)

• mlreportgen.dom.Paragraph

• mlreportgen.dom.PDFPageLayout (PDF)

• mlreportgen.dom.Preformatted

• mlreportgen.dom.RawText

• mlreportgen.dom.StyleRef (PDF, Word)

• mlreportgen.dom.Table

• mlreportgen.dom.Text

• mlreportgen.dom.TOC

• mlreportgen.dom.UnorderedList

Output Arguments

domObjOut — Appended document element

document element object

Appended document element, returned as the same DOM object type as the input object.

Examples

Append an Ordered List Object

Create an OrderedList object and append it to a report.

import mlreportgen.dom.*;
d = Document('mydoc','html');

ol = OrderedList({'first step' 'second step' 'last step'});
append(d,ol);

close(d);
rptview('mydoc','html');

Specify a Style for Appended Text

Use the Word Title style for the text.

import mlreportgen.dom.*;
d = Document("mydoc","docx");
append(d,"This Is a Title","Title");
close(d);
rptview("mydoc","docx");

Append a MATLAB Table

Create a MATLAB^® table named patients from workspace variables.

load patients;
BloodPreasure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPreasure);
patients.Properties.RowNames = LastName;

Sort the table based on the Age variable.

load patients;
BloodPreasure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPreasure);
patients.Properties.RowNames = LastName;

Sort the table based on the Age variable.

sorted = sortrows(patients,"Age");

Create a PDF report with the sorted patients table.

rpt = mlreportgen.dom.Document("MyFileName","pdf");
append(rpt,sorted);
close(rpt);

Show the PDF report in the viewer.

rptview(rpt.OutputPath)

Append a Cell Array as a Table

import mlreportgen.dom.*;
d = Document('mydoc');
table = append(d,{'row 1 - col 1' 'row 1 - col 2';...
    'row 2 - col 1' 'row 2 - col 2'});
table.Style = {Border('double'),ColSep('solid'),RowSep('solid')};
close(d);
rptview('mydoc','html');

Tips

• When you append instances of mlreportgen.dom.Text, mlreportgen.dom.Number, mlreportgen.dom.InternalLink, or mlreportgen.dom.ExternalLink objects in documents, the object content appends differently depending on the document format. In HTML documents, the content appends in the same line. In PDF and DOCX documents, the content appends in separate lines. To append the content in the same line, create a mlreportgen.dom.Paragraph object, append the content to the paragraph object by using the append method, then append the paragraph object to the document object.

Version History

Introduced in R2014b