-
Notifications
You must be signed in to change notification settings - Fork 61
/
word.listbullet.yml
90 lines (72 loc) · 2.95 KB
/
word.listbullet.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
87
88
89
90
### YamlMime:TSEnum
name: Word.ListBullet
uid: 'word!Word.ListBullet:enum'
package: word!
fullName: Word.ListBullet
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/20-lists/organize-list.yaml
// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
const paragraphs = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Use the first paragraph to start a new list.
const list = paragraphs.items[0].startNewList();
list.load("$none");
await context.sync();
// To add new items to the list, use Start or End on the insertLocation parameter.
list.insertParagraph("New list item at the start of the list", "Start");
const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");
// Set numbering for list level 1.
list.setLevelNumbering(0, Word.ListNumbering.arabic);
// Set bullet type for list level 5.
list.setLevelBullet(4, Word.ListBullet.arrow);
// Set list level for the last item in this list.
paragraph.listItem.level = 4;
list.load("levelTypes");
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: arrow
uid: 'word!Word.ListBullet.arrow:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Arrow"'
- name: checkmark
uid: 'word!Word.ListBullet.checkmark:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Checkmark"'
- name: custom
uid: 'word!Word.ListBullet.custom:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Custom"'
- name: diamonds
uid: 'word!Word.ListBullet.diamonds:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Diamonds"'
- name: hollow
uid: 'word!Word.ListBullet.hollow:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Hollow"'
- name: solid
uid: 'word!Word.ListBullet.solid:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Solid"'
- name: square
uid: 'word!Word.ListBullet.square:member'
package: word!
summary: '* \[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
value: '"Square"'