-
Notifications
You must be signed in to change notification settings - Fork 64
/
word.yml
242 lines (242 loc) · 12.4 KB
/
word.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
### YamlMime:TSPackage
uid: word!
name: word
type: package
summary: ''
enums:
- 'word!Word.Alignment:enum'
- 'word!Word.BreakType:enum'
- 'word!Word.ContentControlAppearance:enum'
- 'word!Word.ContentControlType:enum'
- 'word!Word.ErrorCodes:enum'
- 'word!Word.HeaderFooterType:enum'
- 'word!Word.InsertLocation:enum'
- 'word!Word.SaveBehavior:enum'
- 'word!Word.SelectionMode:enum'
- 'word!Word.UnderlineType:enum'
classes:
- 'word!Word.Body:class'
- 'word!Word.ContentControl:class'
- 'word!Word.ContentControlCollection:class'
- 'word!Word.Document:class'
- 'word!Word.Font:class'
- 'word!Word.InlinePicture:class'
- 'word!Word.InlinePictureCollection:class'
- 'word!Word.Paragraph:class'
- 'word!Word.ParagraphCollection:class'
- 'word!Word.Range:class'
- 'word!Word.RangeCollection:class'
- 'word!Word.RequestContext:class'
- 'word!Word.SearchOptions:class'
- 'word!Word.Section:class'
- 'word!Word.SectionCollection:class'
interfaces:
- 'word!Word.Interfaces.AnnotationCollectionData:interface'
- 'word!Word.Interfaces.AnnotationCollectionUpdateData:interface'
- 'word!Word.Interfaces.AnnotationData:interface'
- 'word!Word.Interfaces.BodyData:interface'
- 'word!Word.Interfaces.BodyLoadOptions:interface'
- 'word!Word.Interfaces.BodyUpdateData:interface'
- 'word!Word.Interfaces.BorderCollectionData:interface'
- 'word!Word.Interfaces.BorderCollectionUpdateData:interface'
- 'word!Word.Interfaces.BorderData:interface'
- 'word!Word.Interfaces.BorderUpdateData:interface'
- 'word!Word.Interfaces.CheckboxContentControlData:interface'
- 'word!Word.Interfaces.CheckboxContentControlUpdateData:interface'
- 'word!Word.Interfaces.CollectionLoadOptions:interface'
- 'word!Word.Interfaces.CommentCollectionData:interface'
- 'word!Word.Interfaces.CommentCollectionUpdateData:interface'
- 'word!Word.Interfaces.CommentContentRangeData:interface'
- 'word!Word.Interfaces.CommentContentRangeUpdateData:interface'
- 'word!Word.Interfaces.CommentData:interface'
- 'word!Word.Interfaces.CommentReplyCollectionData:interface'
- 'word!Word.Interfaces.CommentReplyCollectionUpdateData:interface'
- 'word!Word.Interfaces.CommentReplyData:interface'
- 'word!Word.Interfaces.CommentReplyUpdateData:interface'
- 'word!Word.Interfaces.CommentUpdateData:interface'
- 'word!Word.Interfaces.ContentControlCollectionData:interface'
- 'word!Word.Interfaces.ContentControlCollectionLoadOptions:interface'
- 'word!Word.Interfaces.ContentControlCollectionUpdateData:interface'
- 'word!Word.Interfaces.ContentControlData:interface'
- 'word!Word.Interfaces.ContentControlLoadOptions:interface'
- 'word!Word.Interfaces.ContentControlUpdateData:interface'
- 'word!Word.Interfaces.CritiqueAnnotationData:interface'
- 'word!Word.Interfaces.CustomPropertyCollectionData:interface'
- 'word!Word.Interfaces.CustomPropertyCollectionUpdateData:interface'
- 'word!Word.Interfaces.CustomPropertyData:interface'
- 'word!Word.Interfaces.CustomPropertyUpdateData:interface'
- 'word!Word.Interfaces.CustomXmlPartCollectionData:interface'
- 'word!Word.Interfaces.CustomXmlPartCollectionUpdateData:interface'
- 'word!Word.Interfaces.CustomXmlPartData:interface'
- 'word!Word.Interfaces.CustomXmlPartScopedCollectionData:interface'
- 'word!Word.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface'
- 'word!Word.Interfaces.DocumentCreatedData:interface'
- 'word!Word.Interfaces.DocumentCreatedUpdateData:interface'
- 'word!Word.Interfaces.DocumentData:interface'
- 'word!Word.Interfaces.DocumentLoadOptions:interface'
- 'word!Word.Interfaces.DocumentPropertiesData:interface'
- 'word!Word.Interfaces.DocumentPropertiesUpdateData:interface'
- 'word!Word.Interfaces.DocumentUpdateData:interface'
- 'word!Word.Interfaces.FieldCollectionData:interface'
- 'word!Word.Interfaces.FieldCollectionUpdateData:interface'
- 'word!Word.Interfaces.FieldData:interface'
- 'word!Word.Interfaces.FieldUpdateData:interface'
- 'word!Word.Interfaces.FontData:interface'
- 'word!Word.Interfaces.FontLoadOptions:interface'
- 'word!Word.Interfaces.FontUpdateData:interface'
- 'word!Word.Interfaces.InlinePictureCollectionData:interface'
- 'word!Word.Interfaces.InlinePictureCollectionLoadOptions:interface'
- 'word!Word.Interfaces.InlinePictureCollectionUpdateData:interface'
- 'word!Word.Interfaces.InlinePictureData:interface'
- 'word!Word.Interfaces.InlinePictureLoadOptions:interface'
- 'word!Word.Interfaces.InlinePictureUpdateData:interface'
- 'word!Word.Interfaces.ListCollectionData:interface'
- 'word!Word.Interfaces.ListCollectionUpdateData:interface'
- 'word!Word.Interfaces.ListData:interface'
- 'word!Word.Interfaces.ListItemData:interface'
- 'word!Word.Interfaces.ListItemUpdateData:interface'
- 'word!Word.Interfaces.ListLevelCollectionData:interface'
- 'word!Word.Interfaces.ListLevelCollectionUpdateData:interface'
- 'word!Word.Interfaces.ListLevelData:interface'
- 'word!Word.Interfaces.ListLevelUpdateData:interface'
- 'word!Word.Interfaces.ListTemplateData:interface'
- 'word!Word.Interfaces.ListTemplateUpdateData:interface'
- 'word!Word.Interfaces.NoteItemCollectionData:interface'
- 'word!Word.Interfaces.NoteItemCollectionUpdateData:interface'
- 'word!Word.Interfaces.NoteItemData:interface'
- 'word!Word.Interfaces.NoteItemUpdateData:interface'
- 'word!Word.Interfaces.ParagraphCollectionData:interface'
- 'word!Word.Interfaces.ParagraphCollectionLoadOptions:interface'
- 'word!Word.Interfaces.ParagraphCollectionUpdateData:interface'
- 'word!Word.Interfaces.ParagraphData:interface'
- 'word!Word.Interfaces.ParagraphFormatData:interface'
- 'word!Word.Interfaces.ParagraphFormatUpdateData:interface'
- 'word!Word.Interfaces.ParagraphLoadOptions:interface'
- 'word!Word.Interfaces.ParagraphUpdateData:interface'
- 'word!Word.Interfaces.RangeCollectionData:interface'
- 'word!Word.Interfaces.RangeCollectionLoadOptions:interface'
- 'word!Word.Interfaces.RangeCollectionUpdateData:interface'
- 'word!Word.Interfaces.RangeData:interface'
- 'word!Word.Interfaces.RangeLoadOptions:interface'
- 'word!Word.Interfaces.RangeUpdateData:interface'
- 'word!Word.Interfaces.SearchOptionsData:interface'
- 'word!Word.Interfaces.SearchOptionsLoadOptions:interface'
- 'word!Word.Interfaces.SearchOptionsUpdateData:interface'
- 'word!Word.Interfaces.SectionCollectionData:interface'
- 'word!Word.Interfaces.SectionCollectionLoadOptions:interface'
- 'word!Word.Interfaces.SectionCollectionUpdateData:interface'
- 'word!Word.Interfaces.SectionData:interface'
- 'word!Word.Interfaces.SectionLoadOptions:interface'
- 'word!Word.Interfaces.SectionUpdateData:interface'
- 'word!Word.Interfaces.SettingCollectionData:interface'
- 'word!Word.Interfaces.SettingCollectionUpdateData:interface'
- 'word!Word.Interfaces.SettingData:interface'
- 'word!Word.Interfaces.SettingUpdateData:interface'
- 'word!Word.Interfaces.ShadingData:interface'
- 'word!Word.Interfaces.ShadingUpdateData:interface'
- 'word!Word.Interfaces.StyleCollectionData:interface'
- 'word!Word.Interfaces.StyleCollectionUpdateData:interface'
- 'word!Word.Interfaces.StyleData:interface'
- 'word!Word.Interfaces.StyleUpdateData:interface'
- 'word!Word.Interfaces.TableBorderData:interface'
- 'word!Word.Interfaces.TableBorderUpdateData:interface'
- 'word!Word.Interfaces.TableCellCollectionData:interface'
- 'word!Word.Interfaces.TableCellCollectionUpdateData:interface'
- 'word!Word.Interfaces.TableCellData:interface'
- 'word!Word.Interfaces.TableCellUpdateData:interface'
- 'word!Word.Interfaces.TableCollectionData:interface'
- 'word!Word.Interfaces.TableCollectionUpdateData:interface'
- 'word!Word.Interfaces.TableData:interface'
- 'word!Word.Interfaces.TableRowCollectionData:interface'
- 'word!Word.Interfaces.TableRowCollectionUpdateData:interface'
- 'word!Word.Interfaces.TableRowData:interface'
- 'word!Word.Interfaces.TableRowUpdateData:interface'
- 'word!Word.Interfaces.TableStyleData:interface'
- 'word!Word.Interfaces.TableStyleUpdateData:interface'
- 'word!Word.Interfaces.TableUpdateData:interface'
- 'word!Word.Interfaces.TrackedChangeCollectionData:interface'
- 'word!Word.Interfaces.TrackedChangeCollectionUpdateData:interface'
- 'word!Word.Interfaces.TrackedChangeData:interface'
functions:
- name: 'Word.run(objects, batch)'
uid: 'word!Word.run:function(1)'
package: word!
summary: >-
Executes a batch script that performs actions on the Word object model, using the RequestContext of previously
created API objects.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) =>
Promise<T>): Promise<T>;
parameters:
- id: objects
description: >-
An array of previously created API objects. The array will be validated to make sure that all of the objects
share the same context. The batch will use this shared RequestContext, which means that any changes applied
to these objects will be picked up by `context.sync()`<!-- -->.
type: '<xref uid="office!OfficeExtension.ClientObject:class" />[]'
- id: batch
description: >-
A function that takes in a RequestContext and returns a promise (typically, just the result of
`context.sync()`<!-- -->). The context parameter facilitates requests to the Word application. Since the
Office add-in and the Word application run in two different processes, the RequestContext is required to get
access to the Word object model from the add-in.
type: '(context: <xref uid="word!Word.RequestContext:class" />) => Promise<T>'
return:
type: Promise<T>
description: ''
- name: 'Word.run(object, batch)'
uid: 'word!Word.run:function(2)'
package: word!
summary: >-
Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously
created API object. When the promise is resolved, any tracked objects that were automatically allocated during
execution will be released.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) =>
Promise<T>): Promise<T>;
parameters:
- id: object
description: >-
A previously created API object. The batch will use the same RequestContext as the passed-in object, which
means that any changes applied to the object will be picked up by `context.sync()`<!-- -->.
type: '<xref uid="office!OfficeExtension.ClientObject:class" />'
- id: batch
description: >-
A function that takes in a RequestContext and returns a promise (typically, just the result of
`context.sync()`<!-- -->). The context parameter facilitates requests to the Word application. Since the
Office add-in and the Word application run in two different processes, the RequestContext is required to get
access to the Word object model from the add-in.
type: '(context: <xref uid="word!Word.RequestContext:class" />) => Promise<T>'
return:
type: Promise<T>
description: ''
- name: Word.run(batch)
uid: 'word!Word.run:function(3)'
package: word!
summary: >-
Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the
promise is resolved, any tracked objects that were automatically allocated during execution will be released.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;'
parameters:
- id: batch
description: >-
A function that takes in a RequestContext and returns a promise (typically, just the result of
`context.sync()`<!-- -->). The context parameter facilitates requests to the Word application. Since the
Office add-in and the Word application run in two different processes, the RequestContext is required to get
access to the Word object model from the add-in.
type: '(context: <xref uid="word!Word.RequestContext:class" />) => Promise<T>'
return:
type: Promise<T>
description: ''