Main Content

mlreportgen.dom.PDFPageLayout class

Package: mlreportgen.dom

Page format and layout for section of PDF document

Description

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

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Creation

Description

example

pageLayoutObj = mlreportgen.dom.PDFPageLayout() creates a PDFPageLayout object with default property values.

Properties

expand all

Page headers for this layout, specified as an array of mlreportgen.dom.PDFPageHeader 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

Page footers for this layout, specified as an array of mlreportgen.dom.PDFPageFooter 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

Watermark to apply to this section, specified as an mlreportgen.dom.Watermark object.

Type of hyphenation, specified as one of these values:

  • true — Enables hyphenation and uses '-' for the hyphenation character.

  • '-' — Enables hyphenation and uses '-' for the hyphenation character.

  • ' ' — Enables hyphenation and uses a space (' ') for the hyphenation character

  • false — Disables hyphenation.

Sizes of the margins, header, footer, and gutter for this page layout, specified as an mlreportgen.dom.PageMargins object.

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

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

Type of page numbering to use, specified as one of the character vectors or string scalars in the table.

ValueMeaningApplies To
DOCXPDF
'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 

Section break options, specified as one of these character vectors or string scalars:

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

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

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

This property does not apply to page layouts.

Formats to apply to this layout, specified as an array of format objects. Formats that do not apply to a page layout are ignored.

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.

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

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

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.

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.

Methods

expand all

Examples

collapse all

Use the CurrentPageLayout property of a document to access the PDFPageLayout object that represents the layout of the document. Change the left and right margins of the layout by setting the Left and Right properties of the mlreportgen.dom.PageMargins object used by the PDFPageLayout object.

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

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

close(d);
rptview(d);

By default, a PDFPageLayout object specifies a page with an 11-inch height, 8.5-half inch width, and portrait orientation. To change the orientation to landscape, use the rotate method of the PDFPageLayout object. The method updates the property values of the associated mlreportgen.dom.PageSize object so that the height is 8.5 inches, the width is 11 inches, and the orientation is landscape.

import mlreportgen.dom.*;
d = Document('myreport','pdf');
open(d);
 
pageLayoutObj = d.CurrentPageLayout;
rotate(pageLayoutObj);

append(d,'This document has landscape pages');
close(d);
rptview(d);
Introduced in R2016a