Class File

Hierarchy

File

Index

Constructors

constructor

Properties

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

Properties

Private appProperties

appProperties: AppProperties

Private contentTypes

contentTypes: ContentTypes

Private coreProperties

coreProperties: CoreProperties

Private docRelationships

docRelationships: Relationships

Private document

document: Document

Private fileRelationships

fileRelationships: Relationships

Private footerWrapper

footerWrapper: FooterWrapper

Private headerWrapper

headerWrapper: HeaderWrapper

Private media

media: Media

Private numbering

numbering: Numbering

Private styles

styles: Styles

Accessors

AppProperties

get AppProperties(): AppProperties

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

ContentTypes

get ContentTypes(): ContentTypes

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

CoreProperties

get CoreProperties(): CoreProperties

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

Document

get Document(): Document

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

DocumentRelationships

get DocumentRelationships(): Relationships

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

FileRelationships

get FileRelationships(): Relationships

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

Footer

get Footer(): FooterWrapper

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

Header

get Header(): HeaderWrapper

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

Media

get Media(): Media

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

Numbering

get Numbering(): Numbering

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

Styles

get Styles(): Styles

- Defined in file/file.ts:118
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

createImage

createImage(image: string): void

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

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