mlreportgen.dom.TemplateDocumentPart Class
Namespace: mlreportgen.dom
Description
This class defines 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.
The mlreportgen.dom.TemplateDocumentPart
class is a handle
class.
Creation
Description
Input Arguments
Name
— Name of document template part
character vector | string scalar
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
HTMLTag
— HTML tag name of container
'div'
(default) | character vector | string scalar
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.
Data Types: char
| string
Name
— Name of document part template
character vector | string scalar
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.
Data Types: char
| string
StyleName
— Name of stylesheet-defined style
[]
(default) | character vector | string scalar
Style name, 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 overridden by the formats specified by the
Style
property of this element. To learn more about using style
sheets, see Use Style Sheet Styles.
Note
Microsoft Word output ignores the style name.
Attributes:
NonCopyable | true |
Data Types: char
| string
Style
— Format specification
{}
(default) | array of DOM format objects
Format specification for this document element object, specified as an 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:
NonCopyable | true |
Parent
— Parent of mlreportgen.dom.TemplateDocumentPart
object
document element object
Parent of mlreportgen.dom.TemplateDocumentPart
object, specified as a document element
object. A document element must have only one parent.
Attributes:
SetAccess | private |
NonCopyable | true |
Children
— Children of mlreportgen.dom.TemplateDocumentPart
object
array of document element objects
Children of mlreportgen.dom.TemplateDocumentPart
object, specified as an array of document
element objects. This property contains the document element objects appended using the
append
method.
Attributes:
SetAccess | private |
NonCopyable | true |
Tag
— Tag for mlreportgen.dom.TemplateDocumentPart
object
character vector | string scalar
Tag for the mlreportgen.dom.TemplateDocumentPart
object, 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. Specify your own tag value to help
you identify where to look when an issue occurs during document generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Id
— Object identifier for mlreportgen.dom.TemplateDocumentPart
object
character vector | string scalar
Object identifier for the mlreportgen.dom.TemplateDocumentPart
object, specified as a
character vector or string scalar. The DOM API generates a session-unique identifier
when it creates the document element object. You can specify your own value for
Id
.
Attributes:
NonCopyable | true |
Data Types: char
| string
Methods
Public Methods
clone | Create a copy of Note Use this method to append a clone of a document part template that already resides in one object to another object. You cannot append the same document part template object to different objects.
|
append | Append content to the document part template.
|
Examples
Create Template Document Part to Use in Template
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.
Version History
Introduced in R2023bR2024a: Support for DOCX header, footers, and page layouts
Add a header and footer and modify page layout in an mlreportgen.dom.TemplateDocumentPart
document. To do so, append an mlreportgen.dom.DOCXPageLayout
object.
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)