mlreportgen.dom.DOCXPageLayout class
Package: mlreportgen.dom
Page format and layout for section of Microsoft Word document
Description
Use an mlreportgen.dom.DOCXPageLayout
object to define the page
format, headers, and footers of a section of a Microsoft® Word document.
The mlreportgen.dom.DOCXPageLayout
class is a handle
class.
Class Attributes
HandleCompatible | true |
ConstructOnLoad | true |
For information on class attributes, see Class Attributes.
Creation
Properties
PageHeaders
— Page headers for this layout
array of mlreportgen.dom.DOCXPageHeader
objects
Page headers for this layout, specified as an 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
PageFooters
— Page footers for this layout
array of mlreportgen.dom.DOCXPageFooter
objects
Page footers for this layout, specified as an 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
FirstPageNumber
— Number of first page in section
integer
Number of the first page in a section, specified as an integer.
Note
Page numbers are rendered only on
mlreportgen.dom.Page
objects that you append to
the document or to any part of the document. To render page numbers
in the page headers or footers, assign an
mlreportgen.dom.DOCXPageHeader
object to the
PageHeaders
property or an
mlreportgen.dom.DOCXPageFooter
object to the
PageFooters
property. Then append an
mlreportgen.dom.Page
object to the
DOCXPageHeader
or DOCXPageFooter
object. For example, see Add and Customize Page Numbers in a Microsoft® Word Document. Alternatively, you can append
mlreportgen.dom.Page
objects to the document
itself, or to elements in the document, but the page number renders
only on the part of the document where you append the
Page
object.
PageNumberFormat
— Type of page numbering to use
character vector | string scalar
Type of page numbering to use, specified as one of the character vectors or string scalars in the table.
Value | Meaning | Supported in DOCX | Supported in PDF |
---|---|---|---|
'a' | Lowercase alphabetic | Yes | Yes |
'A' | Uppercase alphabetic | Yes | Yes |
'i' | Lowercase Roman numerals | Yes | Yes |
'I' | Uppercase Roman numerals | Yes | Yes |
'n' , 'N' , '1' ,
'decimal' | Arabic numerals | Yes | Yes |
'numberInDash' | Number with dashes on either side | Yes | No |
'hebrew1' | Hebrew numerals | Yes | No |
'hebrew2' | Hebrew alphabetic | Yes | No |
'arabicAlpha' | Arabic alphabetic | Yes | No |
'arabicAbjad' | Arabic abjad numerals | Yes | No |
'thaiLetters' | Thai letters | Yes | No |
'thaiNumbers' | Thai numerals | Yes | No |
'thaiCounting' | Thai counting system | Yes | No |
Note
Page numbers are rendered only on
mlreportgen.dom.Page
objects that you append to
the document or to any part of the document. To render page numbers
in the page headers or footers, assign an
mlreportgen.dom.DOCXPageHeader
object to the
PageHeaders
property or an
mlreportgen.dom.DOCXPageFooter
object to the
PageFooters
property. Then append an
mlreportgen.dom.Page
object to the
DOCXPageHeader
or DOCXPageFooter
object. For example, see Add and Customize Page Numbers in a Microsoft® Word Document. Alternatively, you can append
mlreportgen.dom.Page
objects to the document
itself, or to elements in the document, but the page number renders
only on the part of the document where you append the
Page
object.
RawFormats
— XML markup for unsupported layout formats
cell array
XML markup for unsupported layout formats, specified as a cell array of character vectors. For information about XML markup for Word formats, see https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.
PageMargins
— Sizes of margins, header, footer, and gutter
mlreportgen.dom.PageMargins
object
Sizes of the margins, header, footer, and gutter for this page
layout, specified as an mlreportgen.dom.PageMargins
object.
PageSize
— Size of pages in this layout
mlreportgen.dom.PageSize
object
Size of pages in this layout, specified as an mlreportgen.dom.PageSize
object.
PageBorder
— Page borders for this layout
[]
(default) | mlreportgen.dom.PageBorder
object
Page borders for this layout, specified as an mlreportgen.dom.PageBorder
object.
SectionBreak
— Section break options
'Next Page'
| 'Same Page'
| 'Odd Page'
| 'Even Page'
Section break options, specified as one of these character vectors or string scalars:
'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.
StyleName
— Ignored by page layouts
not used
This property does not apply to page layouts.
Style
— Formats to apply to layout
array of format objects
Formats to apply to this layout, specified as an array of format objects. Formats that do not apply to a page layout are ignored.
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.
Parent
— Parent of document element
DOM object
Parent of this document element, specified as a DOM object. This property is read-only.
Attributes:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
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.
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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
Methods
Public Methods
rotate |
|
Examples
Change Page Margins of a Document Section
Use the CurrentPageLayout
property of a document to access the layout object for 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 layout object.
import mlreportgen.dom.*; d = Document('mydoc','docx'); open(d); pageLayoutObject = d.CurrentPageLayout; pageLayoutObject.PageMargins.Left = '2in'; pageLayoutObject.PageMargins.Right = '2in'; p = Paragraph('Hello World'); append(d,p); close(d); rptview(d);
Change the Page Orientation
By default, a DOCXPageLayout
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 DOCXPageLayout
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','docx'); open(d); pageLayoutObj = d.CurrentPageLayout; rotate(pageLayoutObj); append(d,'This document has landscape pages'); close(d); rptview(d);
Add and Customize Page Numbers in a Microsoft Word Document
This example shows how to add and customize page numbers in the footer section of a generated Word document.
Import this package so that you do not have to use long, fully qualified class names.
import mlreportgen.dom.*
Create an mlreportgen.dom.Document
object of type DOCX with a title.
document = Document("my_docx_w_page_numbers_document","docx"); heading = Heading(1,"Customize Page Numbers Example"); append(document,heading);
Add content to the document.
append(document,LineBreak); for pageInd = 1:5 append(document,sprintf("Content of page number %i",pageInd)); append(document,PageBreak); end append(document,Paragraph("Content of last page"));
Add a page footer to the document by assigning an mlreportgen.dom.DOCXPageFooter
object to the PageFooters
property of the current page layout. Then set the page number format of the current page layout to uppercase Roman numerals.
curLayout = document.CurrentPageLayout;
curLayout.PageFooters = DOCXPageFooter();
curLayout.PageNumberFormat = "I";
Append an mlreportgen.dom.Page
object to the page footer object.
append(curLayout.PageFooters,Page());
Close and view the document.
close(document); rptview(document);
Version History
Introduced in R2016a
See Also
mlreportgen.dom.DocumentPart
| mlreportgen.dom.DOCXSubDoc
| mlreportgen.dom.DOCXPageFooter
| mlreportgen.dom.DOCXPageHeader
| mlreportgen.dom.PageSize
| mlreportgen.dom.PageMargins
| mlreportgen.dom.PageBorder
| mlreportgen.dom.PageNumber
| mlreportgen.dom.PageRawFormat
| mlreportgen.dom.Page
Apri esempio
Si dispone di una versione modificata di questo esempio. Desideri aprire questo esempio con le tue modifiche?
Comando MATLAB
Hai fatto clic su un collegamento che corrisponde a questo comando MATLAB:
Esegui il comando inserendolo nella finestra di comando MATLAB. I browser web non supportano i comandi MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)