Class Body

Hierarchy (View Summary)

XmlComponent
- Body

Index

Constructors

Methods

addChildElement addSection prepForXml push

Constructors

constructor

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

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Parameters
- child: string | XmlComponent
Returns XmlComponent
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:48

addSection

addSection(options: ISectionPropertiesOptions): void
Adds new section properties. Note: Previous section is created in paragraph after the current element, and then new section will be added. The spec says:
- section element should be in the last paragraph of the section
- last section should be direct child of body
Parameters
- options: ISectionPropertiesOptions
  new section options
Returns void
- Defined in file/document/body/body.ts:23

prepForXml

prepForXml(context: IContext): undefined | IXmlableObject
Parameters
- context: IContext
Returns undefined | IXmlableObject
Overrides XmlComponent.prepForXml
- Defined in file/document/body/body.ts:30

push

push(component: XmlComponent): void
Parameters
- component: XmlComponent
Returns void
- Defined in file/document/body/body.ts:39