Class File

Hierarchy

File

Index

Constructors

constructor

new File(options?: IPropertiesOptions, sectionPropertiesOptions?: SectionPropertiesOptions): File

- Defined in file/file.ts:35
Parameters
- Optional options: IPropertiesOptions
- Optional sectionPropertiesOptions: SectionPropertiesOptions
Returns File

Accessors

AppProperties

get AppProperties(): AppProperties

- Defined in file/file.ts:289
Returns AppProperties

ContentTypes

get ContentTypes(): ContentTypes

- Defined in file/file.ts:285
Returns ContentTypes

CoreProperties

get CoreProperties(): CoreProperties

- Defined in file/file.ts:233
Returns CoreProperties

Document

get Document(): Document

- Defined in file/file.ts:225
Returns Document

DocumentRelationships

get DocumentRelationships(): Relationships

- Defined in file/file.ts:245
Returns Relationships

FileRelationships

get FileRelationships(): Relationships

- Defined in file/file.ts:249
Returns Relationships

FootNotes

get FootNotes(): FootNotes

- Defined in file/file.ts:293
Returns FootNotes

Footer

get Footer(): FooterWrapper

- Defined in file/file.ts:269
Returns FooterWrapper

Footers

get Footers(): FooterWrapper[]

- Defined in file/file.ts:273
Returns FooterWrapper[]

Header

get Header(): HeaderWrapper

- Defined in file/file.ts:253
Returns HeaderWrapper

Headers

get Headers(): HeaderWrapper[]

- Defined in file/file.ts:257
Returns HeaderWrapper[]

Media

get Media(): Media

- Defined in file/file.ts:241
Returns Media

Numbering

get Numbering(): Numbering

- Defined in file/file.ts:237
Returns Numbering

Styles

get Styles(): Styles

- Defined in file/file.ts:229
Returns Styles

Methods

FooterByRefNumber

FooterByRefNumber(refId: number): FooterWrapper

- Defined in file/file.ts:277
Parameters
- refId: number
Returns FooterWrapper

HeaderByRefNumber

HeaderByRefNumber(refId: number): HeaderWrapper

- Defined in file/file.ts:261
Parameters
- refId: number
Returns HeaderWrapper

addParagraph

addParagraph(paragraph: Paragraph): void

- Defined in file/file.ts:112
Parameters
- paragraph: Paragraph
Returns void

addSection

addSection(sectionPropertiesOptions: SectionPropertiesOptions): void

- Defined in file/file.ts:174
Parameters
- sectionPropertiesOptions: SectionPropertiesOptions
Returns void

addTable

addTable(table: Table): void

- Defined in file/file.ts:120
Parameters
- table: Table
Returns void

createBookmark

createBookmark(name: string, text?: undefined | string): Bookmark

- Defined in file/file.ts:168
Parameters
- name: string
- Optional text: undefined | string
Returns Bookmark

createFirstPageHeader

createFirstPageHeader(): HeaderWrapper

- Defined in file/file.ts:212
Returns HeaderWrapper

createFooter

createFooter(): FooterWrapper

- Defined in file/file.ts:200
Creates new footer.

Returns FooterWrapper

createFootnote

createFootnote(paragraph: Paragraph): void

- Defined in file/file.ts:178
Parameters
- paragraph: Paragraph
Returns void

createHeader

createHeader(): HeaderWrapper

- Defined in file/file.ts:185
Creates new header.

Returns HeaderWrapper

createHyperlink

createHyperlink(link: string, text?: undefined | string): Hyperlink

- Defined in file/file.ts:148
Parameters
- link: string
- Optional text: undefined | string
Returns Hyperlink

createImage

createImage(image: string): PictureRun

- Defined in file/file.ts:128
Parameters
- image: string
Returns PictureRun

createImageData

createImageData(imageName: string, data: Buffer, width?: undefined | number, height?: undefined | number): IMediaData

- Defined in file/file.ts:138
Parameters
- imageName: string
- data: Buffer
- Optional width: undefined | number
- Optional height: undefined | number
Returns IMediaData

createInternalHyperLink

createInternalHyperLink(anchor: string, text?: undefined | string): Hyperlink

- Defined in file/file.ts:160
Parameters
- anchor: string
- Optional text: undefined | string
Returns Hyperlink

createParagraph

createParagraph(text?: undefined | string): Paragraph

- Defined in file/file.ts:116
Parameters
- Optional text: undefined | string
Returns Paragraph

createTable

createTable(rows: number, cols: number): Table

- Defined in file/file.ts:124
Parameters
- rows: number
- cols: number
Returns Table

Generated using TypeDoc