docx
    Preparing search index...

    Class SectionProperties

    Represents section properties (sectPr) in a WordprocessingML document.

    Section properties define the page layout for a section of the document, including page size, margins, headers/footers, columns, and page numbering. A document can contain multiple sections with different properties.

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

    <xsd:complexType name="CT_SectPr">
      <xsd:sequence>
        <xsd:group ref="EG_HdrFtrReferences" minOccurs="0" maxOccurs="6"/>
        <xsd:group ref="EG_SectPrContents" minOccurs="0"/>
        <xsd:element name="sectPrChange" type="CT_SectPrChange" minOccurs="0"/>
      </xsd:sequence>
      <xsd:attributeGroup ref="AG_SectPrAttributes"/>
    </xsd:complexType>

    // Create section with custom page size and margins
    new SectionProperties({
      page: {
        size: {
          width: 12240,
          height: 15840,
          orientation: PageOrientation.PORTRAIT
        },
        margin: {
          top: 1440,
          right: 1440,
          bottom: 1440,
          left: 1440
        },
        pageNumbers: {
          start: 1,
          formatType: NumberFormat.DECIMAL
        }
      },
      column: {
        count: 2,
        space: 720
      }
    });

    Hierarchy (View Summary)

    Index
    constructor
    AvailableTextWidth writtenAs
    addChildElement prepForXml
    • get AvailableTextWidth(): number

      Width, in twips, available to block-level content (paragraphs and tables) in this section.

      Page width minus the left and right margins and the gutter, divided among the section's columns when there is more than one. Tables use this to resolve percentage widths into the absolute twip grid that Google Docs, Apple Pages and other consumers lay tables out from.

      Returns number

      // A4 portrait with 1 inch margins
      new SectionProperties().AvailableTextWidth; // 11906 - 1440 - 1440 = 9026
    • 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

    • Prepares this component and its children for XML serialization.

      This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

      The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).

      Parameters

      • context: IContext

        The serialization context containing document state

      Returns IXmlableObject | undefined

      The XML-serializable object, or undefined to exclude from output

      // Override to add custom serialization logic
      prepForXml(context: IContext): IXmlableObject | undefined {
        // Custom logic here
        return super.prepForXml(context);
      }

    Settings
    Member Visibility

    On This Page
    XSD Schema
    Constructors
    Accessors
    Methods