mlreportgen.dom.TemplateHole class

Package: mlreportgen.dom
Superclasses:

Hole to append to template

Description

Hole to append to a document template.

You can append a template hole to these kinds of DOM objects:

• Paragraph

• TableEntry

• Group

• Template

Construction

templateHoleObj = TemplateHole() creates a hole with empty properties.

templateHoleObj = TemplateHole(id) creates a hole having the specified id.

templateHoleObj = TemplateHole(id,description) creates a hole having the specified id and description.

Input Arguments

id — ID for template hole

character vector

The ID for the template hole, specified as a character vector.

description — Description for template hole

character vector

Description for the template hole, specified as a character vector. The value of this argument becomes the content of the hole in the template to which it is assigned to allow you to determine the purpose of the hole when viewing the template in the corresponding application. The description is replaced by appended hole content in a report generated from the template.

Output Arguments

templateHoleObj — Hole to append to template

mlreportgen.dom.TemplateHole object

Hole to append to template, represented by an mlreportgen.dom.TemplateHole object.

Properties

DefaultHoleStyleName — Name of default style for hole content

character vector

Name of default style for hole content. This style name is assigned to hole content that does not specify a style name. For example, suppose you append a Text object to this hole and the Text object does not specify a style name. Then the value of this property is assigned to the text object as its style name. This property allows a template to specify the appearance of appended content.

Description — Description of this hole

character vector

Description for the template hole, specified as a character vector. The value of this property becomes the content of the hole in the template to which it is assigned to allow you to determine the purpose of the hole when viewing the template in the corresponding application. The description is replaced by appended hole content in a report generated from the template.

HoleId — ID of this hole

character vector

ID of this template hole.

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Methods

Method	Purpose
clone Use TemplateHole.clone in a similar way to how you use Paragraph.clone.	Clone this hole object.