-
Notifications
You must be signed in to change notification settings - Fork 65
/
word.interfaces.paragraphcollectionloadoptions.yml
426 lines (426 loc) · 19.1 KB
/
word.interfaces.paragraphcollectionloadoptions.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
### YamlMime:TSType
name: Word.Interfaces.ParagraphCollectionLoadOptions
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.ParagraphCollectionLoadOptions
summary: 'Contains a collection of [Word.Paragraph](xref:word!Word.Paragraph:class) objects.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`<!-- -->) but not
the navigational properties (such as `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: alignment
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#alignment:member'
package: word!
fullName: alignment
summary: >-
For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered',
'right', or 'justified'.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'alignment?: boolean;'
return:
type: boolean
- name: firstLineIndent
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#firstLineIndent:member'
package: word!
fullName: firstLineIndent
summary: >-
For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a
positive value to set a first-line indent, and use a negative value to set a hanging indent.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'firstLineIndent?: boolean;'
return:
type: boolean
- name: font
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#font:member'
package: word!
fullName: font
summary: >-
For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size,
color, and other properties.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'font?: Word.Interfaces.FontLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.FontLoadOptions:interface" />'
- name: isLastParagraph
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#isLastParagraph:member'
package: word!
fullName: isLastParagraph
summary: 'For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body.'
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isLastParagraph?: boolean;'
return:
type: boolean
- name: isListItem
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#isListItem:member'
package: word!
fullName: isListItem
summary: 'For EACH ITEM in the collection: Checks whether the paragraph is a list item.'
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isListItem?: boolean;'
return:
type: boolean
- name: leftIndent
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#leftIndent:member'
package: word!
fullName: leftIndent
summary: 'For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'leftIndent?: boolean;'
return:
type: boolean
- name: lineSpacing
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#lineSpacing:member'
package: word!
fullName: lineSpacing
summary: >-
For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word
UI, this value is divided by 12.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'lineSpacing?: boolean;'
return:
type: boolean
- name: lineUnitAfter
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#lineUnitAfter:member'
package: word!
fullName: lineUnitAfter
summary: 'For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'lineUnitAfter?: boolean;'
return:
type: boolean
- name: lineUnitBefore
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#lineUnitBefore:member'
package: word!
fullName: lineUnitBefore
summary: 'For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'lineUnitBefore?: boolean;'
return:
type: boolean
- name: list
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#list:member'
package: word!
fullName: list
summary: >-
For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if
the paragraph isn't in a list.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'list?: Word.Interfaces.ListLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ListLoadOptions:interface" />'
- name: listItem
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#listItem:member'
package: word!
fullName: listItem
summary: >-
For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the
paragraph isn't part of a list.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'listItem?: Word.Interfaces.ListItemLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ListItemLoadOptions:interface" />'
- name: listItemOrNullObject
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#listItemOrNullObject:member'
package: word!
fullName: listItemOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then
this method will return an object with its `isNullObject` property set to `true`<!-- -->. For further information,
see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ListItemLoadOptions:interface" />'
- name: listOrNullObject
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#listOrNullObject:member'
package: word!
fullName: listOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list,
then this method will return an object with its `isNullObject` property set to `true`<!-- -->. For further
information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'listOrNullObject?: Word.Interfaces.ListLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ListLoadOptions:interface" />'
- name: outlineLevel
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#outlineLevel:member'
package: word!
fullName: outlineLevel
summary: 'For EACH ITEM in the collection: Specifies the outline level for the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'outlineLevel?: boolean;'
return:
type: boolean
- name: parentBody
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentBody:member'
package: word!
fullName: parentBody
summary: 'For EACH ITEM in the collection: Gets the parent body of the paragraph.'
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentBody?: Word.Interfaces.BodyLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
- name: parentContentControl
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentContentControl:member'
package: word!
fullName: parentContentControl
summary: >-
For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound`
error if there isn't a parent content control.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentContentControl?: Word.Interfaces.ContentControlLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
- name: parentContentControlOrNullObject
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentContentControlOrNullObject:member'
package: word!
fullName: parentContentControlOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent
content control, then this method will return an object with its `isNullObject` property set to `true`<!-- -->.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
- name: parentTable
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentTable:member'
package: word!
fullName: parentTable
summary: >-
For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it
isn't contained in a table.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentTable?: Word.Interfaces.TableLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
- name: parentTableCell
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentTableCell:member'
package: word!
fullName: parentTableCell
summary: >-
For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error
if it isn't contained in a table cell.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentTableCell?: Word.Interfaces.TableCellLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
- name: parentTableCellOrNullObject
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentTableCellOrNullObject:member'
package: word!
fullName: parentTableCellOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table
cell, then this method will return an object with its `isNullObject` property set to `true`<!-- -->. For further
information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
- name: parentTableOrNullObject
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#parentTableOrNullObject:member'
package: word!
fullName: parentTableOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table,
then this method will return an object with its `isNullObject` property set to `true`<!-- -->. For further
information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
- name: rightIndent
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#rightIndent:member'
package: word!
fullName: rightIndent
summary: 'For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rightIndent?: boolean;'
return:
type: boolean
- name: spaceAfter
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#spaceAfter:member'
package: word!
fullName: spaceAfter
summary: 'For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'spaceAfter?: boolean;'
return:
type: boolean
- name: spaceBefore
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#spaceBefore:member'
package: word!
fullName: spaceBefore
summary: 'For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'spaceBefore?: boolean;'
return:
type: boolean
- name: style
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#style:member'
package: word!
fullName: style
summary: >-
For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles
and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn"
property.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: boolean;'
return:
type: boolean
- name: styleBuiltIn
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#styleBuiltIn:member'
package: word!
fullName: styleBuiltIn
summary: >-
For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for
built-in styles that are portable between locales. To use custom styles or localized style names, see the "style"
property.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'styleBuiltIn?: boolean;'
return:
type: boolean
- name: tableNestingLevel
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#tableNestingLevel:member'
package: word!
fullName: tableNestingLevel
summary: >-
For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a
table.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tableNestingLevel?: boolean;'
return:
type: boolean
- name: text
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#text:member'
package: word!
fullName: text
summary: 'For EACH ITEM in the collection: Gets the text of the paragraph.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'text?: boolean;'
return:
type: boolean
- name: uniqueLocalId
uid: 'word!Word.Interfaces.ParagraphCollectionLoadOptions#uniqueLocalId:member'
package: word!
fullName: uniqueLocalId
summary: >-
For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID
is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
remarks: '\[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'uniqueLocalId?: boolean;'
return:
type: boolean