-
Notifications
You must be signed in to change notification settings - Fork 62
/
word.bodytype.yml
86 lines (74 loc) · 2.96 KB
/
word.bodytype.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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
### YamlMime:TSEnum
name: Word.BodyType
uid: 'word!Word.BodyType:enum'
package: word!
fullName: Word.BodyType
summary: ''
remarks: >-
\[ [API set: WordApi 1.3](/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/50-document/manage-footnotes.yaml
// Gets the referenced note's item type and body type, which are both "Footnote".
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items");
await context.sync();
const referenceNumber = $("#input-reference").val();
const mark = (referenceNumber as number) - 1;
const item: Word.NoteItem = footnotes.items[mark];
console.log(`Note type of footnote ${referenceNumber}: ${item.type}`);
item.body.load("type");
await context.sync();
console.log(`Body type of note: ${item.body.type}`);
});
```
isPreview: false
isDeprecated: false
fields:
- name: endnote
uid: 'word!Word.BodyType.endnote:member'
package: word!
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Endnote"'
- name: footer
uid: 'word!Word.BodyType.footer:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Footer"'
- name: footnote
uid: 'word!Word.BodyType.footnote:member'
package: word!
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Footnote"'
- name: header
uid: 'word!Word.BodyType.header:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Header"'
- name: mainDoc
uid: 'word!Word.BodyType.mainDoc:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"MainDoc"'
- name: noteItem
uid: 'word!Word.BodyType.noteItem:member'
package: word!
summary: '* \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"NoteItem"'
- name: section
uid: 'word!Word.BodyType.section:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Section"'
- name: tableCell
uid: 'word!Word.BodyType.tableCell:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"TableCell"'
- name: unknown
uid: 'word!Word.BodyType.unknown:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Unknown"'