Class Body

Hierarchy

XmlComponent
- Body

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Body(sectionPropertiesOptions?: SectionPropertiesOptions): Body

Overrides XmlComponent.constructor
- Defined in file/document/body/body.ts:8
Parameters
- Optional sectionPropertiesOptions: SectionPropertiesOptions
Returns Body

Accessors

DefaultSection

get DefaultSection(): SectionProperties

- Defined in file/document/body/body.ts:50
Returns SectionProperties

IsDeleted

get IsDeleted(): boolean

Inherited from BaseXmlComponent.IsDeleted
- Defined in file/xml-components/base.ts:14
Returns boolean

Methods

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:43
Parameters
- child: XmlComponent | string
Returns XmlComponent

addSection

addSection(section: SectionPropertiesOptions | SectionProperties): void

- Defined in file/document/body/body.ts:25
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
- section: SectionPropertiesOptions | SectionProperties
  
  new section
Returns void

delete

delete(): void

Inherited from XmlComponent.delete
- Defined in file/xml-components/xml-component.ts:49
Returns void

getParagraphs

getParagraphs(): Paragraph[]

- Defined in file/document/body/body.ts:58
Returns Paragraph[]

getTablesOfContents

getTablesOfContents(): TableOfContents[]

- Defined in file/document/body/body.ts:54
Returns TableOfContents[]

prepForXml

prepForXml(): IXmlableObject | undefined

Overrides XmlComponent.prepForXml
- Defined in file/document/body/body.ts:38
Returns IXmlableObject | undefined

push

push(component: XmlComponent): void

- Defined in file/document/body/body.ts:46
Parameters
- component: XmlComponent
Returns void

Generated using TypeDoc