Class Header

Hierarchy

InitializableXmlComponent
- Header

Index

Constructors

constructor

Properties

options

Accessors

Methods

Constructors

constructor

new Header(referenceNumber: number, initContent?: XmlComponent): Header

Overrides InitializableXmlComponent.constructor
- Defined in src/file/header/header.ts:8
Parameters
- referenceNumber: number
- Optional initContent: XmlComponent
Returns Header

Properties

options

options: IHeaderOptions

Accessors

IsDeleted

get IsDeleted(): boolean

Inherited from AppPropertiesAttributes.IsDeleted
- Defined in src/file/xml-components/base.ts:15
Returns boolean

ReferenceId

get ReferenceId(): number

- Defined in src/file/header/header.ts:49
Returns number

Methods

add

add(item: Paragraph | Table): void

- Defined in src/file/header/header.ts:53
Parameters
- item: Paragraph | Table
Returns void

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

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

delete

delete(): void

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

prepForXml

prepForXml(file?: File): IXmlableObject | undefined

Inherited from AppProperties.prepForXml

Overrides BaseXmlComponent.prepForXml
- Defined in src/file/xml-components/xml-component.ts:16
Parameters
- Optional file: File
Returns IXmlableObject | undefined

Generated using TypeDoc