mlreportgen.dom.TemplateDocumentPart Class

Namespace: mlreportgen.dom

Create template for document part

Since R2023b

expand all in page

Description

Use an object of the mlreportgen.dom.TemplateDocumentPart class to define a document part template object that you can add to the TemplateDocumentParts property of an object of the mlreportgen.dom.Template class. When you close the Template object, Report Generator writes these document part templates to the output template package (HTML, PDF, DOCX) or template document (HTML-FILE) as document parts. You can then create DocumentPart objects based on the document part templates in the generated template.

To see what DOM objects you can append an mlreportgen.dom.TemplateDocumentPart object to, see Append mlreportgen.dom.TemplateDocumentPart object to DOM class object.

The mlreportgen.dom.TemplateDocumentPart class is a handle class.

Class Attributes

HandleCompatible
true

For information on class attributes, see Class Attributes.

Creation

Description

tdpObject = mlreportgen.dom.TemplateDocumentPart creates a TemplateDocumentPart object and sets the Name property to "".

tdpObject = mlreportgen.dom.TemplateDocumentPart(Name) creates a template object and sets the Name property to Name.

example

Input Arguments

expand all

Name of the document template part, specified as a character vector or string scalar. Use the name to identify and access the document part in the generated template.

Properties

expand all

HTML tag name of container, specified as a character vector or string scalar. The name must be an HTML element, such as "div", "section", or "article".

Note

Microsoft® Word output ignores the HTML tag name.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Name of the document part template, specified as a character vector or string scalar. Use the name to identify and access the document part in the generated template.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Name of stylesheet-defined style, specified as a character vector or string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, see Templates for DOM API Report Programs.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as a cell array of DOM format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this document element object are ignored.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: cell

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

Children of this object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

Open Live Script

Import the mlreportgen.dom namespace so that you do not have to include the full qualified names for the object constructors and methods. 

import mlreportgen.dom.*

Create a DOCX template.

t = Template("bookReportTemplate","docx");
open(t);

Create a template document part. 

dpt = TemplateDocumentPart("bookRatingPart");

Create a hole for a book title.

title = Heading1();
append(title,TemplateHole("Title","Title of the book"));
append(dpt,title);

Create a hole for a book author.

author = Heading2();
append(author,TemplateHole("Author","Author of the book"));
append(dpt,author);

Create a hole for a book rating.

rating = Paragraph("I rate this book: ");
rating.WhiteSpace = "preserve";
append(rating,TemplateHole("Rating", "Rating of the book"));
append(rating," out of 5 stars.");
append(dpt,rating);

Add the template document part to the template.

t.TemplateDocumentParts(end+1) = dpt;
close(t);

To view your template document part or any of the default template document parts:

Open bookReportTemplate.dotx by using one of these methods:

  • In MATLAB®, in the Current Folder pane, right-click the template file and select Show in Explorer. Then right-click the template file and select Open.

  • Outside of MATLAB, right-click the template file and select Open.

In Word, open the Insert tab in the ribbon. In the Text group, select the Quick Parts button. The drop down menu will show your new bookRatingPart template document part as well as the other template document parts that are standard to an mlreportgen.dom.Template template.

Word Quick Parts dropdown showing the template document parts created by the mlreportgen Template

More About

expand all

Version History

Introduced in R2023b

expand all

See Also

| |

Topics