mlreportgen.dom.DOCXPageMargins Class

Namespace: mlreportgen.dom
Superclasses:

Page margins for Microsoft Word page layout

Compatibility

Note

mlreportgen.dom.DOCXPageMargins will be removed in a future release. Use mlreportgen.dom.PageMargins instead.

Description

Specifies the size of the page margins of a section of a Microsoft^® Word document.

Construction

docxPageMarginsObj = DOCXPageMargins specifies default page margins, which are one inch for the top, bottom, left, and right margins, and one-half inch for the gutter, header, and footer margins.

Output Arguments

docxPageMarginsObj — Page margins

DOCXPageMargins object

Page margins, represented by an DOCXPageMargins object.

Properties

Bottom — Bottom margin size

character vector

character vector specifying the width of the bottom margin. The character vector must have the format valueUnits where Units is an abbreviation for the units in which the width size is expressed. Valid abbreviations are:

• no abbreviation — pixels

• px — pixels

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Footer — Footer size

character vector

Specify the size using the same format used for the Bottom property.

Gutter — Gutter size

character vector

Specify the size using the same format used for the Bottom property.

Header — Header size

character vector

Specify the size using the same format used for the Bottom property.

Id — Object identifier for mlreportgen.dom.DOCXPageMargins object

character vector | string scalar

Object identifier for the mlreportgen.dom.DOCXPageMargins object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable

true

Data Types: char | string

Left — Left margin size

character vector

Specify the size using the same format used for the Bottom property.

Right — Right margin size

character vector

Specify the size using the same format used for the Bottom property.

Tag — Tag for mlreportgen.dom.DOCXPageMargins object

character vector | string scalar

Tag for the mlreportgen.dom.DOCXPageMargins object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable

true

Data Types: char | string

Top — Top margin size

character vector

Specify the size using the same format used for the Bottom property.

Examples

Reset Default Margins

Reset the margins specified by the default DOM template.

import mlreportgen.dom.*;
d = Document('myreport','docx');
open(d);
 
s = d.CurrentPageLayout;
s.PageMargins.Left  = '.5in';
s.PageMargins.Right = '.5in';
append(d,'Left and right margins are .5 inch');

close(d);
rptview('myreport','docx');