docx
    Preparing search index...

    Class PageBorders

    Represents page borders (pgBorders) for a document section.

    This element specifies the borders to display around pages in a section, including which pages display the borders and how they are positioned.

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

    <xsd:complexType name="CT_PageBorders">
      <xsd:sequence>
        <xsd:element name="top" type="CT_TopPageBorder" minOccurs="0"/>
        <xsd:element name="left" type="CT_PageBorder" minOccurs="0"/>
        <xsd:element name="bottom" type="CT_BottomPageBorder" minOccurs="0"/>
        <xsd:element name="right" type="CT_PageBorder" minOccurs="0"/>
      </xsd:sequence>
      <xsd:attribute name="zOrder" type="ST_PageBorderZOrder" use="optional" default="front"/>
      <xsd:attribute name="display" type="ST_PageBorderDisplay" use="optional"/>
      <xsd:attribute name="offsetFrom" type="ST_PageBorderOffset" use="optional" default="text"/>
    </xsd:complexType>

    // Add page borders to all pages
    new PageBorders({
      pageBorders: {
        display: PageBorderDisplay.ALL_PAGES,
        offsetFrom: PageBorderOffsetFrom.PAGE,
        zOrder: PageBorderZOrder.FRONT
      },
      pageBorderTop: { style: BorderStyle.SINGLE, size: 24, color: "000000" },
      pageBorderBottom: { style: BorderStyle.SINGLE, size: 24, color: "000000" }
    });

    Hierarchy (View Summary)

    Index
    constructor
    writtenAs
    addChildElement prepForXml
    • get writtenAs(): readonly BaseXmlComponent[] | undefined
      Internal

      The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

      Returns readonly BaseXmlComponent[] | undefined

    Settings
    Member Visibility

    On This Page
    XSD Schema
    Constructors
    Accessors
    Methods