mlreportgen.dom.DOCXPageLayout class

Package: mlreportgen.dom
Superclasses:

Page format and layout for Microsoft Word document section

Description

Use an mlreportgen.dom.DOCXPageLayout object to define the page format, headers, and footers of a Word document section.

Construction

PageLayoutObj = DOCXPageLayout() creates an empty document page layout object.

Output Arguments

PageLayoutObj — Page layout object

mlreportgen.dom.DOCXPageLayout object

Page format and layout for Word document section, returned as an mlreportgen.dom.DOCXPageLayout object.

Properties

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

CustomAttributes — Custom attributes of document element

array of mlreportgen.dom.CustomAttribute objects

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format.

FirstPageNumber — Number of first page in section

integer

Number of the first page in a section, specified as an integer.

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.

PageFooters — Page footers for this layout

array of mlreportgen.dom.DOCXPageFooter objects

You can define up to three page footers for a layout, one each for:

• The first page of the section

• Even pages

• Odd pages

PageHeaders — Page headers for this layout

array of mlreportgen.dom.DOCXPageHeader objects

You can define up to three page headers for a layout, one each for:

• The first page of the section

• Even pages

• Odd pages

PageMargins — Margin sizes for this layout

mlreportgen.dom.PageMargins object

Margin sizes for this layout, specified as an mlreportgen.dom.PageMargins object.

Format — Type of page numbering to use

character vector

Type of page numbering to use, specified as one of these values.

Value	Meaning	Applies To
		DOCX	PDF
'a'	Lowercase alphabetic
'A'	Uppercase alphabetic
'i'	Lowercase Roman numerals
'I'	Uppercase Roman numerals
'n'. 'N', '1', 'decimal'	Arabic numerals
'numberInDash'	Number with dashes on either side
'hebrew1'	Hebrew numerals
'hebrew2'	Hebrew alphabetic
'arabicAlpha'	Arabic alphabetic
'arabicAbjad'	Arabic abjad numerals
'thaiLetters'	Thai letters
'thaiNumbers'	Thai numerals
'thaiCounting'	Thai counting system

PageSize — Size and orientation of pages in this layout

mlreportgen.dom.PageSize object

Size and orientation of pages in this layout, specified as an mlreportgen.dom.PageSize object.

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

RawFormats — XML markup for unsupported layout formats

cell array

XML markup for unsupported section formats, specified as a cell array of character vectors. For information about XML markup for Word formats, see https://www.ecma-international.org/publications/standards/Ecma-376.htm.

SectionBreak — Section break options

'Next Page' | 'Same Page' | 'Odd Page' | 'Even Page'

Option to create a section break for this layout, specified as one of these values:

• 'Next Page' — Start the section on the next page.

• 'Same Page' — Start the section on the same page as the current section.

• 'Odd Page' — Start the section on an odd page.

• 'Even Page' — Start the section on an even page.

Style — Formats to apply to layout

array of format objects

Formats to apply to this layout, specified as an array of format objects. The formats you specify using this property override the same formats defined by the style applied with the StyleName property. Formats that do not apply to a page layout are ignored.

StyleName — Ignored by page layouts

not applicable

This property does not apply to page layouts.

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.

Examples

Change Page Margins of a Document Section

Create a Word report using the default template. Open the document and assign the document’s CurrentPageLayout property to a variable. Change the left and right margins for this layout.

import mlreportgen.dom.*;
d = Document('mydoc','docx');

open(d);
s = d.CurrentPageLayout;
s.PageMargins.Left = '2in';
s.PageMargins.Right = '2in';
p = Paragraph('Hello World');
append(d,p);

close(d);
rptview(d.OutputPath);