Class Body

Represents the document body in a WordprocessingML document.

The body element is the container for all block-level content in the document. This includes paragraphs, tables, and section properties that define page layout.

The body supports multiple sections, where each section (except the last one) must have its section properties stored in a paragraph's properties at the end of that section. The last section's properties are stored as a direct child of the body element.

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

XSD Schema

<xsd:complexType name="CT_Body">
  <xsd:sequence>
    <xsd:group ref="EG_BlockLevelElts" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element name="sectPr" minOccurs="0" maxOccurs="1" type="CT_SectPr"/>
  </xsd:sequence>
</xsd:complexType>

Example

// Body is typically created internally by the Document class
const doc = new Document({});
const body = doc.Body;

// Add content to the body via Document.add()
doc.add(new Paragraph("Content in first section"));

// Add a new section
body.addSection({
  page: {
    size: { width: 12240, height: 15840 },
  },
});

// Content after addSection belongs to the new section
doc.add(new Paragraph("Content in second section"));

Hierarchy (View Summary)

XmlComponent
- Body

Index

Constructors

constructor

Methods

addChildElement addSection prepForXml push

Constructors

constructor

new Body(): Body
Returns Body
Overrides XmlComponent.constructor
- Defined in file/document/body/body.ts:59

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Adds a child element to this component.
Parameters
- child: string | XmlComponent
  The child component or text string to add
Returns XmlComponent
This component (for chaining)

Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:126

addSection

addSection(options: ISectionPropertiesOptions): void
Adds new section properties to the document body.

Creates a new section by moving the previous section's properties into a paragraph at the end of that section, and then adding the new section as the current section.

According to the OOXML specification:
- Section properties for all sections except the last must be stored in a paragraph's properties (pPr/sectPr) at the end of each section
- The last section's properties are stored as a direct child of the body element (w:body/w:sectPr)
Parameters
- options: ISectionPropertiesOptions
  Section properties configuration (page size, margins, headers, footers, etc.)
Returns void
- Defined in file/document/body/body.ts:76

prepForXml

prepForXml(context: IContext): IXmlableObject | undefined
Prepares the body element for XML serialization.

Ensures that the last section's properties are placed as a direct child of the body element, as required by the OOXML specification.
Parameters
- context: IContext
  The XML serialization context
Returns IXmlableObject | undefined
The prepared XML object or undefined
Overrides XmlComponent.prepForXml
- Defined in file/document/body/body.ts:92

push

push(component: XmlComponent): void
Adds a block-level component to the body.

This method is used internally by the Document class to add paragraphs, tables, and other block-level elements to the document body.
Parameters
- component: XmlComponent
  The XML component to add (paragraph, table, etc.)
Returns void
- Defined in file/document/body/body.ts:109

Class Body

XSD Schema

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns Body

Methods

addChildElement

Parameters

Returns XmlComponent

Deprecated

addSection

Parameters

Returns void

prepForXml

Parameters

Returns IXmlableObject | undefined

push

Parameters

Returns void

Settings

On This Page