Page Layout

Alignment, margins, page breaks, fonts, headers and footers

You can specify formatting by using Microsoft^® Word, PDF, and HTML template formatting styles.

Classes

Report Layout, Alignment, Height, and Width

`mlreportgen.report.ReportLayout`	Page layout of report
`mlreportgen.report.ReporterLayout`	Layout for reporter
`mlreportgen.dom.HAlign`	Specify horizontal alignment of document object
`mlreportgen.dom.VAlign`	Vertical alignment of document object
`mlreportgen.dom.Height`	Height of object
`mlreportgen.dom.Width`	Object width
`mlreportgen.dom.StyleRef`	Placeholder for reference to content with specified style name or outline level

Margins and Page Breaks

`mlreportgen.dom.InnerMargin`	Margin between content and bounding box
`mlreportgen.dom.OuterMargin`	Margin between bounding box and its surroundings
`mlreportgen.dom.NumPages`	Create placeholder for number of document pages
`mlreportgen.dom.PageMargins`	Page margins for Microsoft Word and PDF page layout
`mlreportgen.dom.KeepLinesTogether`	Start paragraph on new page if necessary
`mlreportgen.dom.KeepWithNext`	Keep document element on same page as next
`mlreportgen.dom.LineBreak`	Line break in a Word or PDF report
`mlreportgen.dom.PageBreak`	Page break in a Word or PDF report
`mlreportgen.dom.PageBreakBefore`	Start paragraph on new page
`mlreportgen.dom.WidowOrphanControl`	Widow and orphan handling

Hyphenation, Border, Watermarks, Background Color

`mlreportgen.dom.BackgroundColor`	Background color of document element
`mlreportgen.dom.CharEntity`	Create character entity reference
`mlreportgen.dom.FlowDirection`	Direction of text or table column flow
`mlreportgen.dom.HorizontalRule`	Horizontal line between report content
`mlreportgen.dom.Hyphenation`	Enable hyphenation
`mlreportgen.dom.PageBorder`	Page borders for Microsoft Word and PDF page layouts (Since R2021b)
`mlreportgen.dom.Watermark`	Add watermark to pages in sections of PDF reports
`mlreportgen.dom.WhiteSpace`	White space type

Page Layout, Header, Footer

`mlreportgen.dom.DOCXPageLayout`	Page format and layout for section of Microsoft Word document
`mlreportgen.dom.PDFPageLayout`	Page format and layout for section of PDF document
`mlreportgen.dom.DOCXPageHeader`	Page header definition for Microsoft Word document
`mlreportgen.dom.DOCXPageFooter`	Page footer definition for Microsoft Word document
`mlreportgen.dom.PDFPageHeader`	Page header definition for PDF document
`mlreportgen.dom.PDFPageFooter`	Page footer definition for PDF document
`mlreportgen.dom.PageRawFormat`	XML markup for array of Microsoft Word formats
`mlreportgen.dom.RawText`	Microsoft Word XML or HTML markup to insert in document
`mlreportgen.report.HTMLModuleTabs`	Create tabbed panels (Since R2020a)

Page Size

`mlreportgen.dom.Page`	Create page number placeholder
`mlreportgen.dom.PageSize`	Size and orientation of pages in Microsoft Word and PDF reports
`mlreportgen.dom.DOCXPageSize`	(To be removed) Size and orientation of pages in Microsoft Word document
`mlreportgen.dom.NumPages`	Create placeholder for number of document pages
`mlreportgen.dom.StyleRef`	Placeholder for reference to content with specified style name or outline level
`mlreportgen.dom.VerticalAlign`	Vertical alignment of an inline document element

CSS and FO

`mlreportgen.dom.CSSProperties`	Array of CSS properties for formatting HTML output
`mlreportgen.dom.CSSProperty`	CSS property object for formatting HTML output
`mlreportgen.dom.FOProperties`	Array of FO properties for formatting PDF output
`mlreportgen.dom.FOProperty`	FO property for PDF output

Topics

Create Page Layout Sections
Create report sections. Divide a Word or PDF report into sections with different layouts.
Create Page Footers and Headers
Create footers and headers for a report.
Customize the Page Size and Margins of a Report Programmatically
Use Report API objects to customize page dimensions.
Set Page Margins in a Word Report
Define margins and header, footer, and gutter sizes for a DOCX page.
Customize the Page Size and Margins of a Word Report Using Templates
Modify the page dimensions in the Word templates for the title page, table of contents, and chapter reporters.
Set Page Margins in a PDF Report
Define margins and header, footer, and gutter sizes for a PDF page.
Customize the Page Size and Margins of a PDF Report Using Templates
Modify the page dimensions in the PDF templates for the title page, table of contents, and chapter reporters.
Style Sheet Cells for Headers and Footers
Use style sheet cells to manage headers and footers in reports.
Create a Report with Landscape Pages
Generate a report that has landscape pages.
Create a Report with Portrait and Landscape Pages
Generate a report that has both portrait and landscape pages.
Side-by-Side Figures
Arrange MATLAB figures next to each other on a page.
Side-by-Side Images
Arrange images next to each other on a page.
Scale Image to Fit Page
Use an mlreportgen.dom.ScaleToFit object to make an image fit on a page.
Center Figure Snapshot on a Page
Center a figure snapshot on a landscape page for PDF and Word reports.
Center Image on a Page
Center an image using an invisible 1-by-1 table that has the same size as the page body.
Center Formal Image in a PDF Report
Center a formal image using an invisible 1-by-1 table that has the same size as the page body.
Configure PDF Fonts
For PDF output, MATLAB^® Report Generator™ comes configured with default fonts: a serif, a sans serif, and dingbats.
Report Formatting Approaches
Format a report by using style sheets, format objects, or format properties.
Use Style Sheet Styles
A style is a collection of formats that define the appearance of a document object, such as a paragraph, table, or list.
Format Inheritance
The DOM API allows you to use template-based styles and format object-based styles (or equivalent format properties) to specify the appearance of an object.