-
Notifications
You must be signed in to change notification settings - Fork 61
/
word.interfaces.contentcontrolcollectionloadoptions.yml
343 lines (341 loc) · 15.2 KB
/
word.interfaces.contentcontrolcollectionloadoptions.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
### YamlMime:TSType
name: Word.Interfaces.ContentControlCollectionLoadOptions
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.ContentControlCollectionLoadOptions
summary: >-
Contains a collection of [Word.ContentControl](xref:word!Word.ContentControl:class) objects. Content controls are
bounded and potentially labeled regions in a document that serve as containers for specific types of content.
Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently,
only rich text and plain text content controls are supported.
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.ContentControlCollectionLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: appearance
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#appearance:member'
package: word!
fullName: appearance
summary: >-
For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox',
'Tags', or 'Hidden'.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'appearance?: boolean;'
return:
type: boolean
- name: cannotDelete
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#cannotDelete:member'
package: word!
fullName: cannotDelete
summary: >-
For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control.
Mutually exclusive with removeWhenEdited.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cannotDelete?: boolean;'
return:
type: boolean
- name: cannotEdit
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#cannotEdit:member'
package: word!
fullName: cannotEdit
summary: >-
For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the
content control.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cannotEdit?: boolean;'
return:
type: boolean
- name: color
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#color:member'
package: word!
fullName: color
summary: >-
For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '\#RRGGBB'
format or by using the color name.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'color?: boolean;'
return:
type: boolean
- name: font
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#font:member'
package: word!
fullName: font
summary: >-
For EACH ITEM in the collection: Gets the text format of the content control. 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: id
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#id:member'
package: word!
fullName: id
summary: 'For EACH ITEM in the collection: Gets an integer that represents the content control identifier.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
return:
type: boolean
- name: parentBody
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#parentBody:member'
package: word!
fullName: parentBody
summary: 'For EACH ITEM in the collection: Gets the parent body of the content control.'
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.ContentControlCollectionLoadOptions#parentContentControl:member'
package: word!
fullName: parentContentControl
summary: >-
For EACH ITEM in the collection: Gets the content control that contains the content control. 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.ContentControlCollectionLoadOptions#parentContentControlOrNullObject:member'
package: word!
fullName: parentContentControlOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the content control that contains the content control. 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.ContentControlCollectionLoadOptions#parentTable:member'
package: word!
fullName: parentTable
summary: >-
For EACH ITEM in the collection: Gets the table that contains the content control. 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.ContentControlCollectionLoadOptions#parentTableCell:member'
package: word!
fullName: parentTableCell
summary: >-
For EACH ITEM in the collection: Gets the table cell that contains the content control. 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.ContentControlCollectionLoadOptions#parentTableCellOrNullObject:member'
package: word!
fullName: parentTableCellOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the table cell that contains the content control. 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.ContentControlCollectionLoadOptions#parentTableOrNullObject:member'
package: word!
fullName: parentTableOrNullObject
summary: >-
For EACH ITEM in the collection: Gets the table that contains the content control. 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: placeholderText
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#placeholderText:member'
package: word!
fullName: placeholderText
summary: >-
For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be
displayed when the content control is empty.
Note: The set operation for this property isn't supported in Word on the web.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'placeholderText?: boolean;'
return:
type: boolean
- name: removeWhenEdited
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#removeWhenEdited:member'
package: word!
fullName: removeWhenEdited
summary: >-
For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it
is edited. Mutually exclusive with cannotDelete.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'removeWhenEdited?: boolean;'
return:
type: boolean
- name: style
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#style:member'
package: word!
fullName: style
summary: >-
For EACH ITEM in the collection: Specifies the style name for the content control. 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.ContentControlCollectionLoadOptions#styleBuiltIn:member'
package: word!
fullName: styleBuiltIn
summary: >-
For EACH ITEM in the collection: Specifies the built-in style name for the content control. 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: subtype
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#subtype:member'
package: word!
fullName: subtype
summary: >-
For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline',
'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls,
or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content
controls.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'subtype?: boolean;'
return:
type: boolean
- name: tag
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#tag:member'
package: word!
fullName: tag
summary: 'For EACH ITEM in the collection: Specifies a tag to identify a content control.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tag?: boolean;'
return:
type: boolean
- name: text
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#text:member'
package: word!
fullName: text
summary: 'For EACH ITEM in the collection: Gets the text of the content control.'
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: title
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#title:member'
package: word!
fullName: title
summary: 'For EACH ITEM in the collection: Specifies the title for a content control.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'title?: boolean;'
return:
type: boolean
- name: type
uid: 'word!Word.Interfaces.ContentControlCollectionLoadOptions#type:member'
package: word!
fullName: type
summary: >-
For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content
controls are supported currently.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
return:
type: boolean