mlreportgen.dom.BlockHoleContent Class

R2026b

Namespace: mlreportgen.dom

Content for a block template hole

Since R2026b

Description

A BlockHoleContent object represents the content for a block hole defined in a template. A block hole can contain block-level elements such as paragraphs, tables, and lists.

You do not create BlockHoleContent objects directly. Access them through the Holes property of a template-based DOM object such as mlreportgen.dom.Document or mlreportgen.dom.DocumentPart.

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

Class Attributes

HandleCompatible	true
ConstructOnLoad	true

Properties

DefaultHoleStyleName — Default style name for hole content

"" (default) | character vector | string scalar

Default style name for content appended to this hole, returned as a character vector. The template definition assigns this style name to appended content that does not specify a style name. The template definition determines the value.

Attributes:

GetAccess	public
SetAccess	private

Data Types: char | string

Methods

Public Methods

Method	Purpose
append	Append block content to this hole

Limitations

• Before the write position advances past a hole, append content to that hole. After moveToNextHole advances past a hole, appending to that hole causes a holeContentCannotAppend error.

Examples

Fill Block Holes with a Paragraph and List

import mlreportgen.dom.*

d = Document("myReport","docx","myTemplate");

dp = DocumentPart(d,"MySection");

p = Paragraph("Summary text");
dp.Holes("Summary").append(p);

list = UnorderedList(["Item 1","Item 2","Item 3"]);
dp.Holes("Items").append(list);

append(d,dp);
close(d);
rptview(d);

More About

Append content to mlreportgen.dom.BlockHoleContent object

You can append these DOM objects to an mlreportgen.dom.BlockHoleContent object:

• mlreportgen.dom.CharEntity

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageLayout (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.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.TemplateHole

• mlreportgen.dom.TemplateText

• mlreportgen.dom.Text

• mlreportgen.dom.UnorderedList

You can append these MATLAB^® data types to an mlreportgen.dom.BlockHoleContent object:

• character array — Appends and returns a mlreportgen.dom.Text object

• string scalar — Appends and returns a mlreportgen.dom.Text object

• numeric variable — Appends and returns a mlreportgen.dom.Number object

• logical variable — Appends and returns a mlreportgen.dom.Number object with a value of 1 or 0

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

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

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

• 2D array of double values or strings — 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

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

Version History

Introduced in R2026b