mlreportgen.dom.DOCXPageHeader Class

R2026b

Namespace: mlreportgen.dom

Page header definition for Microsoft Word document

Description

Use an object of the mlreportgen.dom.DOCXPageHeader class to add a header to the first page of a section or to odd pages, even pages, or both.

This class is only compatible with this MATLAB^® Report Generator™ output type: "docx".

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

Creation

Description

docxHeader = DOCXPageHeader creates a page header based on the default Word template.

docxHeader = DOCXPageHeader(pageType) creates a page header for the specified type of page, that is, odd, even, or first, based on the default Word template.

docxHeader = DOCXPageHeader(pageType,templatePath) creates a page header for the specified type of page based on the specified template.

docxHeader = DOCXPageHeader(pageType,templatePath,docPartTemplateName) creates a page header for the specified type of page, based on the specified document part template in the specified template.

docxHeader = DOCXPageHeader(pageType,templateSrc,docPartTemplateName) creates a page header for the specified type of page, based on the specified document part template used by the specified source. The source can be a document or a document part.

Input Arguments

pageType — Type of pages header appears on

[] (default) | default | first | even

Type of page header appears on, specified as one of these values:

• default — Header for odd pages of the section, even pages if you do not specify an even-page header, and first page if you do not specify a first-page header.

• first — Header for first page of a section.

• even — Header for even pages in a section.

For example, to have a blank header appear on the first page of a section and a different header appear on the other pages, define two headers, one with pageType set to first and the other with pageType set to default.

templatePath — Full path of header template

character vector | string scalar

Full path of header template, specified as a string scalar or a character vector.

Data Types: char | string

docPartTemplateName — Document part template name

character vector

Name of this part’s template if it is stored in a template specified by the templatePath or templateSrc argument, specified as a character vector or string scalar.

templateSrc — Document or document part that holds the document part template

mlreportgen.dom.Document object | mlreportgen.dom.DocumentPart object

Document or document part object whose template contains the template for this document part, specified as an mlreportgen.dom.Document object for a document or an mlreportgen.dom.DocumentPart object for a document part.

Properties

CurrentHoleId — ID of current hole in document

"" (default) | character vector | string scalar

ID of the current hole in the document, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

Data Types: char | string

CurrentHoleType — Type of current hole

"" (default) | "Inline" | "Block"

Type of the current template hole, specified as "Inline" or "Block".

• An inline hole is for document elements that a paragraph element can contain: Text, Image, LinkTarget, ExternalLink, InternalLink, CharEntity, or AutoNumber.

• A block hole can contain a Paragraph, Table, OrderedList, UnorderedList, DocumentPart, or Group element.

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

Data Types: char | string

Holes — Template holes mapped by ID number

dictionary (default)

Since R2026b

Template holes mapped by ID number, returned as a dictionary mapping each hole ID in the template to a hole content object. Use the hole ID as a key to access the corresponding mlreportgen.dom.InlineHoleContent or mlreportgen.dom.BlockHoleContent object, then call the append method on the object to fill the hole with content:

d.Holes("Title").append("My Report");

You cannot add, remove, or replace Holes dictionary entries. Assigning a value to a hole entry or setting an entry to [] throws a MATLAB:class:SetProhibited error:

d.Holes("Title") = "My Report";   % Error: MATLAB:class:SetProhibited

An inline hole occurs in a paragraph. You can append only objects that a paragraph can contain, such as text and images. A block hole can contain block-level elements such as paragraphs, tables, and lists.

If your code calls moveToNextHole, fill each hole through Holes before advancing past that hole. After moveToNextHole advances past a hole, appending content to that hole causes a holeContentCannotAppend error. For details, see mlreportgen.dom.InlineHoleContent or mlreportgen.dom.BlockHoleContent.

Attributes:

GetAccess	public
SetAccess	private

Data Types: dictionary

CurrentPageLayout — Current page layout of this document

[] (default) | mlreportgen.dom.DOCXPageLayout object | mlreportgen.dom.PDFPageLayout object | []

Current page layout of this document, specified as an mlreportgen.dom.DOCXPageLayout object, mlreportgen.dom.PDFPageLayout object, or []. This property applies to Word and PDF documents. For Word documents, the value is a DOCXPageLayout object that specifies the current page layout. For PDF documents, the value is a PDFPageLayout object if the document currently specifies a page layout. For HTML documents, the value is always [].

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

PageType — Type of pages header appears on

[] (default) | "default" | "first" | "even"

Type of page header appears on, specified as one of these values:

• "default" — Header for odd pages of the section, even pages if you do not specify an even-page header, and first page if you do not specify a first-page header.

• "first" — Header for first page of a section.

• "even" — Header for even pages in a section.

For example, to have a blank header appear on the first page and a different header appear on the other pages, define two headers, one with pageType set to "first" and the other with pageType set to "default".

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

TemplatePath — Full path of header template

character vector | string scalar

Full path of header template, specified as a string scalar or a character vector.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Parent — Parent of this object

document element object

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 — Children of this object

array of document element objects

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 — Tag

character vector | string scalar

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

Id — Object identifier

character vector | string scalar

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

Public Methods

Method	Purpose
append	appendedContent = append(classObj,textContent) appends text, textContent, to the class object, classObj. appendedContent = append(classObj,textContent,styleName) appends text using the style, styleName. Use a style defined in the style sheet of the template of the document you append content to. appendedContent = append(classObj,contentToAppend) appends a DOM or MATLAB object, contentToAppend, to the class object. Input Arguments classObj — Class object to append content to, specified as an mlreportgen.dom.DOCXPageHeader object. textContent — Text to append, specified as a character vector or string scalar. styleName — Name of style sheet, specified as a character vector or string scalar. Specifying this argument sets the StyleName property of the appendedContent object to styleName. contentToAppend — Content to append, specified as a DOM or MATLAB object. Return Values appendedContent — Appended content, returned as a DOM object. To see a list of the Document Object Model (DOM) class objects and MATLAB data types you can use as the classObj argument, see Append content to mlreportgen.dom.DOCXPageHeader object. For more information, see the equivalent append method from the mlreportgen.dom.Document class.
close	Close header
fill	Fill template hole
moveToNextHole	Move to next template hole
open	Open header

More About

Append content to mlreportgen.dom.DOCXPageHeader object

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

• mlreportgen.dom.AutoNumber

• mlreportgen.dom.CharEntity

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageLayout (Word)

• mlreportgen.dom.DOCXSubDoc (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.LOC

• mlreportgen.dom.LOF

• mlreportgen.dom.LOT

• 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.TOC

• mlreportgen.dom.UnorderedList

You can append these MATLAB data types to an mlreportgen.dom.DOCXPageHeader 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 R2014b

R2026b: Fill template holes directly by ID

The Holes property provides direct access to template holes by ID. Use the hole ID as a dictionary key to access the corresponding hole content object, then call the append method to fill the hole with content. This approach eliminates the need to iterate through holes to find a specific ID.