Class File

Hierarchy

File

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new File(options?: IPropertiesOptions, fileProperties?: IFileProperties, sections?: ISectionOptions[]): File

- Defined in file/file.ts:63
Parameters
- Default value options: IPropertiesOptions = {creator: "Un-named",revision: "1",lastModifiedBy: "Un-named",}
- Default value fileProperties: IFileProperties = {}
- Default value sections: ISectionOptions[] = []
Returns File

Accessors

AppProperties

get AppProperties(): AppProperties

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

ContentTypes

get ContentTypes(): ContentTypes

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

CoreProperties

get CoreProperties(): CoreProperties

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

Document

get Document(): Document

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

DocumentRelationships

get DocumentRelationships(): Relationships

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

FileRelationships

get FileRelationships(): Relationships

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

FootNotes

get FootNotes(): FootNotes

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

Footers

get Footers(): FooterWrapper[]

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

Headers

get Headers(): HeaderWrapper[]

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

Media

get Media(): Media

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

Numbering

get Numbering(): Numbering

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

Settings

get Settings(): Settings

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

Styles

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

- Defined in file/file.ts:276
Returns Styles
- Defined in file/file.ts:280
Parameters
- styles: Styles
Returns void

Methods

addSection

addSection(__namedParameters: object): void

- Defined in file/file.ts:152
Parameters
- __namedParameters: object
Returns void

createBookmark

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

- Defined in file/file.ts:148
Parameters
- name: string
- Default value text: string = name
Returns Bookmark

createFootnote

createFootnote(paragraph: Paragraph): void

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

createHyperlink

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

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

createInternalHyperLink

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

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

verifyUpdateFields

verifyUpdateFields(): void

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

Generated using TypeDoc