Class File

Hierarchy

File

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

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

Accessors

AppProperties

get AppProperties(): AppProperties

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

ContentTypes

get ContentTypes(): ContentTypes

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

CoreProperties

get CoreProperties(): CoreProperties

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

Document

get Document(): Document

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

DocumentRelationships

get DocumentRelationships(): Relationships

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

FileRelationships

get FileRelationships(): Relationships

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

Footer

get Footer(): FooterWrapper

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

Header

get Header(): HeaderWrapper

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

Media

get Media(): Media

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

Numbering

get Numbering(): Numbering

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

Styles

get Styles(): Styles

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

Methods

addParagraph

addParagraph(paragraph: Paragraph): void

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

addTable

addTable(table: Table): void

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

createHyperlink

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

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

createImage

createImage(image: string): PictureRun

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

createParagraph

createParagraph(text?: undefined | string): Paragraph

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

createTable

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

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

Generated using TypeDoc