Class File

Hierarchy

File

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

- Defined in file/file.ts:45
Parameters
- Default value options: IPropertiesOptions = {creator: "Un-named",revision: "1",lastModifiedBy: "Un-named",}
- Default value sectionPropertiesOptions: SectionPropertiesOptions = {}
- Default value fileProperties: IFileProperties = {}
Returns File

Accessors

AppProperties

get AppProperties(): AppProperties

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

ContentTypes

get ContentTypes(): ContentTypes

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

CoreProperties

get CoreProperties(): CoreProperties

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

Document

get Document(): Document

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

DocumentRelationships

get DocumentRelationships(): Relationships

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

FileRelationships

get FileRelationships(): Relationships

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

FootNotes

get FootNotes(): FootNotes

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

Footer

get Footer(): FooterWrapper

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

Footers

get Footers(): FooterWrapper[]

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

Header

get Header(): HeaderWrapper

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

Headers

get Headers(): HeaderWrapper[]

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

Media

get Media(): Media

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

Numbering

get Numbering(): Numbering

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

Settings

get Settings(): Settings

- Defined in file/file.ts:399
Returns Settings

Styles

get Styles(): Styles
set Styles(styles: Styles): void

- Defined in file/file.ts:343
Returns Styles
- Defined in file/file.ts:347
Parameters
- styles: Styles
Returns void

Methods

addImage

addImage(image: Image): File

- Defined in file/file.ts:132
Parameters
- image: Image
Returns File

addParagraph

addParagraph(paragraph: Paragraph): File

- Defined in file/file.ts:115
Parameters
- paragraph: Paragraph
Returns File

addSection

addSection(sectionPropertiesOptions: SectionPropertiesOptions): void

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

addTable

addTable(table: Table): void

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

addTableOfContents

addTableOfContents(toc: TableOfContents): void

- Defined in file/file.ts:111
Parameters
- toc: TableOfContents
Returns void

createBookmark

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

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

createFirstPageHeader

createFirstPageHeader(): HeaderWrapper

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

createFooter

createFooter(): FooterWrapper

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

createFootnote

createFootnote(paragraph: Paragraph): void

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

createHeader

createHeader(): HeaderWrapper

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

createHyperlink

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

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

createImage

createImage(buffer: Buffer | string | Uint8Array | ArrayBuffer, width?: undefined | number, height?: undefined | number): Image

- Defined in file/file.ts:137
Parameters
- buffer: Buffer | string | Uint8Array | ArrayBuffer
- Optional width: undefined | number
- Optional height: undefined | number
Returns Image

createInternalHyperLink

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

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

createParagraph

createParagraph(text?: undefined | string): Paragraph

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

createTable

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

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

getFooterByReferenceNumber

getFooterByReferenceNumber(refId: number): FooterWrapper

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

getHeaderByReferenceNumber

getHeaderByReferenceNumber(refId: number): HeaderWrapper

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

verifyUpdateFields

verifyUpdateFields(): void

- Defined in file/file.ts:219
Returns void

Generated using TypeDoc