Class File

Hierarchy

File

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

- Defined in src/file/file.ts:64
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 src/file/file.ts:355
Returns AppProperties

ContentTypes

get ContentTypes(): ContentTypes

- Defined in src/file/file.ts:351
Returns ContentTypes

CoreProperties

get CoreProperties(): CoreProperties

- Defined in src/file/file.ts:323
Returns CoreProperties

Document

get Document(): Document

- Defined in src/file/file.ts:315
Returns Document

DocumentRelationships

get DocumentRelationships(): Relationships

- Defined in src/file/file.ts:335
Returns Relationships

FileRelationships

get FileRelationships(): Relationships

- Defined in src/file/file.ts:339
Returns Relationships

FootNotes

get FootNotes(): FootNotes

- Defined in src/file/file.ts:359
Returns FootNotes

Footers

get Footers(): FooterWrapper[]

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

Headers

get Headers(): HeaderWrapper[]

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

HyperlinkCache

get HyperlinkCache(): {}

- Defined in src/file/file.ts:367
Returns {}
- [key: string]: Hyperlink

Media

get Media(): Media

- Defined in src/file/file.ts:331
Returns Media

Numbering

get Numbering(): Numbering

- Defined in src/file/file.ts:327
Returns Numbering

Settings

get Settings(): Settings

- Defined in src/file/file.ts:363
Returns Settings

Styles

get Styles(): Styles

- Defined in src/file/file.ts:319
Returns Styles

Methods

addSection

addSection(__namedParameters: { children: (Paragraph | Table | TableOfContents | HyperlinkRef)[]; margins: IPageMarginAttributes; properties: undefined | (IPageSizeAttributes & IPageMarginAttributes & IDocGridAttributesProperties & IHeadersOptions & IFootersOptions & IPageNumberTypeAttributes & ILineNumberAttributes & IPageBordersOptions & ITitlePageOptions & ISectionVerticalAlignAttributes & { column?: undefined | { count?: undefined | number; space?: undefined | number } }); size: IPageSizeAttributes; footers: object; headers: object }): void

- Defined in src/file/file.ts:175
Parameters
- __namedParameters: { children: (Paragraph | Table | TableOfContents | HyperlinkRef)[]; margins: IPageMarginAttributes; properties: undefined | (IPageSizeAttributes & IPageMarginAttributes & IDocGridAttributesProperties & IHeadersOptions & IFootersOptions & IPageNumberTypeAttributes & ILineNumberAttributes & IPageBordersOptions & ITitlePageOptions & ISectionVerticalAlignAttributes & { column?: undefined | { count?: undefined | number; space?: undefined | number } }); size: IPageSizeAttributes; footers: object; headers: object }
  - children: (Paragraph | Table | TableOfContents | HyperlinkRef)[]
  - margins: IPageMarginAttributes
  - properties: undefined | (IPageSizeAttributes & IPageMarginAttributes & IDocGridAttributesProperties & IHeadersOptions & IFootersOptions & IPageNumberTypeAttributes & ILineNumberAttributes & IPageBordersOptions & ITitlePageOptions & ISectionVerticalAlignAttributes & { column?: undefined | { count?: undefined | number; space?: undefined | number } })
  - size: IPageSizeAttributes
  - footers: object
    - default: Header
  - headers: object
    - default: Header
Returns void

verifyUpdateFields

verifyUpdateFields(): void

- Defined in src/file/file.ts:210
Returns void

Generated using TypeDoc