Main Content

mlreportgen.dom.TemplateHole Class

Namespace: mlreportgen.dom

Hole to append to template

expand all in page

Description

Hole to append to a document template.

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

  • Paragraph

  • TableEntry

  • Group

  • Template

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

Creation

Description

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

expand all

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

Description for the template hole, specified as a character vector or string scalar. 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.

Properties

expand all

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.

Attributes:

NonCopyable
true

Data Types: char | string

Description for the template hole, specified as a character vector or string scalar. 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.

Attributes:

NonCopyable
true

Data Types: char | string

ID of this template hole.

Attributes:

NonCopyable
true

Data Types: char | string

Tag for the mlreportgen.dom.TemplateHole 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

Object identifier for the mlreportgen.dom.TemplateHole 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

expand all

Version History

Introduced in R2014b

See Also

| |

Topics