/
word.headerfootertype.yml
58 lines (45 loc) · 1.67 KB
/
word.headerfootertype.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
### YamlMime:TSEnum
name: Word.HeaderFooterType
uid: 'word!Word.HeaderFooterType:enum'
package: word!
fullName: Word.HeaderFooterType
summary: ''
remarks: >-
\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml
await Word.run(async (context) => {
context.document.sections
.getFirst()
.getHeader(Word.HeaderFooterType.primary)
.insertParagraph("This is a primary header.", "End");
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: evenPages
uid: 'word!Word.HeaderFooterType.evenPages:member'
package: word!
summary: |-
Returns all headers or footers on even-numbered pages of a section.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"EvenPages"'
- name: firstPage
uid: 'word!Word.HeaderFooterType.firstPage:member'
package: word!
summary: |-
Returns the header or footer on the first page of a section.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"FirstPage"'
- name: primary
uid: 'word!Word.HeaderFooterType.primary:member'
package: word!
summary: >-
Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are
different.
* \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
value: '"Primary"'