@types/office-js 1.0.366 → 1.0.367
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +1079 -321
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -84079,6 +84079,377 @@ declare namespace Excel {
|
|
|
84079
84079
|
////////////////////////////////////////////////////////////////
|
|
84080
84080
|
|
|
84081
84081
|
declare namespace Word {
|
|
84082
|
+
/**
|
|
84083
|
+
* Represents the color scheme of a critique in the document, affecting underline and highlight.
|
|
84084
|
+
*
|
|
84085
|
+
* @remarks
|
|
84086
|
+
* [Api set: WordApi 1.7]
|
|
84087
|
+
*/
|
|
84088
|
+
enum CritiqueColorScheme {
|
|
84089
|
+
/**
|
|
84090
|
+
* Red color.
|
|
84091
|
+
* @remarks
|
|
84092
|
+
* [Api set: WordApi 1.7]
|
|
84093
|
+
*/
|
|
84094
|
+
red = "Red",
|
|
84095
|
+
/**
|
|
84096
|
+
* Green color.
|
|
84097
|
+
* @remarks
|
|
84098
|
+
* [Api set: WordApi 1.7]
|
|
84099
|
+
*/
|
|
84100
|
+
green = "Green",
|
|
84101
|
+
/**
|
|
84102
|
+
* Blue color.
|
|
84103
|
+
* @remarks
|
|
84104
|
+
* [Api set: WordApi 1.7]
|
|
84105
|
+
*/
|
|
84106
|
+
blue = "Blue",
|
|
84107
|
+
/**
|
|
84108
|
+
* Lavender color.
|
|
84109
|
+
* @remarks
|
|
84110
|
+
* [Api set: WordApi 1.7]
|
|
84111
|
+
*/
|
|
84112
|
+
lavender = "Lavender",
|
|
84113
|
+
/**
|
|
84114
|
+
* Berry color.
|
|
84115
|
+
* @remarks
|
|
84116
|
+
* [Api set: WordApi 1.7]
|
|
84117
|
+
*/
|
|
84118
|
+
berry = "Berry",
|
|
84119
|
+
}
|
|
84120
|
+
/**
|
|
84121
|
+
* Critique that will be rendered as underline for the specified part of paragraph in the document.
|
|
84122
|
+
*
|
|
84123
|
+
* @remarks
|
|
84124
|
+
* [Api set: WordApi 1.7]
|
|
84125
|
+
*/
|
|
84126
|
+
interface Critique {
|
|
84127
|
+
/**
|
|
84128
|
+
* Gets the color scheme of the critique.
|
|
84129
|
+
*
|
|
84130
|
+
* @remarks
|
|
84131
|
+
* [Api set: WordApi 1.7]
|
|
84132
|
+
*/
|
|
84133
|
+
colorScheme: Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry";
|
|
84134
|
+
/**
|
|
84135
|
+
* Gets the length of the critique inside paragraph.
|
|
84136
|
+
*
|
|
84137
|
+
* @remarks
|
|
84138
|
+
* [Api set: WordApi 1.7]
|
|
84139
|
+
*/
|
|
84140
|
+
length: number;
|
|
84141
|
+
/**
|
|
84142
|
+
* Gets the start index of the critique inside paragraph.
|
|
84143
|
+
*
|
|
84144
|
+
* @remarks
|
|
84145
|
+
* [Api set: WordApi 1.7]
|
|
84146
|
+
*/
|
|
84147
|
+
start: number;
|
|
84148
|
+
}
|
|
84149
|
+
/**
|
|
84150
|
+
* Represents an annotation wrapper around critique displayed in the document.
|
|
84151
|
+
*
|
|
84152
|
+
* @remarks
|
|
84153
|
+
* [Api set: WordApi 1.7]
|
|
84154
|
+
*/
|
|
84155
|
+
class CritiqueAnnotation extends OfficeExtension.ClientObject {
|
|
84156
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
84157
|
+
context: RequestContext;
|
|
84158
|
+
/**
|
|
84159
|
+
* Gets the range of text that is annotated.
|
|
84160
|
+
*
|
|
84161
|
+
* @remarks
|
|
84162
|
+
* [Api set: WordApi 1.7]
|
|
84163
|
+
*/
|
|
84164
|
+
readonly range: Word.Range;
|
|
84165
|
+
/**
|
|
84166
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
84167
|
+
*
|
|
84168
|
+
* @remarks
|
|
84169
|
+
* [Api set: WordApi 1.7]
|
|
84170
|
+
*/
|
|
84171
|
+
readonly critique: Word.Critique;
|
|
84172
|
+
/**
|
|
84173
|
+
* Accepts the critique. This will change the annotation state to `accepted`.
|
|
84174
|
+
*
|
|
84175
|
+
* @remarks
|
|
84176
|
+
* [Api set: WordApi 1.7]
|
|
84177
|
+
*/
|
|
84178
|
+
accept(): void;
|
|
84179
|
+
/**
|
|
84180
|
+
* Rejects the critique. This will change the annotation state to `rejected`.
|
|
84181
|
+
*
|
|
84182
|
+
* @remarks
|
|
84183
|
+
* [Api set: WordApi 1.7]
|
|
84184
|
+
*/
|
|
84185
|
+
reject(): void;
|
|
84186
|
+
/**
|
|
84187
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84188
|
+
*
|
|
84189
|
+
* @param options Provides options for which properties of the object to load.
|
|
84190
|
+
*/
|
|
84191
|
+
load(options?: Word.Interfaces.CritiqueAnnotationLoadOptions): Word.CritiqueAnnotation;
|
|
84192
|
+
/**
|
|
84193
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84194
|
+
*
|
|
84195
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
84196
|
+
*/
|
|
84197
|
+
load(propertyNames?: string | string[]): Word.CritiqueAnnotation;
|
|
84198
|
+
/**
|
|
84199
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84200
|
+
*
|
|
84201
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
84202
|
+
*/
|
|
84203
|
+
load(propertyNamesAndPaths?: {
|
|
84204
|
+
select?: string;
|
|
84205
|
+
expand?: string;
|
|
84206
|
+
}): Word.CritiqueAnnotation;
|
|
84207
|
+
/**
|
|
84208
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84209
|
+
*/
|
|
84210
|
+
track(): Word.CritiqueAnnotation;
|
|
84211
|
+
/**
|
|
84212
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84213
|
+
*/
|
|
84214
|
+
untrack(): Word.CritiqueAnnotation;
|
|
84215
|
+
/**
|
|
84216
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
84217
|
+
* Whereas the original Word.CritiqueAnnotation object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
84218
|
+
*/
|
|
84219
|
+
toJSON(): Word.Interfaces.CritiqueAnnotationData;
|
|
84220
|
+
}
|
|
84221
|
+
/**
|
|
84222
|
+
* Represents the state of the annotation.
|
|
84223
|
+
*
|
|
84224
|
+
* @remarks
|
|
84225
|
+
* [Api set: WordApi 1.7]
|
|
84226
|
+
*/
|
|
84227
|
+
enum AnnotationState {
|
|
84228
|
+
/**
|
|
84229
|
+
* Created.
|
|
84230
|
+
* @remarks
|
|
84231
|
+
* [Api set: WordApi 1.7]
|
|
84232
|
+
*/
|
|
84233
|
+
created = "Created",
|
|
84234
|
+
/**
|
|
84235
|
+
* Accepted.
|
|
84236
|
+
* @remarks
|
|
84237
|
+
* [Api set: WordApi 1.7]
|
|
84238
|
+
*/
|
|
84239
|
+
accepted = "Accepted",
|
|
84240
|
+
/**
|
|
84241
|
+
* Rejected.
|
|
84242
|
+
* @remarks
|
|
84243
|
+
* [Api set: WordApi 1.7]
|
|
84244
|
+
*/
|
|
84245
|
+
rejected = "Rejected",
|
|
84246
|
+
}
|
|
84247
|
+
/**
|
|
84248
|
+
* Annotations set produced by the add-in. Currently supporting only critiques.
|
|
84249
|
+
*
|
|
84250
|
+
* @remarks
|
|
84251
|
+
* [Api set: WordApi 1.7]
|
|
84252
|
+
*/
|
|
84253
|
+
interface AnnotationSet {
|
|
84254
|
+
/**
|
|
84255
|
+
* Critiques.
|
|
84256
|
+
*
|
|
84257
|
+
* @remarks
|
|
84258
|
+
* [Api set: WordApi 1.7]
|
|
84259
|
+
*/
|
|
84260
|
+
critiques: Word.Critique[];
|
|
84261
|
+
}
|
|
84262
|
+
/**
|
|
84263
|
+
* Represents an annotation attached to a paragraph.
|
|
84264
|
+
*
|
|
84265
|
+
* @remarks
|
|
84266
|
+
* [Api set: WordApi 1.7]
|
|
84267
|
+
*/
|
|
84268
|
+
class Annotation extends OfficeExtension.ClientObject {
|
|
84269
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
84270
|
+
context: RequestContext;
|
|
84271
|
+
/**
|
|
84272
|
+
* Gets the critique annotation object.
|
|
84273
|
+
*
|
|
84274
|
+
* @remarks
|
|
84275
|
+
* [Api set: WordApi 1.7]
|
|
84276
|
+
*/
|
|
84277
|
+
readonly critiqueAnnotation: Word.CritiqueAnnotation;
|
|
84278
|
+
/**
|
|
84279
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
84280
|
+
*
|
|
84281
|
+
* @remarks
|
|
84282
|
+
* [Api set: WordApi 1.7]
|
|
84283
|
+
*/
|
|
84284
|
+
readonly id: string;
|
|
84285
|
+
/**
|
|
84286
|
+
* Gets the state of the annotation.
|
|
84287
|
+
*
|
|
84288
|
+
* @remarks
|
|
84289
|
+
* [Api set: WordApi 1.7]
|
|
84290
|
+
*/
|
|
84291
|
+
readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
84292
|
+
/**
|
|
84293
|
+
* Deletes the annotation.
|
|
84294
|
+
*
|
|
84295
|
+
* @remarks
|
|
84296
|
+
* [Api set: WordApi 1.7]
|
|
84297
|
+
*/
|
|
84298
|
+
delete(): void;
|
|
84299
|
+
/**
|
|
84300
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84301
|
+
*
|
|
84302
|
+
* @param options Provides options for which properties of the object to load.
|
|
84303
|
+
*/
|
|
84304
|
+
load(options?: Word.Interfaces.AnnotationLoadOptions): Word.Annotation;
|
|
84305
|
+
/**
|
|
84306
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84307
|
+
*
|
|
84308
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
84309
|
+
*/
|
|
84310
|
+
load(propertyNames?: string | string[]): Word.Annotation;
|
|
84311
|
+
/**
|
|
84312
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84313
|
+
*
|
|
84314
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
84315
|
+
*/
|
|
84316
|
+
load(propertyNamesAndPaths?: {
|
|
84317
|
+
select?: string;
|
|
84318
|
+
expand?: string;
|
|
84319
|
+
}): Word.Annotation;
|
|
84320
|
+
/**
|
|
84321
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84322
|
+
*/
|
|
84323
|
+
track(): Word.Annotation;
|
|
84324
|
+
/**
|
|
84325
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84326
|
+
*/
|
|
84327
|
+
untrack(): Word.Annotation;
|
|
84328
|
+
/**
|
|
84329
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
84330
|
+
* Whereas the original Word.Annotation object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
84331
|
+
*/
|
|
84332
|
+
toJSON(): Word.Interfaces.AnnotationData;
|
|
84333
|
+
}
|
|
84334
|
+
/**
|
|
84335
|
+
* Holds annotation information that is passed back on annotation added event.
|
|
84336
|
+
*
|
|
84337
|
+
* @remarks
|
|
84338
|
+
* [Api set: WordApi 1.7]
|
|
84339
|
+
*/
|
|
84340
|
+
interface AnnotationInsertedEventArgs {
|
|
84341
|
+
/**
|
|
84342
|
+
* Specifies the annotation IDs for which the event was fired.
|
|
84343
|
+
*
|
|
84344
|
+
* @remarks
|
|
84345
|
+
* [Api set: WordApi 1.7]
|
|
84346
|
+
*/
|
|
84347
|
+
ids: string[];
|
|
84348
|
+
}
|
|
84349
|
+
/**
|
|
84350
|
+
* Holds annotation information that is passed back on annotation inserted event.
|
|
84351
|
+
*
|
|
84352
|
+
* @remarks
|
|
84353
|
+
* [Api set: WordApi 1.7]
|
|
84354
|
+
*/
|
|
84355
|
+
interface AnnotationClickedEventArgs {
|
|
84356
|
+
/**
|
|
84357
|
+
* Specifies the annotation ID for which the event was fired.
|
|
84358
|
+
*
|
|
84359
|
+
* @remarks
|
|
84360
|
+
* [Api set: WordApi 1.7]
|
|
84361
|
+
*/
|
|
84362
|
+
id: string;
|
|
84363
|
+
}
|
|
84364
|
+
/**
|
|
84365
|
+
* Holds annotation information that is passed back on annotation removed event.
|
|
84366
|
+
*
|
|
84367
|
+
* @remarks
|
|
84368
|
+
* [Api set: WordApi 1.7]
|
|
84369
|
+
*/
|
|
84370
|
+
interface AnnotationRemovedEventArgs {
|
|
84371
|
+
/**
|
|
84372
|
+
* Specifies the annotation IDs for which the event was fired.
|
|
84373
|
+
*
|
|
84374
|
+
* @remarks
|
|
84375
|
+
* [Api set: WordApi 1.7]
|
|
84376
|
+
*/
|
|
84377
|
+
ids: string[];
|
|
84378
|
+
}
|
|
84379
|
+
/**
|
|
84380
|
+
* Holds annotation information that is passed back on annotation hovered event.
|
|
84381
|
+
*
|
|
84382
|
+
* @remarks
|
|
84383
|
+
* [Api set: WordApi 1.7]
|
|
84384
|
+
*/
|
|
84385
|
+
interface AnnotationHoveredEventArgs {
|
|
84386
|
+
/**
|
|
84387
|
+
* Specifies the annotation ID for which the event was fired.
|
|
84388
|
+
*
|
|
84389
|
+
* @remarks
|
|
84390
|
+
* [Api set: WordApi 1.7]
|
|
84391
|
+
*/
|
|
84392
|
+
id: string;
|
|
84393
|
+
}
|
|
84394
|
+
/**
|
|
84395
|
+
* Contains a collection of {@link Word.Annotation} objects.
|
|
84396
|
+
*
|
|
84397
|
+
* @remarks
|
|
84398
|
+
* [Api set: WordApi 1.7]
|
|
84399
|
+
*/
|
|
84400
|
+
class AnnotationCollection extends OfficeExtension.ClientObject {
|
|
84401
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
84402
|
+
context: RequestContext;
|
|
84403
|
+
/** Gets the loaded child items in this collection. */
|
|
84404
|
+
readonly items: Word.Annotation[];
|
|
84405
|
+
/**
|
|
84406
|
+
* Gets the first annotation in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
84407
|
+
*
|
|
84408
|
+
* @remarks
|
|
84409
|
+
* [Api set: WordApi 1.7]
|
|
84410
|
+
*/
|
|
84411
|
+
getFirst(): Word.Annotation;
|
|
84412
|
+
/**
|
|
84413
|
+
* Gets the first annotation in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`.
|
|
84414
|
+
For further information,
|
|
84415
|
+
see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
84416
|
+
*
|
|
84417
|
+
* @remarks
|
|
84418
|
+
* [Api set: WordApi 1.7]
|
|
84419
|
+
*/
|
|
84420
|
+
getFirstOrNullObject(): Word.Annotation;
|
|
84421
|
+
/**
|
|
84422
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84423
|
+
*
|
|
84424
|
+
* @param options Provides options for which properties of the object to load.
|
|
84425
|
+
*/
|
|
84426
|
+
load(options?: Word.Interfaces.AnnotationCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.AnnotationCollection;
|
|
84427
|
+
/**
|
|
84428
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84429
|
+
*
|
|
84430
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
84431
|
+
*/
|
|
84432
|
+
load(propertyNames?: string | string[]): Word.AnnotationCollection;
|
|
84433
|
+
/**
|
|
84434
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84435
|
+
*
|
|
84436
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
84437
|
+
*/
|
|
84438
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.AnnotationCollection;
|
|
84439
|
+
/**
|
|
84440
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84441
|
+
*/
|
|
84442
|
+
track(): Word.AnnotationCollection;
|
|
84443
|
+
/**
|
|
84444
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84445
|
+
*/
|
|
84446
|
+
untrack(): Word.AnnotationCollection;
|
|
84447
|
+
/**
|
|
84448
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
84449
|
+
* Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
84450
|
+
*/
|
|
84451
|
+
toJSON(): Word.Interfaces.AnnotationCollectionData;
|
|
84452
|
+
}
|
|
84082
84453
|
/**
|
|
84083
84454
|
* Represents the application object.
|
|
84084
84455
|
*
|
|
@@ -84377,11 +84748,11 @@ declare namespace Word {
|
|
|
84377
84748
|
* @remarks
|
|
84378
84749
|
* [Api set: WordApi 1.1]
|
|
84379
84750
|
*
|
|
84380
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5.
|
|
84751
|
+
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
|
|
84381
84752
|
*
|
|
84382
|
-
* @param contentControlType Optional. Content control type to insert. Must be 'RichText' or '
|
|
84753
|
+
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
84383
84754
|
*/
|
|
84384
|
-
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
|
|
84755
|
+
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
|
|
84385
84756
|
/**
|
|
84386
84757
|
* Inserts a document into the body at the specified location.
|
|
84387
84758
|
*
|
|
@@ -84518,7 +84889,7 @@ declare namespace Word {
|
|
|
84518
84889
|
*/
|
|
84519
84890
|
track(): Word.Body;
|
|
84520
84891
|
/**
|
|
84521
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
84892
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84522
84893
|
*/
|
|
84523
84894
|
untrack(): Word.Body;
|
|
84524
84895
|
/**
|
|
@@ -84527,6 +84898,65 @@ declare namespace Word {
|
|
|
84527
84898
|
*/
|
|
84528
84899
|
toJSON(): Word.Interfaces.BodyData;
|
|
84529
84900
|
}
|
|
84901
|
+
/**
|
|
84902
|
+
* The data specific to content controls of type CheckBox.
|
|
84903
|
+
*
|
|
84904
|
+
* @remarks
|
|
84905
|
+
* [Api set: WordApi 1.7]
|
|
84906
|
+
*/
|
|
84907
|
+
class CheckboxContentControl extends OfficeExtension.ClientObject {
|
|
84908
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
84909
|
+
context: RequestContext;
|
|
84910
|
+
/**
|
|
84911
|
+
* Specifies the current state of the checkbox.
|
|
84912
|
+
*
|
|
84913
|
+
* @remarks
|
|
84914
|
+
* [Api set: WordApi 1.7]
|
|
84915
|
+
*/
|
|
84916
|
+
isChecked: boolean;
|
|
84917
|
+
/**
|
|
84918
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
84919
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
84920
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
84921
|
+
*/
|
|
84922
|
+
set(properties: Interfaces.CheckboxContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
84923
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
84924
|
+
set(properties: Word.CheckboxContentControl): void;
|
|
84925
|
+
/**
|
|
84926
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84927
|
+
*
|
|
84928
|
+
* @param options Provides options for which properties of the object to load.
|
|
84929
|
+
*/
|
|
84930
|
+
load(options?: Word.Interfaces.CheckboxContentControlLoadOptions): Word.CheckboxContentControl;
|
|
84931
|
+
/**
|
|
84932
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84933
|
+
*
|
|
84934
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
84935
|
+
*/
|
|
84936
|
+
load(propertyNames?: string | string[]): Word.CheckboxContentControl;
|
|
84937
|
+
/**
|
|
84938
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
84939
|
+
*
|
|
84940
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
84941
|
+
*/
|
|
84942
|
+
load(propertyNamesAndPaths?: {
|
|
84943
|
+
select?: string;
|
|
84944
|
+
expand?: string;
|
|
84945
|
+
}): Word.CheckboxContentControl;
|
|
84946
|
+
/**
|
|
84947
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84948
|
+
*/
|
|
84949
|
+
track(): Word.CheckboxContentControl;
|
|
84950
|
+
/**
|
|
84951
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84952
|
+
*/
|
|
84953
|
+
untrack(): Word.CheckboxContentControl;
|
|
84954
|
+
/**
|
|
84955
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
84956
|
+
* Whereas the original Word.CheckboxContentControl object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
|
|
84957
|
+
*/
|
|
84958
|
+
toJSON(): Word.Interfaces.CheckboxContentControlData;
|
|
84959
|
+
}
|
|
84530
84960
|
/**
|
|
84531
84961
|
* Represents a comment in the document.
|
|
84532
84962
|
*
|
|
@@ -84649,7 +85079,7 @@ declare namespace Word {
|
|
|
84649
85079
|
*/
|
|
84650
85080
|
track(): Word.Comment;
|
|
84651
85081
|
/**
|
|
84652
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85082
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84653
85083
|
*/
|
|
84654
85084
|
untrack(): Word.Comment;
|
|
84655
85085
|
/**
|
|
@@ -84706,7 +85136,7 @@ declare namespace Word {
|
|
|
84706
85136
|
*/
|
|
84707
85137
|
track(): Word.CommentCollection;
|
|
84708
85138
|
/**
|
|
84709
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85139
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84710
85140
|
*/
|
|
84711
85141
|
untrack(): Word.CommentCollection;
|
|
84712
85142
|
/**
|
|
@@ -84815,7 +85245,7 @@ declare namespace Word {
|
|
|
84815
85245
|
*/
|
|
84816
85246
|
track(): Word.CommentContentRange;
|
|
84817
85247
|
/**
|
|
84818
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85248
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84819
85249
|
*/
|
|
84820
85250
|
untrack(): Word.CommentContentRange;
|
|
84821
85251
|
/**
|
|
@@ -84923,7 +85353,7 @@ declare namespace Word {
|
|
|
84923
85353
|
*/
|
|
84924
85354
|
track(): Word.CommentReply;
|
|
84925
85355
|
/**
|
|
84926
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85356
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84927
85357
|
*/
|
|
84928
85358
|
untrack(): Word.CommentReply;
|
|
84929
85359
|
/**
|
|
@@ -84980,7 +85410,7 @@ declare namespace Word {
|
|
|
84980
85410
|
*/
|
|
84981
85411
|
track(): Word.CommentReplyCollection;
|
|
84982
85412
|
/**
|
|
84983
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85413
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
84984
85414
|
*/
|
|
84985
85415
|
untrack(): Word.CommentReplyCollection;
|
|
84986
85416
|
/**
|
|
@@ -84990,7 +85420,7 @@ declare namespace Word {
|
|
|
84990
85420
|
toJSON(): Word.Interfaces.CommentReplyCollectionData;
|
|
84991
85421
|
}
|
|
84992
85422
|
/**
|
|
84993
|
-
* Represents a content control. 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
|
|
85423
|
+
* Represents a content control. 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, plain text, and checkbox content controls are supported.
|
|
84994
85424
|
*
|
|
84995
85425
|
* @remarks
|
|
84996
85426
|
* [Api set: WordApi 1.1]
|
|
@@ -84998,6 +85428,13 @@ declare namespace Word {
|
|
|
84998
85428
|
class ContentControl extends OfficeExtension.ClientObject {
|
|
84999
85429
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
85000
85430
|
context: RequestContext;
|
|
85431
|
+
/**
|
|
85432
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
85433
|
+
*
|
|
85434
|
+
* @remarks
|
|
85435
|
+
* [Api set: WordApi 1.7]
|
|
85436
|
+
*/
|
|
85437
|
+
readonly checkboxContentControl: Word.CheckboxContentControl;
|
|
85001
85438
|
/**
|
|
85002
85439
|
* Gets the collection of content control objects in the content control.
|
|
85003
85440
|
*
|
|
@@ -85178,7 +85615,7 @@ declare namespace Word {
|
|
|
85178
85615
|
*/
|
|
85179
85616
|
styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
85180
85617
|
/**
|
|
85181
|
-
* 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.
|
|
85618
|
+
* 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.
|
|
85182
85619
|
*
|
|
85183
85620
|
* @remarks
|
|
85184
85621
|
* [Api set: WordApi 1.3]
|
|
@@ -85206,7 +85643,7 @@ declare namespace Word {
|
|
|
85206
85643
|
*/
|
|
85207
85644
|
title: string;
|
|
85208
85645
|
/**
|
|
85209
|
-
* Gets the content control type. Only rich text
|
|
85646
|
+
* Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.
|
|
85210
85647
|
*
|
|
85211
85648
|
* @remarks
|
|
85212
85649
|
* [Api set: WordApi 1.1]
|
|
@@ -85517,7 +85954,7 @@ declare namespace Word {
|
|
|
85517
85954
|
*/
|
|
85518
85955
|
track(): Word.ContentControl;
|
|
85519
85956
|
/**
|
|
85520
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
85957
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
85521
85958
|
*/
|
|
85522
85959
|
untrack(): Word.ContentControl;
|
|
85523
85960
|
/**
|
|
@@ -85637,7 +86074,7 @@ declare namespace Word {
|
|
|
85637
86074
|
*/
|
|
85638
86075
|
track(): Word.ContentControlCollection;
|
|
85639
86076
|
/**
|
|
85640
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86077
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
85641
86078
|
*/
|
|
85642
86079
|
untrack(): Word.ContentControlCollection;
|
|
85643
86080
|
/**
|
|
@@ -85654,12 +86091,12 @@ declare namespace Word {
|
|
|
85654
86091
|
*/
|
|
85655
86092
|
interface ContentControlOptions {
|
|
85656
86093
|
/**
|
|
85657
|
-
* An array of content control types, item must be 'RichText' or '
|
|
86094
|
+
* An array of content control types, item must be 'RichText', 'PlainText', or 'CheckBox'.
|
|
85658
86095
|
*
|
|
85659
86096
|
* @remarks
|
|
85660
86097
|
* [Api set: WordApi 1.5]
|
|
85661
86098
|
*
|
|
85662
|
-
* Note: `PlainText` support was added in WordApi 1.5.
|
|
86099
|
+
* Note: `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
|
|
85663
86100
|
*/
|
|
85664
86101
|
types: Word.ContentControlType[];
|
|
85665
86102
|
}
|
|
@@ -85734,7 +86171,7 @@ declare namespace Word {
|
|
|
85734
86171
|
*/
|
|
85735
86172
|
track(): Word.CustomProperty;
|
|
85736
86173
|
/**
|
|
85737
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86174
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
85738
86175
|
*/
|
|
85739
86176
|
untrack(): Word.CustomProperty;
|
|
85740
86177
|
/**
|
|
@@ -85819,7 +86256,7 @@ declare namespace Word {
|
|
|
85819
86256
|
*/
|
|
85820
86257
|
track(): Word.CustomPropertyCollection;
|
|
85821
86258
|
/**
|
|
85822
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86259
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
85823
86260
|
*/
|
|
85824
86261
|
untrack(): Word.CustomPropertyCollection;
|
|
85825
86262
|
/**
|
|
@@ -86098,7 +86535,7 @@ declare namespace Word {
|
|
|
86098
86535
|
*/
|
|
86099
86536
|
track(): Word.CustomXmlPart;
|
|
86100
86537
|
/**
|
|
86101
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86538
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86102
86539
|
*/
|
|
86103
86540
|
untrack(): Word.CustomXmlPart;
|
|
86104
86541
|
/**
|
|
@@ -86184,7 +86621,7 @@ declare namespace Word {
|
|
|
86184
86621
|
*/
|
|
86185
86622
|
track(): Word.CustomXmlPartCollection;
|
|
86186
86623
|
/**
|
|
86187
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86624
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86188
86625
|
*/
|
|
86189
86626
|
untrack(): Word.CustomXmlPartCollection;
|
|
86190
86627
|
/**
|
|
@@ -86266,7 +86703,7 @@ declare namespace Word {
|
|
|
86266
86703
|
*/
|
|
86267
86704
|
track(): Word.CustomXmlPartScopedCollection;
|
|
86268
86705
|
/**
|
|
86269
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
86706
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86270
86707
|
*/
|
|
86271
86708
|
untrack(): Word.CustomXmlPartScopedCollection;
|
|
86272
86709
|
/**
|
|
@@ -86395,6 +86832,15 @@ declare namespace Word {
|
|
|
86395
86832
|
* @param name Required. The case-insensitive bookmark name.
|
|
86396
86833
|
*/
|
|
86397
86834
|
deleteBookmark(name: string): void;
|
|
86835
|
+
/**
|
|
86836
|
+
* Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found.
|
|
86837
|
+
*
|
|
86838
|
+
* @remarks
|
|
86839
|
+
* [Api set: WordApi 1.7]
|
|
86840
|
+
*
|
|
86841
|
+
* @param id The ID of the annotation to get.
|
|
86842
|
+
*/
|
|
86843
|
+
getAnnotationById(id: string): Word.Annotation;
|
|
86398
86844
|
/**
|
|
86399
86845
|
* Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
|
|
86400
86846
|
*
|
|
@@ -86428,7 +86874,6 @@ declare namespace Word {
|
|
|
86428
86874
|
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
|
|
86429
86875
|
/**
|
|
86430
86876
|
* Gets the document's endnotes in a single body.
|
|
86431
|
-
Not implemented in Word on the web.
|
|
86432
86877
|
*
|
|
86433
86878
|
* @remarks
|
|
86434
86879
|
* [Api set: WordApi 1.5]
|
|
@@ -86436,7 +86881,6 @@ declare namespace Word {
|
|
|
86436
86881
|
getEndnoteBody(): Word.Body;
|
|
86437
86882
|
/**
|
|
86438
86883
|
* Gets the document's footnotes in a single body.
|
|
86439
|
-
Not implemented in Word on the web.
|
|
86440
86884
|
*
|
|
86441
86885
|
* @remarks
|
|
86442
86886
|
* [Api set: WordApi 1.5]
|
|
@@ -86516,7 +86960,7 @@ declare namespace Word {
|
|
|
86516
86960
|
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
86517
86961
|
*
|
|
86518
86962
|
* @remarks
|
|
86519
|
-
* [Api set:
|
|
86963
|
+
* [Api set: WordApi 1.7]
|
|
86520
86964
|
*/
|
|
86521
86965
|
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
86522
86966
|
ignorePunct?: boolean;
|
|
@@ -86548,6 +86992,42 @@ declare namespace Word {
|
|
|
86548
86992
|
select?: string;
|
|
86549
86993
|
expand?: string;
|
|
86550
86994
|
}): Word.Document;
|
|
86995
|
+
/**
|
|
86996
|
+
* Occurs when the user clicks an annotation (or selects it using **Alt+Down**).
|
|
86997
|
+
*
|
|
86998
|
+
* @remarks
|
|
86999
|
+
* [Api set: WordApi 1.7]
|
|
87000
|
+
*
|
|
87001
|
+
* @eventproperty
|
|
87002
|
+
*/
|
|
87003
|
+
readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;
|
|
87004
|
+
/**
|
|
87005
|
+
* Occurs when the user hovers the cursor over an annotation.
|
|
87006
|
+
*
|
|
87007
|
+
* @remarks
|
|
87008
|
+
* [Api set: WordApi 1.7]
|
|
87009
|
+
*
|
|
87010
|
+
* @eventproperty
|
|
87011
|
+
*/
|
|
87012
|
+
readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;
|
|
87013
|
+
/**
|
|
87014
|
+
* Occurs when the user adds one or more annotations.
|
|
87015
|
+
*
|
|
87016
|
+
* @remarks
|
|
87017
|
+
* [Api set: WordApi 1.7]
|
|
87018
|
+
*
|
|
87019
|
+
* @eventproperty
|
|
87020
|
+
*/
|
|
87021
|
+
readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;
|
|
87022
|
+
/**
|
|
87023
|
+
* Occurs when the user deletes one or more annotations.
|
|
87024
|
+
*
|
|
87025
|
+
* @remarks
|
|
87026
|
+
* [Api set: WordApi 1.7]
|
|
87027
|
+
*
|
|
87028
|
+
* @eventproperty
|
|
87029
|
+
*/
|
|
87030
|
+
readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;
|
|
86551
87031
|
/**
|
|
86552
87032
|
* Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties.
|
|
86553
87033
|
*
|
|
@@ -86589,7 +87069,7 @@ declare namespace Word {
|
|
|
86589
87069
|
*/
|
|
86590
87070
|
track(): Word.Document;
|
|
86591
87071
|
/**
|
|
86592
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87072
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86593
87073
|
*/
|
|
86594
87074
|
untrack(): Word.Document;
|
|
86595
87075
|
/**
|
|
@@ -86802,7 +87282,7 @@ declare namespace Word {
|
|
|
86802
87282
|
*/
|
|
86803
87283
|
track(): Word.DocumentCreated;
|
|
86804
87284
|
/**
|
|
86805
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87285
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86806
87286
|
*/
|
|
86807
87287
|
untrack(): Word.DocumentCreated;
|
|
86808
87288
|
/**
|
|
@@ -86980,7 +87460,7 @@ declare namespace Word {
|
|
|
86980
87460
|
*/
|
|
86981
87461
|
track(): Word.DocumentProperties;
|
|
86982
87462
|
/**
|
|
86983
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87463
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
86984
87464
|
*/
|
|
86985
87465
|
untrack(): Word.DocumentProperties;
|
|
86986
87466
|
/**
|
|
@@ -87173,7 +87653,7 @@ declare namespace Word {
|
|
|
87173
87653
|
*/
|
|
87174
87654
|
track(): Word.Field;
|
|
87175
87655
|
/**
|
|
87176
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87656
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87177
87657
|
*/
|
|
87178
87658
|
untrack(): Word.Field;
|
|
87179
87659
|
/**
|
|
@@ -87241,7 +87721,7 @@ declare namespace Word {
|
|
|
87241
87721
|
*/
|
|
87242
87722
|
track(): Word.FieldCollection;
|
|
87243
87723
|
/**
|
|
87244
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87724
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87245
87725
|
*/
|
|
87246
87726
|
untrack(): Word.FieldCollection;
|
|
87247
87727
|
/**
|
|
@@ -87370,7 +87850,7 @@ declare namespace Word {
|
|
|
87370
87850
|
*/
|
|
87371
87851
|
track(): Word.Font;
|
|
87372
87852
|
/**
|
|
87373
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
87853
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87374
87854
|
*/
|
|
87375
87855
|
untrack(): Word.Font;
|
|
87376
87856
|
/**
|
|
@@ -87647,7 +88127,7 @@ declare namespace Word {
|
|
|
87647
88127
|
*/
|
|
87648
88128
|
track(): Word.InlinePicture;
|
|
87649
88129
|
/**
|
|
87650
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88130
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87651
88131
|
*/
|
|
87652
88132
|
untrack(): Word.InlinePicture;
|
|
87653
88133
|
/**
|
|
@@ -87704,7 +88184,7 @@ declare namespace Word {
|
|
|
87704
88184
|
*/
|
|
87705
88185
|
track(): Word.InlinePictureCollection;
|
|
87706
88186
|
/**
|
|
87707
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88187
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87708
88188
|
*/
|
|
87709
88189
|
untrack(): Word.InlinePictureCollection;
|
|
87710
88190
|
/**
|
|
@@ -87891,7 +88371,7 @@ declare namespace Word {
|
|
|
87891
88371
|
*/
|
|
87892
88372
|
track(): Word.List;
|
|
87893
88373
|
/**
|
|
87894
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88374
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87895
88375
|
*/
|
|
87896
88376
|
untrack(): Word.List;
|
|
87897
88377
|
/**
|
|
@@ -87975,7 +88455,7 @@ declare namespace Word {
|
|
|
87975
88455
|
*/
|
|
87976
88456
|
track(): Word.ListCollection;
|
|
87977
88457
|
/**
|
|
87978
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88458
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
87979
88459
|
*/
|
|
87980
88460
|
untrack(): Word.ListCollection;
|
|
87981
88461
|
/**
|
|
@@ -88075,7 +88555,7 @@ declare namespace Word {
|
|
|
88075
88555
|
*/
|
|
88076
88556
|
track(): Word.ListItem;
|
|
88077
88557
|
/**
|
|
88078
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88558
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
88079
88559
|
*/
|
|
88080
88560
|
untrack(): Word.ListItem;
|
|
88081
88561
|
/**
|
|
@@ -88169,7 +88649,7 @@ declare namespace Word {
|
|
|
88169
88649
|
*/
|
|
88170
88650
|
track(): Word.NoteItem;
|
|
88171
88651
|
/**
|
|
88172
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88652
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
88173
88653
|
*/
|
|
88174
88654
|
untrack(): Word.NoteItem;
|
|
88175
88655
|
/**
|
|
@@ -88226,7 +88706,7 @@ declare namespace Word {
|
|
|
88226
88706
|
*/
|
|
88227
88707
|
track(): Word.NoteItemCollection;
|
|
88228
88708
|
/**
|
|
88229
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
88709
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
88230
88710
|
*/
|
|
88231
88711
|
untrack(): Word.NoteItemCollection;
|
|
88232
88712
|
/**
|
|
@@ -88521,6 +89001,13 @@ declare namespace Word {
|
|
|
88521
89001
|
* [Api set: WordApi 1.3]
|
|
88522
89002
|
*/
|
|
88523
89003
|
detachFromList(): void;
|
|
89004
|
+
/**
|
|
89005
|
+
* Gets annotations set on this Paragraph object.
|
|
89006
|
+
*
|
|
89007
|
+
* @remarks
|
|
89008
|
+
* [Api set: WordApi 1.7]
|
|
89009
|
+
*/
|
|
89010
|
+
getAnnotations(): Word.AnnotationCollection;
|
|
88524
89011
|
/**
|
|
88525
89012
|
* Gets comments associated with the paragraph.
|
|
88526
89013
|
*
|
|
@@ -88602,14 +89089,27 @@ declare namespace Word {
|
|
|
88602
89089
|
*/
|
|
88603
89090
|
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
|
|
88604
89091
|
/**
|
|
88605
|
-
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
89092
|
+
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
89093
|
+
*
|
|
89094
|
+
* @remarks
|
|
89095
|
+
* [Api set: WordApi 1.4]
|
|
89096
|
+
*
|
|
89097
|
+
* @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
|
|
89098
|
+
*/
|
|
89099
|
+
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
|
|
89100
|
+
/**
|
|
89101
|
+
* Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes).
|
|
89102
|
+
By default, hidden text and text marked as deleted are excluded.
|
|
88606
89103
|
*
|
|
88607
89104
|
* @remarks
|
|
88608
|
-
* [Api set: WordApi 1.
|
|
89105
|
+
* [Api set: WordApi 1.7]
|
|
88609
89106
|
*
|
|
88610
|
-
* @param
|
|
89107
|
+
* @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted.
|
|
88611
89108
|
*/
|
|
88612
|
-
|
|
89109
|
+
getText(options?: Word.GetTextOptions | {
|
|
89110
|
+
IncludeHiddenText?: boolean;
|
|
89111
|
+
IncludeTextMarkedAsDeleted?: boolean;
|
|
89112
|
+
}): OfficeExtension.ClientResult<string>;
|
|
88613
89113
|
/**
|
|
88614
89114
|
* Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
|
|
88615
89115
|
*
|
|
@@ -88627,6 +89127,16 @@ declare namespace Word {
|
|
|
88627
89127
|
* [Api set: WordApi 1.6]
|
|
88628
89128
|
*/
|
|
88629
89129
|
getTrackedChanges(): Word.TrackedChangeCollection;
|
|
89130
|
+
/**
|
|
89131
|
+
* Inserts annotations on this Paragraph object.
|
|
89132
|
+
*
|
|
89133
|
+
* @remarks
|
|
89134
|
+
* [Api set: WordApi 1.7]
|
|
89135
|
+
*
|
|
89136
|
+
* @param annotations Annotations to set.
|
|
89137
|
+
* @returns An array of the inserted annotations identifiers.
|
|
89138
|
+
*/
|
|
89139
|
+
insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;
|
|
88630
89140
|
/**
|
|
88631
89141
|
* Inserts a break at the specified location in the main document.
|
|
88632
89142
|
*
|
|
@@ -88643,11 +89153,11 @@ declare namespace Word {
|
|
|
88643
89153
|
* @remarks
|
|
88644
89154
|
* [Api set: WordApi 1.1]
|
|
88645
89155
|
*
|
|
88646
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5.
|
|
89156
|
+
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
|
|
88647
89157
|
*
|
|
88648
|
-
* @param contentControlType Optional. Content control type to insert. Must be 'RichText' or '
|
|
89158
|
+
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
88649
89159
|
*/
|
|
88650
|
-
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
|
|
89160
|
+
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
|
|
88651
89161
|
/**
|
|
88652
89162
|
* Inserts a document into the paragraph at the specified location.
|
|
88653
89163
|
*
|
|
@@ -88802,7 +89312,7 @@ declare namespace Word {
|
|
|
88802
89312
|
*/
|
|
88803
89313
|
track(): Word.Paragraph;
|
|
88804
89314
|
/**
|
|
88805
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
89315
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
88806
89316
|
*/
|
|
88807
89317
|
untrack(): Word.Paragraph;
|
|
88808
89318
|
/**
|
|
@@ -88873,7 +89383,7 @@ declare namespace Word {
|
|
|
88873
89383
|
*/
|
|
88874
89384
|
track(): Word.ParagraphCollection;
|
|
88875
89385
|
/**
|
|
88876
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
89386
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
88877
89387
|
*/
|
|
88878
89388
|
untrack(): Word.ParagraphCollection;
|
|
88879
89389
|
/**
|
|
@@ -89023,7 +89533,7 @@ declare namespace Word {
|
|
|
89023
89533
|
*/
|
|
89024
89534
|
track(): Word.ParagraphFormat;
|
|
89025
89535
|
/**
|
|
89026
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
89536
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
89027
89537
|
*/
|
|
89028
89538
|
untrack(): Word.ParagraphFormat;
|
|
89029
89539
|
/**
|
|
@@ -89107,14 +89617,14 @@ declare namespace Word {
|
|
|
89107
89617
|
*/
|
|
89108
89618
|
readonly parentBody: Word.Body;
|
|
89109
89619
|
/**
|
|
89110
|
-
* Gets the content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
89620
|
+
* Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
89111
89621
|
*
|
|
89112
89622
|
* @remarks
|
|
89113
89623
|
* [Api set: WordApi 1.1]
|
|
89114
89624
|
*/
|
|
89115
89625
|
readonly parentContentControl: Word.ContentControl;
|
|
89116
89626
|
/**
|
|
89117
|
-
* Gets the content control that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89627
|
+
* Gets the currently supported content control that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89118
89628
|
*
|
|
89119
89629
|
* @remarks
|
|
89120
89630
|
* [Api set: WordApi 1.3]
|
|
@@ -89392,11 +89902,11 @@ declare namespace Word {
|
|
|
89392
89902
|
* @remarks
|
|
89393
89903
|
* [Api set: WordApi 1.1]
|
|
89394
89904
|
*
|
|
89395
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5.
|
|
89905
|
+
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
|
|
89396
89906
|
*
|
|
89397
|
-
* @param contentControlType Optional. Content control type to insert. Must be 'RichText' or '
|
|
89907
|
+
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
89398
89908
|
*/
|
|
89399
|
-
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | "RichText" | "PlainText"): Word.ContentControl;
|
|
89909
|
+
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
|
|
89400
89910
|
/**
|
|
89401
89911
|
* Inserts an endnote. The endnote reference is placed after the range.
|
|
89402
89912
|
*
|
|
@@ -89633,7 +90143,7 @@ declare namespace Word {
|
|
|
89633
90143
|
*/
|
|
89634
90144
|
track(): Word.Range;
|
|
89635
90145
|
/**
|
|
89636
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90146
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
89637
90147
|
*/
|
|
89638
90148
|
untrack(): Word.Range;
|
|
89639
90149
|
/**
|
|
@@ -89690,7 +90200,7 @@ declare namespace Word {
|
|
|
89690
90200
|
*/
|
|
89691
90201
|
track(): Word.RangeCollection;
|
|
89692
90202
|
/**
|
|
89693
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90203
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
89694
90204
|
*/
|
|
89695
90205
|
untrack(): Word.RangeCollection;
|
|
89696
90206
|
/**
|
|
@@ -89727,6 +90237,13 @@ declare namespace Word {
|
|
|
89727
90237
|
* [Api set: WordApi 1.6]
|
|
89728
90238
|
*/
|
|
89729
90239
|
importCustomXmlParts?: boolean;
|
|
90240
|
+
/**
|
|
90241
|
+
* Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.
|
|
90242
|
+
*
|
|
90243
|
+
* @remarks
|
|
90244
|
+
* [Api set: WordApi 1.7]
|
|
90245
|
+
*/
|
|
90246
|
+
importDifferentOddEvenPages?: boolean;
|
|
89730
90247
|
/**
|
|
89731
90248
|
* Represents whether the page color and other background information from the source document should be imported.
|
|
89732
90249
|
*
|
|
@@ -89854,6 +90371,28 @@ declare namespace Word {
|
|
|
89854
90371
|
*/
|
|
89855
90372
|
toJSON(): Word.Interfaces.SearchOptionsData;
|
|
89856
90373
|
}
|
|
90374
|
+
/**
|
|
90375
|
+
* Specifies the options to be included in a getText operation.
|
|
90376
|
+
*
|
|
90377
|
+
* @remarks
|
|
90378
|
+
* [Api set: WordApi 1.7]
|
|
90379
|
+
*/
|
|
90380
|
+
interface GetTextOptions {
|
|
90381
|
+
/**
|
|
90382
|
+
* Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False.
|
|
90383
|
+
*
|
|
90384
|
+
* @remarks
|
|
90385
|
+
* [Api set: WordApi 1.7]
|
|
90386
|
+
*/
|
|
90387
|
+
includeHiddenText?: boolean;
|
|
90388
|
+
/**
|
|
90389
|
+
* Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False.
|
|
90390
|
+
*
|
|
90391
|
+
* @remarks
|
|
90392
|
+
* [Api set: WordApi 1.7]
|
|
90393
|
+
*/
|
|
90394
|
+
includeTextMarkedAsDeleted?: boolean;
|
|
90395
|
+
}
|
|
89857
90396
|
/**
|
|
89858
90397
|
* Represents a section in a Word document.
|
|
89859
90398
|
*
|
|
@@ -89954,7 +90493,7 @@ declare namespace Word {
|
|
|
89954
90493
|
*/
|
|
89955
90494
|
track(): Word.Section;
|
|
89956
90495
|
/**
|
|
89957
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90496
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
89958
90497
|
*/
|
|
89959
90498
|
untrack(): Word.Section;
|
|
89960
90499
|
/**
|
|
@@ -90011,7 +90550,7 @@ declare namespace Word {
|
|
|
90011
90550
|
*/
|
|
90012
90551
|
track(): Word.SectionCollection;
|
|
90013
90552
|
/**
|
|
90014
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90553
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90015
90554
|
*/
|
|
90016
90555
|
untrack(): Word.SectionCollection;
|
|
90017
90556
|
/**
|
|
@@ -90084,7 +90623,7 @@ declare namespace Word {
|
|
|
90084
90623
|
*/
|
|
90085
90624
|
track(): Word.Setting;
|
|
90086
90625
|
/**
|
|
90087
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90626
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90088
90627
|
*/
|
|
90089
90628
|
untrack(): Word.Setting;
|
|
90090
90629
|
/**
|
|
@@ -90169,7 +90708,7 @@ declare namespace Word {
|
|
|
90169
90708
|
*/
|
|
90170
90709
|
track(): Word.SettingCollection;
|
|
90171
90710
|
/**
|
|
90172
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90711
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90173
90712
|
*/
|
|
90174
90713
|
untrack(): Word.SettingCollection;
|
|
90175
90714
|
/**
|
|
@@ -90246,7 +90785,7 @@ declare namespace Word {
|
|
|
90246
90785
|
*/
|
|
90247
90786
|
track(): Word.StyleCollection;
|
|
90248
90787
|
/**
|
|
90249
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90788
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90250
90789
|
*/
|
|
90251
90790
|
untrack(): Word.StyleCollection;
|
|
90252
90791
|
/**
|
|
@@ -90414,7 +90953,7 @@ declare namespace Word {
|
|
|
90414
90953
|
*/
|
|
90415
90954
|
track(): Word.Style;
|
|
90416
90955
|
/**
|
|
90417
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
90956
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90418
90957
|
*/
|
|
90419
90958
|
untrack(): Word.Style;
|
|
90420
90959
|
/**
|
|
@@ -90473,7 +91012,7 @@ declare namespace Word {
|
|
|
90473
91012
|
*/
|
|
90474
91013
|
track(): Word.Shading;
|
|
90475
91014
|
/**
|
|
90476
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
91015
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
90477
91016
|
*/
|
|
90478
91017
|
untrack(): Word.Shading;
|
|
90479
91018
|
/**
|
|
@@ -91009,7 +91548,7 @@ declare namespace Word {
|
|
|
91009
91548
|
*/
|
|
91010
91549
|
track(): Word.Table;
|
|
91011
91550
|
/**
|
|
91012
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
91551
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91013
91552
|
*/
|
|
91014
91553
|
untrack(): Word.Table;
|
|
91015
91554
|
/**
|
|
@@ -91096,7 +91635,7 @@ declare namespace Word {
|
|
|
91096
91635
|
*/
|
|
91097
91636
|
track(): Word.TableStyle;
|
|
91098
91637
|
/**
|
|
91099
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
91638
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91100
91639
|
*/
|
|
91101
91640
|
untrack(): Word.TableStyle;
|
|
91102
91641
|
/**
|
|
@@ -91153,7 +91692,7 @@ declare namespace Word {
|
|
|
91153
91692
|
*/
|
|
91154
91693
|
track(): Word.TableCollection;
|
|
91155
91694
|
/**
|
|
91156
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
91695
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91157
91696
|
*/
|
|
91158
91697
|
untrack(): Word.TableCollection;
|
|
91159
91698
|
/**
|
|
@@ -91441,7 +91980,7 @@ declare namespace Word {
|
|
|
91441
91980
|
*/
|
|
91442
91981
|
track(): Word.TableRow;
|
|
91443
91982
|
/**
|
|
91444
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
91983
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91445
91984
|
*/
|
|
91446
91985
|
untrack(): Word.TableRow;
|
|
91447
91986
|
/**
|
|
@@ -91498,7 +92037,7 @@ declare namespace Word {
|
|
|
91498
92037
|
*/
|
|
91499
92038
|
track(): Word.TableRowCollection;
|
|
91500
92039
|
/**
|
|
91501
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92040
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91502
92041
|
*/
|
|
91503
92042
|
untrack(): Word.TableRowCollection;
|
|
91504
92043
|
/**
|
|
@@ -91743,7 +92282,7 @@ declare namespace Word {
|
|
|
91743
92282
|
*/
|
|
91744
92283
|
track(): Word.TableCell;
|
|
91745
92284
|
/**
|
|
91746
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92285
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91747
92286
|
*/
|
|
91748
92287
|
untrack(): Word.TableCell;
|
|
91749
92288
|
/**
|
|
@@ -91800,7 +92339,7 @@ declare namespace Word {
|
|
|
91800
92339
|
*/
|
|
91801
92340
|
track(): Word.TableCellCollection;
|
|
91802
92341
|
/**
|
|
91803
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92342
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91804
92343
|
*/
|
|
91805
92344
|
untrack(): Word.TableCellCollection;
|
|
91806
92345
|
/**
|
|
@@ -91873,7 +92412,7 @@ declare namespace Word {
|
|
|
91873
92412
|
*/
|
|
91874
92413
|
track(): Word.TableBorder;
|
|
91875
92414
|
/**
|
|
91876
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92415
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91877
92416
|
*/
|
|
91878
92417
|
untrack(): Word.TableBorder;
|
|
91879
92418
|
/**
|
|
@@ -91980,7 +92519,7 @@ declare namespace Word {
|
|
|
91980
92519
|
*/
|
|
91981
92520
|
track(): Word.TrackedChange;
|
|
91982
92521
|
/**
|
|
91983
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92522
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
91984
92523
|
*/
|
|
91985
92524
|
untrack(): Word.TrackedChange;
|
|
91986
92525
|
/**
|
|
@@ -92051,7 +92590,7 @@ declare namespace Word {
|
|
|
92051
92590
|
*/
|
|
92052
92591
|
track(): Word.TrackedChangeCollection;
|
|
92053
92592
|
/**
|
|
92054
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You
|
|
92593
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
92055
92594
|
*/
|
|
92056
92595
|
untrack(): Word.TrackedChangeCollection;
|
|
92057
92596
|
/**
|
|
@@ -92243,6 +92782,30 @@ declare namespace Word {
|
|
|
92243
92782
|
* [Api set: WordApi 1.6]
|
|
92244
92783
|
*/
|
|
92245
92784
|
paragraphDeleted = "ParagraphDeleted",
|
|
92785
|
+
/**
|
|
92786
|
+
* Represents that an annotation was clicked (or selected with **Alt+Down**) in the document.
|
|
92787
|
+
* @remarks
|
|
92788
|
+
* [Api set: WordApi 1.7]
|
|
92789
|
+
*/
|
|
92790
|
+
annotationClicked = "AnnotationClicked",
|
|
92791
|
+
/**
|
|
92792
|
+
* Represents that an annotation was hovered over in the document.
|
|
92793
|
+
* @remarks
|
|
92794
|
+
* [Api set: WordApi 1.7]
|
|
92795
|
+
*/
|
|
92796
|
+
annotationHovered = "AnnotationHovered",
|
|
92797
|
+
/**
|
|
92798
|
+
* Represents that one or more annotations were added in the document.
|
|
92799
|
+
* @remarks
|
|
92800
|
+
* [Api set: WordApi 1.7]
|
|
92801
|
+
*/
|
|
92802
|
+
annotationInserted = "AnnotationInserted",
|
|
92803
|
+
/**
|
|
92804
|
+
* Represents that one or more annotations were deleted from the document.
|
|
92805
|
+
* @remarks
|
|
92806
|
+
* [Api set: WordApi 1.7]
|
|
92807
|
+
*/
|
|
92808
|
+
annotationRemoved = "AnnotationRemoved",
|
|
92246
92809
|
}
|
|
92247
92810
|
/**
|
|
92248
92811
|
* An enum that specifies an event's source. It can be local or remote (through coauthoring).
|
|
@@ -92275,7 +92838,7 @@ declare namespace Word {
|
|
|
92275
92838
|
* @remarks
|
|
92276
92839
|
* [Api set: WordApi 1.5]
|
|
92277
92840
|
*/
|
|
92278
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92841
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92279
92842
|
/**
|
|
92280
92843
|
* Gets the content control IDs.
|
|
92281
92844
|
*
|
|
@@ -92304,7 +92867,7 @@ declare namespace Word {
|
|
|
92304
92867
|
* @remarks
|
|
92305
92868
|
* [Api set: WordApi 1.5]
|
|
92306
92869
|
*/
|
|
92307
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92870
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92308
92871
|
/**
|
|
92309
92872
|
* Gets the content control IDs.
|
|
92310
92873
|
*
|
|
@@ -92333,7 +92896,7 @@ declare namespace Word {
|
|
|
92333
92896
|
* @remarks
|
|
92334
92897
|
* [Api set: WordApi 1.5]
|
|
92335
92898
|
*/
|
|
92336
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92899
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92337
92900
|
/**
|
|
92338
92901
|
* Gets the content control IDs.
|
|
92339
92902
|
*
|
|
@@ -92362,7 +92925,7 @@ declare namespace Word {
|
|
|
92362
92925
|
* @remarks
|
|
92363
92926
|
* [Api set: WordApi 1.5]
|
|
92364
92927
|
*/
|
|
92365
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92928
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92366
92929
|
/**
|
|
92367
92930
|
* Gets the content control IDs.
|
|
92368
92931
|
*
|
|
@@ -92391,7 +92954,7 @@ declare namespace Word {
|
|
|
92391
92954
|
* @remarks
|
|
92392
92955
|
* [Api set: WordApi 1.5]
|
|
92393
92956
|
*/
|
|
92394
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92957
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92395
92958
|
/**
|
|
92396
92959
|
* Gets the content control IDs.
|
|
92397
92960
|
*
|
|
@@ -92420,7 +92983,7 @@ declare namespace Word {
|
|
|
92420
92983
|
* @remarks
|
|
92421
92984
|
* [Api set: WordApi 1.5]
|
|
92422
92985
|
*/
|
|
92423
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
92986
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92424
92987
|
/**
|
|
92425
92988
|
* Gets the content control IDs.
|
|
92426
92989
|
*
|
|
@@ -92456,7 +93019,7 @@ declare namespace Word {
|
|
|
92456
93019
|
* @remarks
|
|
92457
93020
|
* [Api set: WordApi 1.6]
|
|
92458
93021
|
*/
|
|
92459
|
-
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
93022
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92460
93023
|
/**
|
|
92461
93024
|
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92462
93025
|
*
|
|
@@ -92485,7 +93048,7 @@ declare namespace Word {
|
|
|
92485
93048
|
* @remarks
|
|
92486
93049
|
* [Api set: WordApi 1.6]
|
|
92487
93050
|
*/
|
|
92488
|
-
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
93051
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92489
93052
|
/**
|
|
92490
93053
|
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92491
93054
|
*
|
|
@@ -92514,7 +93077,7 @@ declare namespace Word {
|
|
|
92514
93077
|
* @remarks
|
|
92515
93078
|
* [Api set: WordApi 1.6]
|
|
92516
93079
|
*/
|
|
92517
|
-
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted";
|
|
93080
|
+
type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
|
|
92518
93081
|
/**
|
|
92519
93082
|
* Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
|
|
92520
93083
|
*
|
|
@@ -94984,6 +95547,7 @@ declare namespace Word {
|
|
|
94984
95547
|
generalException = "GeneralException",
|
|
94985
95548
|
invalidArgument = "InvalidArgument",
|
|
94986
95549
|
itemNotFound = "ItemNotFound",
|
|
95550
|
+
notAllowed = "NotAllowed",
|
|
94987
95551
|
notImplemented = "NotImplemented",
|
|
94988
95552
|
searchDialogIsOpen = "SearchDialogIsOpen",
|
|
94989
95553
|
searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong",
|
|
@@ -95002,6 +95566,10 @@ declare namespace Word {
|
|
|
95002
95566
|
*/
|
|
95003
95567
|
$skip?: number;
|
|
95004
95568
|
}
|
|
95569
|
+
/** An interface for updating data on the AnnotationCollection object, for use in `annotationCollection.set({ ... })`. */
|
|
95570
|
+
interface AnnotationCollectionUpdateData {
|
|
95571
|
+
items?: Word.Interfaces.AnnotationData[];
|
|
95572
|
+
}
|
|
95005
95573
|
/** An interface for updating data on the Body object, for use in `body.set({ ... })`. */
|
|
95006
95574
|
interface BodyUpdateData {
|
|
95007
95575
|
/**
|
|
@@ -95026,6 +95594,16 @@ declare namespace Word {
|
|
|
95026
95594
|
*/
|
|
95027
95595
|
styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
95028
95596
|
}
|
|
95597
|
+
/** An interface for updating data on the CheckboxContentControl object, for use in `checkboxContentControl.set({ ... })`. */
|
|
95598
|
+
interface CheckboxContentControlUpdateData {
|
|
95599
|
+
/**
|
|
95600
|
+
* Specifies the current state of the checkbox.
|
|
95601
|
+
*
|
|
95602
|
+
* @remarks
|
|
95603
|
+
* [Api set: WordApi 1.7]
|
|
95604
|
+
*/
|
|
95605
|
+
isChecked?: boolean;
|
|
95606
|
+
}
|
|
95029
95607
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
95030
95608
|
interface CommentUpdateData {
|
|
95031
95609
|
/**
|
|
@@ -95123,11 +95701,18 @@ declare namespace Word {
|
|
|
95123
95701
|
/** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
|
|
95124
95702
|
interface ContentControlUpdateData {
|
|
95125
95703
|
/**
|
|
95126
|
-
|
|
95127
|
-
|
|
95128
|
-
|
|
95129
|
-
|
|
95130
|
-
|
|
95704
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
95705
|
+
*
|
|
95706
|
+
* @remarks
|
|
95707
|
+
* [Api set: WordApi 1.7]
|
|
95708
|
+
*/
|
|
95709
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData;
|
|
95710
|
+
/**
|
|
95711
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
95712
|
+
*
|
|
95713
|
+
* @remarks
|
|
95714
|
+
* [Api set: WordApi 1.1]
|
|
95715
|
+
*/
|
|
95131
95716
|
font?: Word.Interfaces.FontUpdateData;
|
|
95132
95717
|
/**
|
|
95133
95718
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -96231,6 +96816,37 @@ declare namespace Word {
|
|
|
96231
96816
|
interface TrackedChangeCollectionUpdateData {
|
|
96232
96817
|
items?: Word.Interfaces.TrackedChangeData[];
|
|
96233
96818
|
}
|
|
96819
|
+
/** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */
|
|
96820
|
+
interface CritiqueAnnotationData {
|
|
96821
|
+
/**
|
|
96822
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
96823
|
+
*
|
|
96824
|
+
* @remarks
|
|
96825
|
+
* [Api set: WordApi 1.7]
|
|
96826
|
+
*/
|
|
96827
|
+
critique?: Word.Critique;
|
|
96828
|
+
}
|
|
96829
|
+
/** An interface describing the data returned by calling `annotation.toJSON()`. */
|
|
96830
|
+
interface AnnotationData {
|
|
96831
|
+
/**
|
|
96832
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
96833
|
+
*
|
|
96834
|
+
* @remarks
|
|
96835
|
+
* [Api set: WordApi 1.7]
|
|
96836
|
+
*/
|
|
96837
|
+
id?: string;
|
|
96838
|
+
/**
|
|
96839
|
+
* Gets the state of the annotation.
|
|
96840
|
+
*
|
|
96841
|
+
* @remarks
|
|
96842
|
+
* [Api set: WordApi 1.7]
|
|
96843
|
+
*/
|
|
96844
|
+
state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
96845
|
+
}
|
|
96846
|
+
/** An interface describing the data returned by calling `annotationCollection.toJSON()`. */
|
|
96847
|
+
interface AnnotationCollectionData {
|
|
96848
|
+
items?: Word.Interfaces.AnnotationData[];
|
|
96849
|
+
}
|
|
96234
96850
|
/** An interface describing the data returned by calling `body.toJSON()`. */
|
|
96235
96851
|
interface BodyData {
|
|
96236
96852
|
/**
|
|
@@ -96313,6 +96929,16 @@ declare namespace Word {
|
|
|
96313
96929
|
*/
|
|
96314
96930
|
type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
|
|
96315
96931
|
}
|
|
96932
|
+
/** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */
|
|
96933
|
+
interface CheckboxContentControlData {
|
|
96934
|
+
/**
|
|
96935
|
+
* Specifies the current state of the checkbox.
|
|
96936
|
+
*
|
|
96937
|
+
* @remarks
|
|
96938
|
+
* [Api set: WordApi 1.7]
|
|
96939
|
+
*/
|
|
96940
|
+
isChecked?: boolean;
|
|
96941
|
+
}
|
|
96316
96942
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
96317
96943
|
interface CommentData {
|
|
96318
96944
|
/**
|
|
@@ -96487,55 +97113,62 @@ declare namespace Word {
|
|
|
96487
97113
|
/** An interface describing the data returned by calling `contentControl.toJSON()`. */
|
|
96488
97114
|
interface ContentControlData {
|
|
96489
97115
|
/**
|
|
96490
|
-
|
|
96491
|
-
|
|
96492
|
-
|
|
96493
|
-
|
|
96494
|
-
|
|
97116
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
97117
|
+
*
|
|
97118
|
+
* @remarks
|
|
97119
|
+
* [Api set: WordApi 1.7]
|
|
97120
|
+
*/
|
|
97121
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
|
|
97122
|
+
/**
|
|
97123
|
+
* Gets the collection of content control objects in the content control.
|
|
97124
|
+
*
|
|
97125
|
+
* @remarks
|
|
97126
|
+
* [Api set: WordApi 1.1]
|
|
97127
|
+
*/
|
|
96495
97128
|
contentControls?: Word.Interfaces.ContentControlData[];
|
|
96496
97129
|
/**
|
|
96497
|
-
|
|
96498
|
-
|
|
96499
|
-
|
|
96500
|
-
|
|
96501
|
-
|
|
97130
|
+
* Gets the collection of field objects in the content control.
|
|
97131
|
+
*
|
|
97132
|
+
* @remarks
|
|
97133
|
+
* [Api set: WordApi 1.4]
|
|
97134
|
+
*/
|
|
96502
97135
|
fields?: Word.Interfaces.FieldData[];
|
|
96503
97136
|
/**
|
|
96504
|
-
|
|
96505
|
-
|
|
96506
|
-
|
|
96507
|
-
|
|
96508
|
-
|
|
97137
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
97138
|
+
*
|
|
97139
|
+
* @remarks
|
|
97140
|
+
* [Api set: WordApi 1.1]
|
|
97141
|
+
*/
|
|
96509
97142
|
font?: Word.Interfaces.FontData;
|
|
96510
97143
|
/**
|
|
96511
|
-
|
|
96512
|
-
|
|
96513
|
-
|
|
96514
|
-
|
|
96515
|
-
|
|
97144
|
+
* Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
|
|
97145
|
+
*
|
|
97146
|
+
* @remarks
|
|
97147
|
+
* [Api set: WordApi 1.1]
|
|
97148
|
+
*/
|
|
96516
97149
|
inlinePictures?: Word.Interfaces.InlinePictureData[];
|
|
96517
97150
|
/**
|
|
96518
|
-
|
|
96519
|
-
|
|
96520
|
-
|
|
96521
|
-
|
|
96522
|
-
|
|
97151
|
+
* Gets the collection of list objects in the content control.
|
|
97152
|
+
*
|
|
97153
|
+
* @remarks
|
|
97154
|
+
* [Api set: WordApi 1.3]
|
|
97155
|
+
*/
|
|
96523
97156
|
lists?: Word.Interfaces.ListData[];
|
|
96524
97157
|
/**
|
|
96525
|
-
|
|
96526
|
-
|
|
96527
|
-
|
|
96528
|
-
|
|
96529
|
-
|
|
96530
|
-
|
|
96531
|
-
|
|
97158
|
+
* Gets the collection of paragraph objects in the content control.
|
|
97159
|
+
*
|
|
97160
|
+
* @remarks
|
|
97161
|
+
* [Api set: WordApi 1.1]
|
|
97162
|
+
*
|
|
97163
|
+
* Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
|
|
97164
|
+
*/
|
|
96532
97165
|
paragraphs?: Word.Interfaces.ParagraphData[];
|
|
96533
97166
|
/**
|
|
96534
|
-
|
|
96535
|
-
|
|
96536
|
-
|
|
96537
|
-
|
|
96538
|
-
|
|
97167
|
+
* Gets the collection of table objects in the content control.
|
|
97168
|
+
*
|
|
97169
|
+
* @remarks
|
|
97170
|
+
* [Api set: WordApi 1.3]
|
|
97171
|
+
*/
|
|
96539
97172
|
tables?: Word.Interfaces.TableData[];
|
|
96540
97173
|
/**
|
|
96541
97174
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -96603,7 +97236,7 @@ declare namespace Word {
|
|
|
96603
97236
|
*/
|
|
96604
97237
|
styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
96605
97238
|
/**
|
|
96606
|
-
* 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.
|
|
97239
|
+
* 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.
|
|
96607
97240
|
*
|
|
96608
97241
|
* @remarks
|
|
96609
97242
|
* [Api set: WordApi 1.3]
|
|
@@ -96631,7 +97264,7 @@ declare namespace Word {
|
|
|
96631
97264
|
*/
|
|
96632
97265
|
title?: string;
|
|
96633
97266
|
/**
|
|
96634
|
-
* Gets the content control type. Only rich text
|
|
97267
|
+
* Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.
|
|
96635
97268
|
*
|
|
96636
97269
|
* @remarks
|
|
96637
97270
|
* [Api set: WordApi 1.1]
|
|
@@ -98113,28 +98746,28 @@ declare namespace Word {
|
|
|
98113
98746
|
/** An interface describing the data returned by calling `trackedChange.toJSON()`. */
|
|
98114
98747
|
interface TrackedChangeData {
|
|
98115
98748
|
/**
|
|
98116
|
-
*
|
|
98749
|
+
* Specifies the author of the tracked change.
|
|
98117
98750
|
*
|
|
98118
98751
|
* @remarks
|
|
98119
98752
|
* [Api set: WordApi 1.6]
|
|
98120
98753
|
*/
|
|
98121
98754
|
author?: string;
|
|
98122
98755
|
/**
|
|
98123
|
-
*
|
|
98756
|
+
* Specifies the date of the tracked change.
|
|
98124
98757
|
*
|
|
98125
98758
|
* @remarks
|
|
98126
98759
|
* [Api set: WordApi 1.6]
|
|
98127
98760
|
*/
|
|
98128
98761
|
date?: Date;
|
|
98129
98762
|
/**
|
|
98130
|
-
*
|
|
98763
|
+
* Specifies the text of the tracked change.
|
|
98131
98764
|
*
|
|
98132
98765
|
* @remarks
|
|
98133
98766
|
* [Api set: WordApi 1.6]
|
|
98134
98767
|
*/
|
|
98135
98768
|
text?: string;
|
|
98136
98769
|
/**
|
|
98137
|
-
*
|
|
98770
|
+
* Specifies the type of the tracked change.
|
|
98138
98771
|
*
|
|
98139
98772
|
* @remarks
|
|
98140
98773
|
* [Api set: WordApi 1.6]
|
|
@@ -98145,6 +98778,98 @@ declare namespace Word {
|
|
|
98145
98778
|
interface TrackedChangeCollectionData {
|
|
98146
98779
|
items?: Word.Interfaces.TrackedChangeData[];
|
|
98147
98780
|
}
|
|
98781
|
+
/**
|
|
98782
|
+
* Represents an annotation wrapper around critique displayed in the document.
|
|
98783
|
+
*
|
|
98784
|
+
* @remarks
|
|
98785
|
+
* [Api set: WordApi 1.7]
|
|
98786
|
+
*/
|
|
98787
|
+
interface CritiqueAnnotationLoadOptions {
|
|
98788
|
+
/**
|
|
98789
|
+
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`).
|
|
98790
|
+
*/
|
|
98791
|
+
$all?: boolean;
|
|
98792
|
+
/**
|
|
98793
|
+
* Gets the range of text that is annotated.
|
|
98794
|
+
*
|
|
98795
|
+
* @remarks
|
|
98796
|
+
* [Api set: WordApi 1.7]
|
|
98797
|
+
*/
|
|
98798
|
+
range?: Word.Interfaces.RangeLoadOptions;
|
|
98799
|
+
/**
|
|
98800
|
+
* Gets the critique that was passed when the annotation was inserted.
|
|
98801
|
+
*
|
|
98802
|
+
* @remarks
|
|
98803
|
+
* [Api set: WordApi 1.7]
|
|
98804
|
+
*/
|
|
98805
|
+
critique?: boolean;
|
|
98806
|
+
}
|
|
98807
|
+
/**
|
|
98808
|
+
* Represents an annotation attached to a paragraph.
|
|
98809
|
+
*
|
|
98810
|
+
* @remarks
|
|
98811
|
+
* [Api set: WordApi 1.7]
|
|
98812
|
+
*/
|
|
98813
|
+
interface AnnotationLoadOptions {
|
|
98814
|
+
/**
|
|
98815
|
+
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`).
|
|
98816
|
+
*/
|
|
98817
|
+
$all?: boolean;
|
|
98818
|
+
/**
|
|
98819
|
+
* Gets the critique annotation object.
|
|
98820
|
+
*
|
|
98821
|
+
* @remarks
|
|
98822
|
+
* [Api set: WordApi 1.7]
|
|
98823
|
+
*/
|
|
98824
|
+
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
98825
|
+
/**
|
|
98826
|
+
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
98827
|
+
*
|
|
98828
|
+
* @remarks
|
|
98829
|
+
* [Api set: WordApi 1.7]
|
|
98830
|
+
*/
|
|
98831
|
+
id?: boolean;
|
|
98832
|
+
/**
|
|
98833
|
+
* Gets the state of the annotation.
|
|
98834
|
+
*
|
|
98835
|
+
* @remarks
|
|
98836
|
+
* [Api set: WordApi 1.7]
|
|
98837
|
+
*/
|
|
98838
|
+
state?: boolean;
|
|
98839
|
+
}
|
|
98840
|
+
/**
|
|
98841
|
+
* Contains a collection of {@link Word.Annotation} objects.
|
|
98842
|
+
*
|
|
98843
|
+
* @remarks
|
|
98844
|
+
* [Api set: WordApi 1.7]
|
|
98845
|
+
*/
|
|
98846
|
+
interface AnnotationCollectionLoadOptions {
|
|
98847
|
+
/**
|
|
98848
|
+
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`).
|
|
98849
|
+
*/
|
|
98850
|
+
$all?: boolean;
|
|
98851
|
+
/**
|
|
98852
|
+
* For EACH ITEM in the collection: Gets the critique annotation object.
|
|
98853
|
+
*
|
|
98854
|
+
* @remarks
|
|
98855
|
+
* [Api set: WordApi 1.7]
|
|
98856
|
+
*/
|
|
98857
|
+
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
98858
|
+
/**
|
|
98859
|
+
* For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
98860
|
+
*
|
|
98861
|
+
* @remarks
|
|
98862
|
+
* [Api set: WordApi 1.7]
|
|
98863
|
+
*/
|
|
98864
|
+
id?: boolean;
|
|
98865
|
+
/**
|
|
98866
|
+
* For EACH ITEM in the collection: Gets the state of the annotation.
|
|
98867
|
+
*
|
|
98868
|
+
* @remarks
|
|
98869
|
+
* [Api set: WordApi 1.7]
|
|
98870
|
+
*/
|
|
98871
|
+
state?: boolean;
|
|
98872
|
+
}
|
|
98148
98873
|
/**
|
|
98149
98874
|
* Represents the body of a document or a section.
|
|
98150
98875
|
*
|
|
@@ -98234,6 +98959,25 @@ declare namespace Word {
|
|
|
98234
98959
|
*/
|
|
98235
98960
|
type?: boolean;
|
|
98236
98961
|
}
|
|
98962
|
+
/**
|
|
98963
|
+
* The data specific to content controls of type CheckBox.
|
|
98964
|
+
*
|
|
98965
|
+
* @remarks
|
|
98966
|
+
* [Api set: WordApi 1.7]
|
|
98967
|
+
*/
|
|
98968
|
+
interface CheckboxContentControlLoadOptions {
|
|
98969
|
+
/**
|
|
98970
|
+
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`).
|
|
98971
|
+
*/
|
|
98972
|
+
$all?: boolean;
|
|
98973
|
+
/**
|
|
98974
|
+
* Specifies the current state of the checkbox.
|
|
98975
|
+
*
|
|
98976
|
+
* @remarks
|
|
98977
|
+
* [Api set: WordApi 1.7]
|
|
98978
|
+
*/
|
|
98979
|
+
isChecked?: boolean;
|
|
98980
|
+
}
|
|
98237
98981
|
/**
|
|
98238
98982
|
* Represents a comment in the document.
|
|
98239
98983
|
*
|
|
@@ -98538,7 +99282,7 @@ declare namespace Word {
|
|
|
98538
99282
|
id?: boolean;
|
|
98539
99283
|
}
|
|
98540
99284
|
/**
|
|
98541
|
-
* Represents a content control. 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
|
|
99285
|
+
* Represents a content control. 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, plain text, and checkbox content controls are supported.
|
|
98542
99286
|
*
|
|
98543
99287
|
* @remarks
|
|
98544
99288
|
* [Api set: WordApi 1.1]
|
|
@@ -98549,60 +99293,67 @@ declare namespace Word {
|
|
|
98549
99293
|
*/
|
|
98550
99294
|
$all?: boolean;
|
|
98551
99295
|
/**
|
|
98552
|
-
|
|
98553
|
-
|
|
98554
|
-
|
|
98555
|
-
|
|
98556
|
-
|
|
99296
|
+
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
99297
|
+
*
|
|
99298
|
+
* @remarks
|
|
99299
|
+
* [Api set: WordApi 1.7]
|
|
99300
|
+
*/
|
|
99301
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
99302
|
+
/**
|
|
99303
|
+
* Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
|
|
99304
|
+
*
|
|
99305
|
+
* @remarks
|
|
99306
|
+
* [Api set: WordApi 1.1]
|
|
99307
|
+
*/
|
|
98557
99308
|
font?: Word.Interfaces.FontLoadOptions;
|
|
98558
99309
|
/**
|
|
98559
|
-
|
|
98560
|
-
|
|
98561
|
-
|
|
98562
|
-
|
|
98563
|
-
|
|
99310
|
+
* Gets the parent body of the content control.
|
|
99311
|
+
*
|
|
99312
|
+
* @remarks
|
|
99313
|
+
* [Api set: WordApi 1.3]
|
|
99314
|
+
*/
|
|
98564
99315
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
98565
99316
|
/**
|
|
98566
|
-
|
|
98567
|
-
|
|
98568
|
-
|
|
98569
|
-
|
|
98570
|
-
|
|
99317
|
+
* Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
99318
|
+
*
|
|
99319
|
+
* @remarks
|
|
99320
|
+
* [Api set: WordApi 1.1]
|
|
99321
|
+
*/
|
|
98571
99322
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
98572
99323
|
/**
|
|
98573
|
-
|
|
98574
|
-
|
|
98575
|
-
|
|
98576
|
-
|
|
98577
|
-
|
|
99324
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99325
|
+
*
|
|
99326
|
+
* @remarks
|
|
99327
|
+
* [Api set: WordApi 1.3]
|
|
99328
|
+
*/
|
|
98578
99329
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98579
99330
|
/**
|
|
98580
|
-
|
|
98581
|
-
|
|
98582
|
-
|
|
98583
|
-
|
|
98584
|
-
|
|
99331
|
+
* Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
99332
|
+
*
|
|
99333
|
+
* @remarks
|
|
99334
|
+
* [Api set: WordApi 1.3]
|
|
99335
|
+
*/
|
|
98585
99336
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98586
99337
|
/**
|
|
98587
|
-
|
|
98588
|
-
|
|
98589
|
-
|
|
98590
|
-
|
|
98591
|
-
|
|
99338
|
+
* Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
99339
|
+
*
|
|
99340
|
+
* @remarks
|
|
99341
|
+
* [Api set: WordApi 1.3]
|
|
99342
|
+
*/
|
|
98592
99343
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
98593
99344
|
/**
|
|
98594
|
-
|
|
98595
|
-
|
|
98596
|
-
|
|
98597
|
-
|
|
98598
|
-
|
|
99345
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99346
|
+
*
|
|
99347
|
+
* @remarks
|
|
99348
|
+
* [Api set: WordApi 1.3]
|
|
99349
|
+
*/
|
|
98599
99350
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
98600
99351
|
/**
|
|
98601
|
-
|
|
98602
|
-
|
|
98603
|
-
|
|
98604
|
-
|
|
98605
|
-
|
|
99352
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99353
|
+
*
|
|
99354
|
+
* @remarks
|
|
99355
|
+
* [Api set: WordApi 1.3]
|
|
99356
|
+
*/
|
|
98606
99357
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
98607
99358
|
/**
|
|
98608
99359
|
* Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -98670,7 +99421,7 @@ declare namespace Word {
|
|
|
98670
99421
|
*/
|
|
98671
99422
|
styleBuiltIn?: boolean;
|
|
98672
99423
|
/**
|
|
98673
|
-
* 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.
|
|
99424
|
+
* 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.
|
|
98674
99425
|
*
|
|
98675
99426
|
* @remarks
|
|
98676
99427
|
* [Api set: WordApi 1.3]
|
|
@@ -98698,7 +99449,7 @@ declare namespace Word {
|
|
|
98698
99449
|
*/
|
|
98699
99450
|
title?: boolean;
|
|
98700
99451
|
/**
|
|
98701
|
-
* Gets the content control type. Only rich text
|
|
99452
|
+
* Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.
|
|
98702
99453
|
*
|
|
98703
99454
|
* @remarks
|
|
98704
99455
|
* [Api set: WordApi 1.1]
|
|
@@ -98717,60 +99468,67 @@ declare namespace Word {
|
|
|
98717
99468
|
*/
|
|
98718
99469
|
$all?: boolean;
|
|
98719
99470
|
/**
|
|
98720
|
-
|
|
98721
|
-
|
|
98722
|
-
|
|
98723
|
-
|
|
98724
|
-
|
|
99471
|
+
* For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
99472
|
+
*
|
|
99473
|
+
* @remarks
|
|
99474
|
+
* [Api set: WordApi 1.7]
|
|
99475
|
+
*/
|
|
99476
|
+
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
99477
|
+
/**
|
|
99478
|
+
* 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.
|
|
99479
|
+
*
|
|
99480
|
+
* @remarks
|
|
99481
|
+
* [Api set: WordApi 1.1]
|
|
99482
|
+
*/
|
|
98725
99483
|
font?: Word.Interfaces.FontLoadOptions;
|
|
98726
99484
|
/**
|
|
98727
|
-
|
|
98728
|
-
|
|
98729
|
-
|
|
98730
|
-
|
|
98731
|
-
|
|
99485
|
+
* For EACH ITEM in the collection: Gets the parent body of the content control.
|
|
99486
|
+
*
|
|
99487
|
+
* @remarks
|
|
99488
|
+
* [Api set: WordApi 1.3]
|
|
99489
|
+
*/
|
|
98732
99490
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
98733
99491
|
/**
|
|
98734
|
-
|
|
98735
|
-
|
|
98736
|
-
|
|
98737
|
-
|
|
98738
|
-
|
|
99492
|
+
* 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.
|
|
99493
|
+
*
|
|
99494
|
+
* @remarks
|
|
99495
|
+
* [Api set: WordApi 1.1]
|
|
99496
|
+
*/
|
|
98739
99497
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
98740
99498
|
/**
|
|
98741
|
-
|
|
98742
|
-
|
|
98743
|
-
|
|
98744
|
-
|
|
98745
|
-
|
|
99499
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99500
|
+
*
|
|
99501
|
+
* @remarks
|
|
99502
|
+
* [Api set: WordApi 1.3]
|
|
99503
|
+
*/
|
|
98746
99504
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
98747
99505
|
/**
|
|
98748
|
-
|
|
98749
|
-
|
|
98750
|
-
|
|
98751
|
-
|
|
98752
|
-
|
|
99506
|
+
* 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.
|
|
99507
|
+
*
|
|
99508
|
+
* @remarks
|
|
99509
|
+
* [Api set: WordApi 1.3]
|
|
99510
|
+
*/
|
|
98753
99511
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
98754
99512
|
/**
|
|
98755
|
-
|
|
98756
|
-
|
|
98757
|
-
|
|
98758
|
-
|
|
98759
|
-
|
|
99513
|
+
* 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.
|
|
99514
|
+
*
|
|
99515
|
+
* @remarks
|
|
99516
|
+
* [Api set: WordApi 1.3]
|
|
99517
|
+
*/
|
|
98760
99518
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
98761
99519
|
/**
|
|
98762
|
-
|
|
98763
|
-
|
|
98764
|
-
|
|
98765
|
-
|
|
98766
|
-
|
|
99520
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99521
|
+
*
|
|
99522
|
+
* @remarks
|
|
99523
|
+
* [Api set: WordApi 1.3]
|
|
99524
|
+
*/
|
|
98767
99525
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
98768
99526
|
/**
|
|
98769
|
-
|
|
98770
|
-
|
|
98771
|
-
|
|
98772
|
-
|
|
98773
|
-
|
|
99527
|
+
* 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99528
|
+
*
|
|
99529
|
+
* @remarks
|
|
99530
|
+
* [Api set: WordApi 1.3]
|
|
99531
|
+
*/
|
|
98774
99532
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
98775
99533
|
/**
|
|
98776
99534
|
* For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
|
|
@@ -98838,7 +99596,7 @@ declare namespace Word {
|
|
|
98838
99596
|
*/
|
|
98839
99597
|
styleBuiltIn?: boolean;
|
|
98840
99598
|
/**
|
|
98841
|
-
* 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.
|
|
99599
|
+
* 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.
|
|
98842
99600
|
*
|
|
98843
99601
|
* @remarks
|
|
98844
99602
|
* [Api set: WordApi 1.3]
|
|
@@ -98866,7 +99624,7 @@ declare namespace Word {
|
|
|
98866
99624
|
*/
|
|
98867
99625
|
title?: boolean;
|
|
98868
99626
|
/**
|
|
98869
|
-
* For EACH ITEM in the collection: Gets the content control type. Only rich text
|
|
99627
|
+
* For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.
|
|
98870
99628
|
*
|
|
98871
99629
|
* @remarks
|
|
98872
99630
|
* [Api set: WordApi 1.1]
|
|
@@ -100443,60 +101201,60 @@ declare namespace Word {
|
|
|
100443
101201
|
*/
|
|
100444
101202
|
$all?: boolean;
|
|
100445
101203
|
/**
|
|
100446
|
-
|
|
100447
|
-
|
|
100448
|
-
|
|
100449
|
-
|
|
100450
|
-
|
|
101204
|
+
* Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
|
|
101205
|
+
*
|
|
101206
|
+
* @remarks
|
|
101207
|
+
* [Api set: WordApi 1.1]
|
|
101208
|
+
*/
|
|
100451
101209
|
font?: Word.Interfaces.FontLoadOptions;
|
|
100452
101210
|
/**
|
|
100453
|
-
|
|
100454
|
-
|
|
100455
|
-
|
|
100456
|
-
|
|
100457
|
-
|
|
101211
|
+
* Gets the parent body of the range.
|
|
101212
|
+
*
|
|
101213
|
+
* @remarks
|
|
101214
|
+
* [Api set: WordApi 1.3]
|
|
101215
|
+
*/
|
|
100458
101216
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
100459
101217
|
/**
|
|
100460
|
-
|
|
100461
|
-
|
|
100462
|
-
|
|
100463
|
-
|
|
100464
|
-
|
|
101218
|
+
* Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
101219
|
+
*
|
|
101220
|
+
* @remarks
|
|
101221
|
+
* [Api set: WordApi 1.1]
|
|
101222
|
+
*/
|
|
100465
101223
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
100466
101224
|
/**
|
|
100467
|
-
|
|
100468
|
-
|
|
100469
|
-
|
|
100470
|
-
|
|
100471
|
-
|
|
101225
|
+
* Gets the currently supported content control that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101226
|
+
*
|
|
101227
|
+
* @remarks
|
|
101228
|
+
* [Api set: WordApi 1.3]
|
|
101229
|
+
*/
|
|
100472
101230
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
100473
101231
|
/**
|
|
100474
|
-
|
|
100475
|
-
|
|
100476
|
-
|
|
100477
|
-
|
|
100478
|
-
|
|
101232
|
+
* Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
101233
|
+
*
|
|
101234
|
+
* @remarks
|
|
101235
|
+
* [Api set: WordApi 1.3]
|
|
101236
|
+
*/
|
|
100479
101237
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
100480
101238
|
/**
|
|
100481
|
-
|
|
100482
|
-
|
|
100483
|
-
|
|
100484
|
-
|
|
100485
|
-
|
|
101239
|
+
* Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
101240
|
+
*
|
|
101241
|
+
* @remarks
|
|
101242
|
+
* [Api set: WordApi 1.3]
|
|
101243
|
+
*/
|
|
100486
101244
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
100487
101245
|
/**
|
|
100488
|
-
|
|
100489
|
-
|
|
100490
|
-
|
|
100491
|
-
|
|
100492
|
-
|
|
101246
|
+
* Gets the table cell that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101247
|
+
*
|
|
101248
|
+
* @remarks
|
|
101249
|
+
* [Api set: WordApi 1.3]
|
|
101250
|
+
*/
|
|
100493
101251
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
100494
101252
|
/**
|
|
100495
|
-
|
|
100496
|
-
|
|
100497
|
-
|
|
100498
|
-
|
|
100499
|
-
|
|
101253
|
+
* Gets the table that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101254
|
+
*
|
|
101255
|
+
* @remarks
|
|
101256
|
+
* [Api set: WordApi 1.3]
|
|
101257
|
+
*/
|
|
100500
101258
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
100501
101259
|
/**
|
|
100502
101260
|
* Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
|
|
@@ -100546,60 +101304,60 @@ declare namespace Word {
|
|
|
100546
101304
|
*/
|
|
100547
101305
|
$all?: boolean;
|
|
100548
101306
|
/**
|
|
100549
|
-
|
|
100550
|
-
|
|
100551
|
-
|
|
100552
|
-
|
|
100553
|
-
|
|
101307
|
+
* For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
|
|
101308
|
+
*
|
|
101309
|
+
* @remarks
|
|
101310
|
+
* [Api set: WordApi 1.1]
|
|
101311
|
+
*/
|
|
100554
101312
|
font?: Word.Interfaces.FontLoadOptions;
|
|
100555
101313
|
/**
|
|
100556
|
-
|
|
100557
|
-
|
|
100558
|
-
|
|
100559
|
-
|
|
100560
|
-
|
|
101314
|
+
* For EACH ITEM in the collection: Gets the parent body of the range.
|
|
101315
|
+
*
|
|
101316
|
+
* @remarks
|
|
101317
|
+
* [Api set: WordApi 1.3]
|
|
101318
|
+
*/
|
|
100561
101319
|
parentBody?: Word.Interfaces.BodyLoadOptions;
|
|
100562
101320
|
/**
|
|
100563
|
-
|
|
100564
|
-
|
|
100565
|
-
|
|
100566
|
-
|
|
100567
|
-
|
|
101321
|
+
* For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
|
|
101322
|
+
*
|
|
101323
|
+
* @remarks
|
|
101324
|
+
* [Api set: WordApi 1.1]
|
|
101325
|
+
*/
|
|
100568
101326
|
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
|
|
100569
101327
|
/**
|
|
100570
|
-
|
|
100571
|
-
|
|
100572
|
-
|
|
100573
|
-
|
|
100574
|
-
|
|
101328
|
+
* For EACH ITEM in the collection: Gets the currently supported content control that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101329
|
+
*
|
|
101330
|
+
* @remarks
|
|
101331
|
+
* [Api set: WordApi 1.3]
|
|
101332
|
+
*/
|
|
100575
101333
|
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
|
|
100576
101334
|
/**
|
|
100577
|
-
|
|
100578
|
-
|
|
100579
|
-
|
|
100580
|
-
|
|
100581
|
-
|
|
101335
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
|
|
101336
|
+
*
|
|
101337
|
+
* @remarks
|
|
101338
|
+
* [Api set: WordApi 1.3]
|
|
101339
|
+
*/
|
|
100582
101340
|
parentTable?: Word.Interfaces.TableLoadOptions;
|
|
100583
101341
|
/**
|
|
100584
|
-
|
|
100585
|
-
|
|
100586
|
-
|
|
100587
|
-
|
|
100588
|
-
|
|
101342
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
|
|
101343
|
+
*
|
|
101344
|
+
* @remarks
|
|
101345
|
+
* [Api set: WordApi 1.3]
|
|
101346
|
+
*/
|
|
100589
101347
|
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
|
|
100590
101348
|
/**
|
|
100591
|
-
|
|
100592
|
-
|
|
100593
|
-
|
|
100594
|
-
|
|
100595
|
-
|
|
101349
|
+
* For EACH ITEM in the collection: Gets the table cell that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101350
|
+
*
|
|
101351
|
+
* @remarks
|
|
101352
|
+
* [Api set: WordApi 1.3]
|
|
101353
|
+
*/
|
|
100596
101354
|
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
|
|
100597
101355
|
/**
|
|
100598
|
-
|
|
100599
|
-
|
|
100600
|
-
|
|
100601
|
-
|
|
100602
|
-
|
|
101356
|
+
* For EACH ITEM in the collection: Gets the table that contains the range. 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 {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
101357
|
+
*
|
|
101358
|
+
* @remarks
|
|
101359
|
+
* [Api set: WordApi 1.3]
|
|
101360
|
+
*/
|
|
100603
101361
|
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
|
|
100604
101362
|
/**
|
|
100605
101363
|
* For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
|
|
@@ -100801,32 +101559,32 @@ declare namespace Word {
|
|
|
100801
101559
|
*/
|
|
100802
101560
|
$all?: boolean;
|
|
100803
101561
|
/**
|
|
100804
|
-
|
|
100805
|
-
|
|
100806
|
-
|
|
100807
|
-
|
|
100808
|
-
|
|
101562
|
+
* For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
|
|
101563
|
+
*
|
|
101564
|
+
* @remarks
|
|
101565
|
+
* [Api set: WordApi 1.5]
|
|
101566
|
+
*/
|
|
100809
101567
|
font?: Word.Interfaces.FontLoadOptions;
|
|
100810
101568
|
/**
|
|
100811
|
-
|
|
100812
|
-
|
|
100813
|
-
|
|
100814
|
-
|
|
100815
|
-
|
|
101569
|
+
* For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
|
|
101570
|
+
*
|
|
101571
|
+
* @remarks
|
|
101572
|
+
* [Api set: WordApi 1.5]
|
|
101573
|
+
*/
|
|
100816
101574
|
paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
|
|
100817
101575
|
/**
|
|
100818
|
-
|
|
100819
|
-
|
|
100820
|
-
|
|
100821
|
-
|
|
100822
|
-
|
|
101576
|
+
* For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
|
|
101577
|
+
*
|
|
101578
|
+
* @remarks
|
|
101579
|
+
* [Api set: WordApi 1.6]
|
|
101580
|
+
*/
|
|
100823
101581
|
shading?: Word.Interfaces.ShadingLoadOptions;
|
|
100824
101582
|
/**
|
|
100825
|
-
|
|
100826
|
-
|
|
100827
|
-
|
|
100828
|
-
|
|
100829
|
-
|
|
101583
|
+
* For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
|
|
101584
|
+
*
|
|
101585
|
+
* @remarks
|
|
101586
|
+
* [Api set: WordApi 1.6]
|
|
101587
|
+
*/
|
|
100830
101588
|
tableStyle?: Word.Interfaces.TableStyleLoadOptions;
|
|
100831
101589
|
/**
|
|
100832
101590
|
* For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
|
|
@@ -101858,28 +102616,28 @@ declare namespace Word {
|
|
|
101858
102616
|
*/
|
|
101859
102617
|
$all?: boolean;
|
|
101860
102618
|
/**
|
|
101861
|
-
*
|
|
102619
|
+
* Specifies the author of the tracked change.
|
|
101862
102620
|
*
|
|
101863
102621
|
* @remarks
|
|
101864
102622
|
* [Api set: WordApi 1.6]
|
|
101865
102623
|
*/
|
|
101866
102624
|
author?: boolean;
|
|
101867
102625
|
/**
|
|
101868
|
-
*
|
|
102626
|
+
* Specifies the date of the tracked change.
|
|
101869
102627
|
*
|
|
101870
102628
|
* @remarks
|
|
101871
102629
|
* [Api set: WordApi 1.6]
|
|
101872
102630
|
*/
|
|
101873
102631
|
date?: boolean;
|
|
101874
102632
|
/**
|
|
101875
|
-
*
|
|
102633
|
+
* Specifies the text of the tracked change.
|
|
101876
102634
|
*
|
|
101877
102635
|
* @remarks
|
|
101878
102636
|
* [Api set: WordApi 1.6]
|
|
101879
102637
|
*/
|
|
101880
102638
|
text?: boolean;
|
|
101881
102639
|
/**
|
|
101882
|
-
*
|
|
102640
|
+
* Specifies the type of the tracked change.
|
|
101883
102641
|
*
|
|
101884
102642
|
* @remarks
|
|
101885
102643
|
* [Api set: WordApi 1.6]
|
|
@@ -101898,28 +102656,28 @@ declare namespace Word {
|
|
|
101898
102656
|
*/
|
|
101899
102657
|
$all?: boolean;
|
|
101900
102658
|
/**
|
|
101901
|
-
* For EACH ITEM in the collection:
|
|
102659
|
+
* For EACH ITEM in the collection: Specifies the author of the tracked change.
|
|
101902
102660
|
*
|
|
101903
102661
|
* @remarks
|
|
101904
102662
|
* [Api set: WordApi 1.6]
|
|
101905
102663
|
*/
|
|
101906
102664
|
author?: boolean;
|
|
101907
102665
|
/**
|
|
101908
|
-
* For EACH ITEM in the collection:
|
|
102666
|
+
* For EACH ITEM in the collection: Specifies the date of the tracked change.
|
|
101909
102667
|
*
|
|
101910
102668
|
* @remarks
|
|
101911
102669
|
* [Api set: WordApi 1.6]
|
|
101912
102670
|
*/
|
|
101913
102671
|
date?: boolean;
|
|
101914
102672
|
/**
|
|
101915
|
-
* For EACH ITEM in the collection:
|
|
102673
|
+
* For EACH ITEM in the collection: Specifies the text of the tracked change.
|
|
101916
102674
|
*
|
|
101917
102675
|
* @remarks
|
|
101918
102676
|
* [Api set: WordApi 1.6]
|
|
101919
102677
|
*/
|
|
101920
102678
|
text?: boolean;
|
|
101921
102679
|
/**
|
|
101922
|
-
* For EACH ITEM in the collection:
|
|
102680
|
+
* For EACH ITEM in the collection: Specifies the type of the tracked change.
|
|
101923
102681
|
*
|
|
101924
102682
|
* @remarks
|
|
101925
102683
|
* [Api set: WordApi 1.6]
|