Files
docx-js/docs/usage/headers-and-footers.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2018-08-04 03:28:27 +01:00
# Headers and Footers
2019-08-03 13:42:24 +01:00
!> Headers and Footers requires an understanding of [Sections](usage/sections.md).
2018-08-04 03:28:27 +01:00
## Example
Creating Headers and footers is simple. Access the `Header` and `Footer` by doing so like this:
```ts
2018-08-04 03:28:27 +01:00
doc.Header;
doc.Footer;
```
You can call the same methods as you would with a `File`:
```ts
2018-08-04 03:28:27 +01:00
doc.Header.createParagraph("Header text");
doc.Footer.createParagraph("Footer text");
```
Even add images:
```ts
2018-08-12 23:07:31 +01:00
doc.Header.createImage([BUFFER_OF_YOUR_IMAGE]);
doc.Footer.createImage([BUFFER_OF_YOUR_IMAGE]);
2018-08-04 03:28:27 +01:00
```
2019-08-20 22:23:14 +01:00
Refer to [`8-header-footer`](https://github.com/dolanmiu/docx/blob/master/demo/8-header-footer.ts) for more information.
2018-08-04 03:28:27 +01:00
## Multiple Headers and Footers
Also all the supported section properties are implemented according to: http://officeopenxml.com/WPsection.php
### Example
```ts
2018-08-04 03:28:27 +01:00
const header = this.document.createHeader();
const footer = this.document.createFooter();
// Add new section with another header and footer
doc.addSection({
headers: {
2019-04-25 09:49:44 -04:00
default: header
},
footers: {
2019-04-25 09:49:44 -04:00
default: footer
},
2018-08-04 03:28:27 +01:00
pageNumberStart: 1,
pageNumberFormatType: docx.PageNumberFormat.DECIMAL,
});
```