Function createPageMargin

createPageMargin(
    top:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`,
    right:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`,
    bottom:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`,
    left:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`,
    header:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`,
    footer:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`,
    gutter:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`,
): XmlComponent
Creates page margins (pgMar) for a document section.

This element specifies the page margins for all pages in a section, including top, bottom, left, right, header, footer, and gutter margins.

Reference: http://officeopenxml.com/WPsectionPr.php

XSD Schema
```
<xsd:complexType name="CT_PageMar">
  <xsd:attribute name="top" type="ST_SignedTwipsMeasure" use="required"/>
  <xsd:attribute name="right" type="s:ST_TwipsMeasure" use="required"/>
  <xsd:attribute name="bottom" type="ST_SignedTwipsMeasure" use="required"/>
  <xsd:attribute name="left" type="s:ST_TwipsMeasure" use="required"/>
  <xsd:attribute name="header" type="s:ST_TwipsMeasure" use="required"/>
  <xsd:attribute name="footer" type="s:ST_TwipsMeasure" use="required"/>
  <xsd:attribute name="gutter" type="s:ST_TwipsMeasure" use="required"/>
</xsd:complexType>
```
Parameters
- top:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
      | `-${number}mm`
      | `-${number}cm`
      | `-${number}in`
      | `-${number}pt`
      | `-${number}pc`
      | `-${number}pi`
- right:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
- bottom:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
      | `-${number}mm`
      | `-${number}cm`
      | `-${number}in`
      | `-${number}pt`
      | `-${number}pc`
      | `-${number}pi`
- left:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
- header:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
- footer:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
- gutter:
      | number
      | `${number}mm`
      | `${number}cm`
      | `${number}in`
      | `${number}pt`
      | `${number}pc`
      | `${number}pi`
Returns XmlComponent
Example
```
// Create page margins with 1 inch margins (1440 twips = 1 inch)
createPageMargin(1440, 1440, 1440, 1440, 720, 720, 0);
```
- Defined in file/document/body/section-properties/properties/page-margin.ts:70

Function createPageMargin

XSD Schema

Parameters

Returns XmlComponent

Example

Settings

On This Page