@types/office-js-preview 1.0.443 → 1.0.445
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +199 -226
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -13656,7 +13656,7 @@ declare namespace Office {
|
|
|
13656
13656
|
*/
|
|
13657
13657
|
interface DisplayedBody {
|
|
13658
13658
|
/**
|
|
13659
|
-
* Temporarily sets the content displayed in the body of a message in read mode. The set content
|
|
13659
|
+
* Temporarily sets the content displayed in the body of a message in read mode. The set content remains visible until the user switches to a different messsage or
|
|
13660
13660
|
* closes the window of the current message.
|
|
13661
13661
|
*
|
|
13662
13662
|
* @remarks
|
|
@@ -13670,6 +13670,17 @@ declare namespace Office {
|
|
|
13670
13670
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1) | Office.context.mailbox.item.body.getTypeAsync},
|
|
13671
13671
|
* then pass the returned value to the `options.coercionType` parameter.
|
|
13672
13672
|
*
|
|
13673
|
+
* **Important**:
|
|
13674
|
+
*
|
|
13675
|
+
* - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
|
|
13676
|
+
*
|
|
13677
|
+
* - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
|
|
13678
|
+
* Outlook clients.
|
|
13679
|
+
*
|
|
13680
|
+
* - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
|
|
13681
|
+
*
|
|
13682
|
+
* - The `setAsync` method isn't supported on multiple selected messages.
|
|
13683
|
+
*
|
|
13673
13684
|
* @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
|
|
13674
13685
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
13675
13686
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -13691,6 +13702,17 @@ declare namespace Office {
|
|
|
13691
13702
|
*
|
|
13692
13703
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
13693
13704
|
*
|
|
13705
|
+
* **Important**:
|
|
13706
|
+
*
|
|
13707
|
+
* - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the body.
|
|
13708
|
+
*
|
|
13709
|
+
* - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
|
|
13710
|
+
* Outlook clients.
|
|
13711
|
+
*
|
|
13712
|
+
* - If you save a message after calling `setAsync`, the original contents of the message body appear in the saved item.
|
|
13713
|
+
*
|
|
13714
|
+
* - The `setAsync` method isn't supported on multiple selected messages.
|
|
13715
|
+
*
|
|
13694
13716
|
* @param data - The string to be temporarily displayed in the body of a message. The string is limited to 1,000,000 characters.
|
|
13695
13717
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
13696
13718
|
* which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -13723,11 +13745,25 @@ declare namespace Office {
|
|
|
13723
13745
|
*
|
|
13724
13746
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
13725
13747
|
*
|
|
13748
|
+
* **Important**:
|
|
13749
|
+
*
|
|
13750
|
+
* - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
|
|
13751
|
+
* subject field.
|
|
13752
|
+
*
|
|
13753
|
+
* - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
|
|
13754
|
+
* Outlook clients.
|
|
13755
|
+
*
|
|
13756
|
+
* - If you save a message after calling `setAsync`, the original subject appears in the saved item.
|
|
13757
|
+
*
|
|
13758
|
+
* - The `setAsync` method isn't supported on multiple selected messages.
|
|
13759
|
+
*
|
|
13726
13760
|
* @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
|
|
13727
13761
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
13728
13762
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13729
13763
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
13730
13764
|
* which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
13765
|
+
*
|
|
13766
|
+
* @beta
|
|
13731
13767
|
*/
|
|
13732
13768
|
setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
13733
13769
|
/**
|
|
@@ -13741,9 +13777,23 @@ declare namespace Office {
|
|
|
13741
13777
|
*
|
|
13742
13778
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
13743
13779
|
*
|
|
13780
|
+
* **Important**:
|
|
13781
|
+
*
|
|
13782
|
+
* - If multiple add-ins that implement `setAsync` run simultaneously, the content set by the last add-in that completes the `setAsync` operation is displayed in the
|
|
13783
|
+
* subject field.
|
|
13784
|
+
*
|
|
13785
|
+
* - The content set by the `setAsync` method is only displayed while the user is viewing the item. It isn't cached in Outlook and doesn't sync with other
|
|
13786
|
+
* Outlook clients.
|
|
13787
|
+
*
|
|
13788
|
+
* - If you save a message after calling `setAsync`, the original subject appears in the saved item.
|
|
13789
|
+
*
|
|
13790
|
+
* - The `setAsync` method isn't supported on multiple selected messages.
|
|
13791
|
+
*
|
|
13744
13792
|
* @param data - The string to be temporarily displayed in the subject of a message. The string is limited to 255 characters.
|
|
13745
13793
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
13746
13794
|
* which is an `Office.AsyncResult` object. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
13795
|
+
*
|
|
13796
|
+
* @beta
|
|
13747
13797
|
*/
|
|
13748
13798
|
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
13749
13799
|
}
|
|
@@ -89248,43 +89298,37 @@ declare namespace Word {
|
|
|
89248
89298
|
* Represents the color scheme of a critique in the document, affecting underline and highlight.
|
|
89249
89299
|
*
|
|
89250
89300
|
* @remarks
|
|
89251
|
-
* [Api set: WordApi
|
|
89252
|
-
* @beta
|
|
89301
|
+
* [Api set: WordApi 1.7]
|
|
89253
89302
|
*/
|
|
89254
89303
|
enum CritiqueColorScheme {
|
|
89255
89304
|
/**
|
|
89256
89305
|
* Red color.
|
|
89257
89306
|
* @remarks
|
|
89258
|
-
* [Api set: WordApi
|
|
89259
|
-
* @beta
|
|
89307
|
+
* [Api set: WordApi 1.7]
|
|
89260
89308
|
*/
|
|
89261
89309
|
red = "Red",
|
|
89262
89310
|
/**
|
|
89263
89311
|
* Green color.
|
|
89264
89312
|
* @remarks
|
|
89265
|
-
* [Api set: WordApi
|
|
89266
|
-
* @beta
|
|
89313
|
+
* [Api set: WordApi 1.7]
|
|
89267
89314
|
*/
|
|
89268
89315
|
green = "Green",
|
|
89269
89316
|
/**
|
|
89270
89317
|
* Blue color.
|
|
89271
89318
|
* @remarks
|
|
89272
|
-
* [Api set: WordApi
|
|
89273
|
-
* @beta
|
|
89319
|
+
* [Api set: WordApi 1.7]
|
|
89274
89320
|
*/
|
|
89275
89321
|
blue = "Blue",
|
|
89276
89322
|
/**
|
|
89277
89323
|
* Lavender color.
|
|
89278
89324
|
* @remarks
|
|
89279
|
-
* [Api set: WordApi
|
|
89280
|
-
* @beta
|
|
89325
|
+
* [Api set: WordApi 1.7]
|
|
89281
89326
|
*/
|
|
89282
89327
|
lavender = "Lavender",
|
|
89283
89328
|
/**
|
|
89284
89329
|
* Berry color.
|
|
89285
89330
|
* @remarks
|
|
89286
|
-
* [Api set: WordApi
|
|
89287
|
-
* @beta
|
|
89331
|
+
* [Api set: WordApi 1.7]
|
|
89288
89332
|
*/
|
|
89289
89333
|
berry = "Berry",
|
|
89290
89334
|
}
|
|
@@ -89333,24 +89377,21 @@ declare namespace Word {
|
|
|
89333
89377
|
* Critique that will be rendered as underline for the specified part of paragraph in the document.
|
|
89334
89378
|
*
|
|
89335
89379
|
* @remarks
|
|
89336
|
-
* [Api set: WordApi
|
|
89337
|
-
* @beta
|
|
89380
|
+
* [Api set: WordApi 1.7]
|
|
89338
89381
|
*/
|
|
89339
89382
|
interface Critique {
|
|
89340
89383
|
/**
|
|
89341
89384
|
* Gets the color scheme of the critique.
|
|
89342
89385
|
*
|
|
89343
89386
|
* @remarks
|
|
89344
|
-
* [Api set: WordApi
|
|
89345
|
-
* @beta
|
|
89387
|
+
* [Api set: WordApi 1.7]
|
|
89346
89388
|
*/
|
|
89347
89389
|
colorScheme: Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry";
|
|
89348
89390
|
/**
|
|
89349
89391
|
* Gets the length of the critique inside paragraph.
|
|
89350
89392
|
*
|
|
89351
89393
|
* @remarks
|
|
89352
|
-
* [Api set: WordApi
|
|
89353
|
-
* @beta
|
|
89394
|
+
* [Api set: WordApi 1.7]
|
|
89354
89395
|
*/
|
|
89355
89396
|
length: number;
|
|
89356
89397
|
/**
|
|
@@ -89365,8 +89406,7 @@ declare namespace Word {
|
|
|
89365
89406
|
* Gets the start index of the critique inside paragraph.
|
|
89366
89407
|
*
|
|
89367
89408
|
* @remarks
|
|
89368
|
-
* [Api set: WordApi
|
|
89369
|
-
* @beta
|
|
89409
|
+
* [Api set: WordApi 1.7]
|
|
89370
89410
|
*/
|
|
89371
89411
|
start: number;
|
|
89372
89412
|
}
|
|
@@ -89374,8 +89414,7 @@ declare namespace Word {
|
|
|
89374
89414
|
* Represents an annotation wrapper around critique displayed in the document.
|
|
89375
89415
|
*
|
|
89376
89416
|
* @remarks
|
|
89377
|
-
* [Api set: WordApi
|
|
89378
|
-
* @beta
|
|
89417
|
+
* [Api set: WordApi 1.7]
|
|
89379
89418
|
*/
|
|
89380
89419
|
class CritiqueAnnotation extends OfficeExtension.ClientObject {
|
|
89381
89420
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -89384,32 +89423,28 @@ declare namespace Word {
|
|
|
89384
89423
|
* Gets the range of text that is annotated.
|
|
89385
89424
|
*
|
|
89386
89425
|
* @remarks
|
|
89387
|
-
* [Api set: WordApi
|
|
89388
|
-
* @beta
|
|
89426
|
+
* [Api set: WordApi 1.7]
|
|
89389
89427
|
*/
|
|
89390
89428
|
readonly range: Word.Range;
|
|
89391
89429
|
/**
|
|
89392
89430
|
* Gets the critique that was passed when the annotation was inserted.
|
|
89393
89431
|
*
|
|
89394
89432
|
* @remarks
|
|
89395
|
-
* [Api set: WordApi
|
|
89396
|
-
* @beta
|
|
89433
|
+
* [Api set: WordApi 1.7]
|
|
89397
89434
|
*/
|
|
89398
89435
|
readonly critique: Word.Critique;
|
|
89399
89436
|
/**
|
|
89400
89437
|
* Accepts the critique. This will change the annotation state to `accepted`.
|
|
89401
89438
|
*
|
|
89402
89439
|
* @remarks
|
|
89403
|
-
* [Api set: WordApi
|
|
89404
|
-
* @beta
|
|
89440
|
+
* [Api set: WordApi 1.7]
|
|
89405
89441
|
*/
|
|
89406
89442
|
accept(): void;
|
|
89407
89443
|
/**
|
|
89408
89444
|
* Rejects the critique. This will change the annotation state to `rejected`.
|
|
89409
89445
|
*
|
|
89410
89446
|
* @remarks
|
|
89411
|
-
* [Api set: WordApi
|
|
89412
|
-
* @beta
|
|
89447
|
+
* [Api set: WordApi 1.7]
|
|
89413
89448
|
*/
|
|
89414
89449
|
reject(): void;
|
|
89415
89450
|
/**
|
|
@@ -89438,7 +89473,7 @@ declare namespace Word {
|
|
|
89438
89473
|
*/
|
|
89439
89474
|
track(): Word.CritiqueAnnotation;
|
|
89440
89475
|
/**
|
|
89441
|
-
* 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
|
|
89476
|
+
* 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.
|
|
89442
89477
|
*/
|
|
89443
89478
|
untrack(): Word.CritiqueAnnotation;
|
|
89444
89479
|
/**
|
|
@@ -89451,29 +89486,25 @@ declare namespace Word {
|
|
|
89451
89486
|
* Represents the state of the annotation.
|
|
89452
89487
|
*
|
|
89453
89488
|
* @remarks
|
|
89454
|
-
* [Api set: WordApi
|
|
89455
|
-
* @beta
|
|
89489
|
+
* [Api set: WordApi 1.7]
|
|
89456
89490
|
*/
|
|
89457
89491
|
enum AnnotationState {
|
|
89458
89492
|
/**
|
|
89459
89493
|
* Created.
|
|
89460
89494
|
* @remarks
|
|
89461
|
-
* [Api set: WordApi
|
|
89462
|
-
* @beta
|
|
89495
|
+
* [Api set: WordApi 1.7]
|
|
89463
89496
|
*/
|
|
89464
89497
|
created = "Created",
|
|
89465
89498
|
/**
|
|
89466
89499
|
* Accepted.
|
|
89467
89500
|
* @remarks
|
|
89468
|
-
* [Api set: WordApi
|
|
89469
|
-
* @beta
|
|
89501
|
+
* [Api set: WordApi 1.7]
|
|
89470
89502
|
*/
|
|
89471
89503
|
accepted = "Accepted",
|
|
89472
89504
|
/**
|
|
89473
89505
|
* Rejected.
|
|
89474
89506
|
* @remarks
|
|
89475
|
-
* [Api set: WordApi
|
|
89476
|
-
* @beta
|
|
89507
|
+
* [Api set: WordApi 1.7]
|
|
89477
89508
|
*/
|
|
89478
89509
|
rejected = "Rejected",
|
|
89479
89510
|
}
|
|
@@ -89481,16 +89512,14 @@ declare namespace Word {
|
|
|
89481
89512
|
* Annotations set produced by the add-in. Currently supporting only critiques.
|
|
89482
89513
|
*
|
|
89483
89514
|
* @remarks
|
|
89484
|
-
* [Api set: WordApi
|
|
89485
|
-
* @beta
|
|
89515
|
+
* [Api set: WordApi 1.7]
|
|
89486
89516
|
*/
|
|
89487
89517
|
interface AnnotationSet {
|
|
89488
89518
|
/**
|
|
89489
89519
|
* Critiques.
|
|
89490
89520
|
*
|
|
89491
89521
|
* @remarks
|
|
89492
|
-
* [Api set: WordApi
|
|
89493
|
-
* @beta
|
|
89522
|
+
* [Api set: WordApi 1.7]
|
|
89494
89523
|
*/
|
|
89495
89524
|
critiques: Word.Critique[];
|
|
89496
89525
|
}
|
|
@@ -89498,8 +89527,7 @@ declare namespace Word {
|
|
|
89498
89527
|
* Represents an annotation attached to a paragraph.
|
|
89499
89528
|
*
|
|
89500
89529
|
* @remarks
|
|
89501
|
-
* [Api set: WordApi
|
|
89502
|
-
* @beta
|
|
89530
|
+
* [Api set: WordApi 1.7]
|
|
89503
89531
|
*/
|
|
89504
89532
|
class Annotation extends OfficeExtension.ClientObject {
|
|
89505
89533
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -89508,32 +89536,28 @@ declare namespace Word {
|
|
|
89508
89536
|
* Gets the critique annotation object.
|
|
89509
89537
|
*
|
|
89510
89538
|
* @remarks
|
|
89511
|
-
* [Api set: WordApi
|
|
89512
|
-
* @beta
|
|
89539
|
+
* [Api set: WordApi 1.7]
|
|
89513
89540
|
*/
|
|
89514
89541
|
readonly critiqueAnnotation: Word.CritiqueAnnotation;
|
|
89515
89542
|
/**
|
|
89516
89543
|
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
89517
89544
|
*
|
|
89518
89545
|
* @remarks
|
|
89519
|
-
* [Api set: WordApi
|
|
89520
|
-
* @beta
|
|
89546
|
+
* [Api set: WordApi 1.7]
|
|
89521
89547
|
*/
|
|
89522
89548
|
readonly id: string;
|
|
89523
89549
|
/**
|
|
89524
89550
|
* Gets the state of the annotation.
|
|
89525
89551
|
*
|
|
89526
89552
|
* @remarks
|
|
89527
|
-
* [Api set: WordApi
|
|
89528
|
-
* @beta
|
|
89553
|
+
* [Api set: WordApi 1.7]
|
|
89529
89554
|
*/
|
|
89530
89555
|
readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
89531
89556
|
/**
|
|
89532
89557
|
* Deletes the annotation.
|
|
89533
89558
|
*
|
|
89534
89559
|
* @remarks
|
|
89535
|
-
* [Api set: WordApi
|
|
89536
|
-
* @beta
|
|
89560
|
+
* [Api set: WordApi 1.7]
|
|
89537
89561
|
*/
|
|
89538
89562
|
delete(): void;
|
|
89539
89563
|
/**
|
|
@@ -89562,7 +89586,7 @@ declare namespace Word {
|
|
|
89562
89586
|
*/
|
|
89563
89587
|
track(): Word.Annotation;
|
|
89564
89588
|
/**
|
|
89565
|
-
* 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
|
|
89589
|
+
* 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.
|
|
89566
89590
|
*/
|
|
89567
89591
|
untrack(): Word.Annotation;
|
|
89568
89592
|
/**
|
|
@@ -89575,16 +89599,14 @@ declare namespace Word {
|
|
|
89575
89599
|
* Holds annotation information that is passed back on annotation added event.
|
|
89576
89600
|
*
|
|
89577
89601
|
* @remarks
|
|
89578
|
-
* [Api set: WordApi
|
|
89579
|
-
* @beta
|
|
89602
|
+
* [Api set: WordApi 1.7]
|
|
89580
89603
|
*/
|
|
89581
89604
|
interface AnnotationInsertedEventArgs {
|
|
89582
89605
|
/**
|
|
89583
89606
|
* Specifies the annotation IDs for which the event was fired.
|
|
89584
89607
|
*
|
|
89585
89608
|
* @remarks
|
|
89586
|
-
* [Api set: WordApi
|
|
89587
|
-
* @beta
|
|
89609
|
+
* [Api set: WordApi 1.7]
|
|
89588
89610
|
*/
|
|
89589
89611
|
ids: string[];
|
|
89590
89612
|
}
|
|
@@ -89592,16 +89614,14 @@ declare namespace Word {
|
|
|
89592
89614
|
* Holds annotation information that is passed back on annotation inserted event.
|
|
89593
89615
|
*
|
|
89594
89616
|
* @remarks
|
|
89595
|
-
* [Api set: WordApi
|
|
89596
|
-
* @beta
|
|
89617
|
+
* [Api set: WordApi 1.7]
|
|
89597
89618
|
*/
|
|
89598
89619
|
interface AnnotationClickedEventArgs {
|
|
89599
89620
|
/**
|
|
89600
89621
|
* Specifies the annotation ID for which the event was fired.
|
|
89601
89622
|
*
|
|
89602
89623
|
* @remarks
|
|
89603
|
-
* [Api set: WordApi
|
|
89604
|
-
* @beta
|
|
89624
|
+
* [Api set: WordApi 1.7]
|
|
89605
89625
|
*/
|
|
89606
89626
|
id: string;
|
|
89607
89627
|
}
|
|
@@ -89609,16 +89629,14 @@ declare namespace Word {
|
|
|
89609
89629
|
* Holds annotation information that is passed back on annotation removed event.
|
|
89610
89630
|
*
|
|
89611
89631
|
* @remarks
|
|
89612
|
-
* [Api set: WordApi
|
|
89613
|
-
* @beta
|
|
89632
|
+
* [Api set: WordApi 1.7]
|
|
89614
89633
|
*/
|
|
89615
89634
|
interface AnnotationRemovedEventArgs {
|
|
89616
89635
|
/**
|
|
89617
89636
|
* Specifies the annotation IDs for which the event was fired.
|
|
89618
89637
|
*
|
|
89619
89638
|
* @remarks
|
|
89620
|
-
* [Api set: WordApi
|
|
89621
|
-
* @beta
|
|
89639
|
+
* [Api set: WordApi 1.7]
|
|
89622
89640
|
*/
|
|
89623
89641
|
ids: string[];
|
|
89624
89642
|
}
|
|
@@ -89626,16 +89644,14 @@ declare namespace Word {
|
|
|
89626
89644
|
* Holds annotation information that is passed back on annotation hovered event.
|
|
89627
89645
|
*
|
|
89628
89646
|
* @remarks
|
|
89629
|
-
* [Api set: WordApi
|
|
89630
|
-
* @beta
|
|
89647
|
+
* [Api set: WordApi 1.7]
|
|
89631
89648
|
*/
|
|
89632
89649
|
interface AnnotationHoveredEventArgs {
|
|
89633
89650
|
/**
|
|
89634
89651
|
* Specifies the annotation ID for which the event was fired.
|
|
89635
89652
|
*
|
|
89636
89653
|
* @remarks
|
|
89637
|
-
* [Api set: WordApi
|
|
89638
|
-
* @beta
|
|
89654
|
+
* [Api set: WordApi 1.7]
|
|
89639
89655
|
*/
|
|
89640
89656
|
id: string;
|
|
89641
89657
|
}
|
|
@@ -89656,7 +89672,7 @@ declare namespace Word {
|
|
|
89656
89672
|
*/
|
|
89657
89673
|
action: string;
|
|
89658
89674
|
/**
|
|
89659
|
-
* Specifies the suggestion
|
|
89675
|
+
* Specifies the accepted suggestion (only populated when accepting a critique suggestion).
|
|
89660
89676
|
*
|
|
89661
89677
|
* @remarks
|
|
89662
89678
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -89676,8 +89692,7 @@ declare namespace Word {
|
|
|
89676
89692
|
* Contains a collection of {@link Word.Annotation} objects.
|
|
89677
89693
|
*
|
|
89678
89694
|
* @remarks
|
|
89679
|
-
* [Api set: WordApi
|
|
89680
|
-
* @beta
|
|
89695
|
+
* [Api set: WordApi 1.7]
|
|
89681
89696
|
*/
|
|
89682
89697
|
class AnnotationCollection extends OfficeExtension.ClientObject {
|
|
89683
89698
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -89688,8 +89703,7 @@ declare namespace Word {
|
|
|
89688
89703
|
* Gets the first annotation in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
89689
89704
|
*
|
|
89690
89705
|
* @remarks
|
|
89691
|
-
* [Api set: WordApi
|
|
89692
|
-
* @beta
|
|
89706
|
+
* [Api set: WordApi 1.7]
|
|
89693
89707
|
*/
|
|
89694
89708
|
getFirst(): Word.Annotation;
|
|
89695
89709
|
/**
|
|
@@ -89698,8 +89712,7 @@ declare namespace Word {
|
|
|
89698
89712
|
see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
89699
89713
|
*
|
|
89700
89714
|
* @remarks
|
|
89701
|
-
* [Api set: WordApi
|
|
89702
|
-
* @beta
|
|
89715
|
+
* [Api set: WordApi 1.7]
|
|
89703
89716
|
*/
|
|
89704
89717
|
getFirstOrNullObject(): Word.Annotation;
|
|
89705
89718
|
/**
|
|
@@ -89725,7 +89738,7 @@ declare namespace Word {
|
|
|
89725
89738
|
*/
|
|
89726
89739
|
track(): Word.AnnotationCollection;
|
|
89727
89740
|
/**
|
|
89728
|
-
* 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
|
|
89741
|
+
* 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.
|
|
89729
89742
|
*/
|
|
89730
89743
|
untrack(): Word.AnnotationCollection;
|
|
89731
89744
|
/**
|
|
@@ -90032,7 +90045,7 @@ declare namespace Word {
|
|
|
90032
90045
|
* @remarks
|
|
90033
90046
|
* [Api set: WordApi 1.1]
|
|
90034
90047
|
*
|
|
90035
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support
|
|
90048
|
+
* 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.
|
|
90036
90049
|
*
|
|
90037
90050
|
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
90038
90051
|
*/
|
|
@@ -90223,7 +90236,7 @@ declare namespace Word {
|
|
|
90223
90236
|
*/
|
|
90224
90237
|
track(): Word.Body;
|
|
90225
90238
|
/**
|
|
90226
|
-
* 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
|
|
90239
|
+
* 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.
|
|
90227
90240
|
*/
|
|
90228
90241
|
untrack(): Word.Body;
|
|
90229
90242
|
/**
|
|
@@ -90316,7 +90329,7 @@ declare namespace Word {
|
|
|
90316
90329
|
*/
|
|
90317
90330
|
track(): Word.Border;
|
|
90318
90331
|
/**
|
|
90319
|
-
* 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
|
|
90332
|
+
* 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.
|
|
90320
90333
|
*/
|
|
90321
90334
|
untrack(): Word.Border;
|
|
90322
90335
|
/**
|
|
@@ -90442,7 +90455,7 @@ declare namespace Word {
|
|
|
90442
90455
|
*/
|
|
90443
90456
|
track(): Word.BorderCollection;
|
|
90444
90457
|
/**
|
|
90445
|
-
* 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
|
|
90458
|
+
* 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.
|
|
90446
90459
|
*/
|
|
90447
90460
|
untrack(): Word.BorderCollection;
|
|
90448
90461
|
/**
|
|
@@ -90455,8 +90468,7 @@ declare namespace Word {
|
|
|
90455
90468
|
* The data specific to content controls of type CheckBox.
|
|
90456
90469
|
*
|
|
90457
90470
|
* @remarks
|
|
90458
|
-
* [Api set: WordApi
|
|
90459
|
-
* @beta
|
|
90471
|
+
* [Api set: WordApi 1.7]
|
|
90460
90472
|
*/
|
|
90461
90473
|
class CheckboxContentControl extends OfficeExtension.ClientObject {
|
|
90462
90474
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -90465,8 +90477,7 @@ declare namespace Word {
|
|
|
90465
90477
|
* Specifies the current state of the checkbox.
|
|
90466
90478
|
*
|
|
90467
90479
|
* @remarks
|
|
90468
|
-
* [Api set: WordApi
|
|
90469
|
-
* @beta
|
|
90480
|
+
* [Api set: WordApi 1.7]
|
|
90470
90481
|
*/
|
|
90471
90482
|
isChecked: boolean;
|
|
90472
90483
|
/**
|
|
@@ -90503,7 +90514,7 @@ declare namespace Word {
|
|
|
90503
90514
|
*/
|
|
90504
90515
|
track(): Word.CheckboxContentControl;
|
|
90505
90516
|
/**
|
|
90506
|
-
* 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
|
|
90517
|
+
* 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.
|
|
90507
90518
|
*/
|
|
90508
90519
|
untrack(): Word.CheckboxContentControl;
|
|
90509
90520
|
/**
|
|
@@ -90634,7 +90645,7 @@ declare namespace Word {
|
|
|
90634
90645
|
*/
|
|
90635
90646
|
track(): Word.Comment;
|
|
90636
90647
|
/**
|
|
90637
|
-
* 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
|
|
90648
|
+
* 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.
|
|
90638
90649
|
*/
|
|
90639
90650
|
untrack(): Word.Comment;
|
|
90640
90651
|
/**
|
|
@@ -90691,7 +90702,7 @@ declare namespace Word {
|
|
|
90691
90702
|
*/
|
|
90692
90703
|
track(): Word.CommentCollection;
|
|
90693
90704
|
/**
|
|
90694
|
-
* 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
|
|
90705
|
+
* 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.
|
|
90695
90706
|
*/
|
|
90696
90707
|
untrack(): Word.CommentCollection;
|
|
90697
90708
|
/**
|
|
@@ -90800,7 +90811,7 @@ declare namespace Word {
|
|
|
90800
90811
|
*/
|
|
90801
90812
|
track(): Word.CommentContentRange;
|
|
90802
90813
|
/**
|
|
90803
|
-
* 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
|
|
90814
|
+
* 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.
|
|
90804
90815
|
*/
|
|
90805
90816
|
untrack(): Word.CommentContentRange;
|
|
90806
90817
|
/**
|
|
@@ -90908,7 +90919,7 @@ declare namespace Word {
|
|
|
90908
90919
|
*/
|
|
90909
90920
|
track(): Word.CommentReply;
|
|
90910
90921
|
/**
|
|
90911
|
-
* 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
|
|
90922
|
+
* 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.
|
|
90912
90923
|
*/
|
|
90913
90924
|
untrack(): Word.CommentReply;
|
|
90914
90925
|
/**
|
|
@@ -90965,7 +90976,7 @@ declare namespace Word {
|
|
|
90965
90976
|
*/
|
|
90966
90977
|
track(): Word.CommentReplyCollection;
|
|
90967
90978
|
/**
|
|
90968
|
-
* 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
|
|
90979
|
+
* 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.
|
|
90969
90980
|
*/
|
|
90970
90981
|
untrack(): Word.CommentReplyCollection;
|
|
90971
90982
|
/**
|
|
@@ -90987,8 +90998,7 @@ declare namespace Word {
|
|
|
90987
90998
|
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
90988
90999
|
*
|
|
90989
91000
|
* @remarks
|
|
90990
|
-
* [Api set: WordApi
|
|
90991
|
-
* @beta
|
|
91001
|
+
* [Api set: WordApi 1.7]
|
|
90992
91002
|
*/
|
|
90993
91003
|
readonly checkboxContentControl: Word.CheckboxContentControl;
|
|
90994
91004
|
/**
|
|
@@ -91550,7 +91560,7 @@ declare namespace Word {
|
|
|
91550
91560
|
*/
|
|
91551
91561
|
track(): Word.ContentControl;
|
|
91552
91562
|
/**
|
|
91553
|
-
* 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
|
|
91563
|
+
* 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.
|
|
91554
91564
|
*/
|
|
91555
91565
|
untrack(): Word.ContentControl;
|
|
91556
91566
|
/**
|
|
@@ -91670,7 +91680,7 @@ declare namespace Word {
|
|
|
91670
91680
|
*/
|
|
91671
91681
|
track(): Word.ContentControlCollection;
|
|
91672
91682
|
/**
|
|
91673
|
-
* 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
|
|
91683
|
+
* 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.
|
|
91674
91684
|
*/
|
|
91675
91685
|
untrack(): Word.ContentControlCollection;
|
|
91676
91686
|
/**
|
|
@@ -91691,7 +91701,8 @@ declare namespace Word {
|
|
|
91691
91701
|
*
|
|
91692
91702
|
* @remarks
|
|
91693
91703
|
* [Api set: WordApi 1.5]
|
|
91694
|
-
*
|
|
91704
|
+
*
|
|
91705
|
+
* Note: `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
|
|
91695
91706
|
*/
|
|
91696
91707
|
types: Word.ContentControlType[];
|
|
91697
91708
|
}
|
|
@@ -91766,13 +91777,13 @@ declare namespace Word {
|
|
|
91766
91777
|
*/
|
|
91767
91778
|
track(): Word.CustomProperty;
|
|
91768
91779
|
/**
|
|
91769
|
-
* 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
|
|
91780
|
+
* 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.
|
|
91770
91781
|
*/
|
|
91771
91782
|
untrack(): Word.CustomProperty;
|
|
91772
91783
|
/**
|
|
91773
|
-
|
|
91774
|
-
|
|
91775
|
-
|
|
91784
|
+
* 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.)
|
|
91785
|
+
* Whereas the original Word.CustomProperty object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
|
|
91786
|
+
*/
|
|
91776
91787
|
toJSON(): Word.Interfaces.CustomPropertyData;
|
|
91777
91788
|
}
|
|
91778
91789
|
/**
|
|
@@ -91851,13 +91862,13 @@ declare namespace Word {
|
|
|
91851
91862
|
*/
|
|
91852
91863
|
track(): Word.CustomPropertyCollection;
|
|
91853
91864
|
/**
|
|
91854
|
-
* 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
|
|
91865
|
+
* 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.
|
|
91855
91866
|
*/
|
|
91856
91867
|
untrack(): Word.CustomPropertyCollection;
|
|
91857
91868
|
/**
|
|
91858
|
-
|
|
91859
|
-
|
|
91860
|
-
|
|
91869
|
+
* 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.)
|
|
91870
|
+
* Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
91871
|
+
*/
|
|
91861
91872
|
toJSON(): Word.Interfaces.CustomPropertyCollectionData;
|
|
91862
91873
|
}
|
|
91863
91874
|
/**
|
|
@@ -92130,7 +92141,7 @@ declare namespace Word {
|
|
|
92130
92141
|
*/
|
|
92131
92142
|
track(): Word.CustomXmlPart;
|
|
92132
92143
|
/**
|
|
92133
|
-
* 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
|
|
92144
|
+
* 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.
|
|
92134
92145
|
*/
|
|
92135
92146
|
untrack(): Word.CustomXmlPart;
|
|
92136
92147
|
/**
|
|
@@ -92216,7 +92227,7 @@ declare namespace Word {
|
|
|
92216
92227
|
*/
|
|
92217
92228
|
track(): Word.CustomXmlPartCollection;
|
|
92218
92229
|
/**
|
|
92219
|
-
* 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
|
|
92230
|
+
* 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.
|
|
92220
92231
|
*/
|
|
92221
92232
|
untrack(): Word.CustomXmlPartCollection;
|
|
92222
92233
|
/**
|
|
@@ -92298,7 +92309,7 @@ declare namespace Word {
|
|
|
92298
92309
|
*/
|
|
92299
92310
|
track(): Word.CustomXmlPartScopedCollection;
|
|
92300
92311
|
/**
|
|
92301
|
-
* 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
|
|
92312
|
+
* 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.
|
|
92302
92313
|
*/
|
|
92303
92314
|
untrack(): Word.CustomXmlPartScopedCollection;
|
|
92304
92315
|
/**
|
|
@@ -92442,8 +92453,7 @@ declare namespace Word {
|
|
|
92442
92453
|
* Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found.
|
|
92443
92454
|
*
|
|
92444
92455
|
* @remarks
|
|
92445
|
-
* [Api set: WordApi
|
|
92446
|
-
* @beta
|
|
92456
|
+
* [Api set: WordApi 1.7]
|
|
92447
92457
|
*
|
|
92448
92458
|
* @param id The ID of the annotation to get.
|
|
92449
92459
|
*/
|
|
@@ -92567,7 +92577,7 @@ declare namespace Word {
|
|
|
92567
92577
|
* Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
|
|
92568
92578
|
*
|
|
92569
92579
|
* @remarks
|
|
92570
|
-
* [Api set:
|
|
92580
|
+
* [Api set: WordApi 1.7]
|
|
92571
92581
|
*/
|
|
92572
92582
|
search(searchText: string, searchOptions?: Word.SearchOptions | {
|
|
92573
92583
|
ignorePunct?: boolean;
|
|
@@ -92603,30 +92613,27 @@ declare namespace Word {
|
|
|
92603
92613
|
* Occurs when the user clicks an annotation (or selects it using **Alt+Down**).
|
|
92604
92614
|
*
|
|
92605
92615
|
* @remarks
|
|
92606
|
-
* [Api set: WordApi
|
|
92616
|
+
* [Api set: WordApi 1.7]
|
|
92607
92617
|
*
|
|
92608
92618
|
* @eventproperty
|
|
92609
|
-
* @beta
|
|
92610
92619
|
*/
|
|
92611
92620
|
readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;
|
|
92612
92621
|
/**
|
|
92613
92622
|
* Occurs when the user hovers the cursor over an annotation.
|
|
92614
92623
|
*
|
|
92615
92624
|
* @remarks
|
|
92616
|
-
* [Api set: WordApi
|
|
92625
|
+
* [Api set: WordApi 1.7]
|
|
92617
92626
|
*
|
|
92618
92627
|
* @eventproperty
|
|
92619
|
-
* @beta
|
|
92620
92628
|
*/
|
|
92621
92629
|
readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;
|
|
92622
92630
|
/**
|
|
92623
92631
|
* Occurs when the user adds one or more annotations.
|
|
92624
92632
|
*
|
|
92625
92633
|
* @remarks
|
|
92626
|
-
* [Api set: WordApi
|
|
92634
|
+
* [Api set: WordApi 1.7]
|
|
92627
92635
|
*
|
|
92628
92636
|
* @eventproperty
|
|
92629
|
-
* @beta
|
|
92630
92637
|
*/
|
|
92631
92638
|
readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;
|
|
92632
92639
|
/**
|
|
@@ -92643,10 +92650,9 @@ declare namespace Word {
|
|
|
92643
92650
|
* Occurs when the user deletes one or more annotations.
|
|
92644
92651
|
*
|
|
92645
92652
|
* @remarks
|
|
92646
|
-
* [Api set: WordApi
|
|
92653
|
+
* [Api set: WordApi 1.7]
|
|
92647
92654
|
*
|
|
92648
92655
|
* @eventproperty
|
|
92649
|
-
* @beta
|
|
92650
92656
|
*/
|
|
92651
92657
|
readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;
|
|
92652
92658
|
/**
|
|
@@ -92690,7 +92696,7 @@ declare namespace Word {
|
|
|
92690
92696
|
*/
|
|
92691
92697
|
track(): Word.Document;
|
|
92692
92698
|
/**
|
|
92693
|
-
* 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
|
|
92699
|
+
* 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.
|
|
92694
92700
|
*/
|
|
92695
92701
|
untrack(): Word.Document;
|
|
92696
92702
|
/**
|
|
@@ -92903,7 +92909,7 @@ declare namespace Word {
|
|
|
92903
92909
|
*/
|
|
92904
92910
|
track(): Word.DocumentCreated;
|
|
92905
92911
|
/**
|
|
92906
|
-
* 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
|
|
92912
|
+
* 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.
|
|
92907
92913
|
*/
|
|
92908
92914
|
untrack(): Word.DocumentCreated;
|
|
92909
92915
|
/**
|
|
@@ -93081,7 +93087,7 @@ declare namespace Word {
|
|
|
93081
93087
|
*/
|
|
93082
93088
|
track(): Word.DocumentProperties;
|
|
93083
93089
|
/**
|
|
93084
|
-
* 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
|
|
93090
|
+
* 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.
|
|
93085
93091
|
*/
|
|
93086
93092
|
untrack(): Word.DocumentProperties;
|
|
93087
93093
|
/**
|
|
@@ -93282,7 +93288,7 @@ declare namespace Word {
|
|
|
93282
93288
|
*/
|
|
93283
93289
|
track(): Word.Field;
|
|
93284
93290
|
/**
|
|
93285
|
-
* 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
|
|
93291
|
+
* 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.
|
|
93286
93292
|
*/
|
|
93287
93293
|
untrack(): Word.Field;
|
|
93288
93294
|
/**
|
|
@@ -93350,7 +93356,7 @@ declare namespace Word {
|
|
|
93350
93356
|
*/
|
|
93351
93357
|
track(): Word.FieldCollection;
|
|
93352
93358
|
/**
|
|
93353
|
-
* 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
|
|
93359
|
+
* 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.
|
|
93354
93360
|
*/
|
|
93355
93361
|
untrack(): Word.FieldCollection;
|
|
93356
93362
|
/**
|
|
@@ -93487,7 +93493,7 @@ declare namespace Word {
|
|
|
93487
93493
|
*/
|
|
93488
93494
|
track(): Word.Font;
|
|
93489
93495
|
/**
|
|
93490
|
-
* 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
|
|
93496
|
+
* 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.
|
|
93491
93497
|
*/
|
|
93492
93498
|
untrack(): Word.Font;
|
|
93493
93499
|
/**
|
|
@@ -93772,7 +93778,7 @@ declare namespace Word {
|
|
|
93772
93778
|
*/
|
|
93773
93779
|
track(): Word.InlinePicture;
|
|
93774
93780
|
/**
|
|
93775
|
-
* 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
|
|
93781
|
+
* 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.
|
|
93776
93782
|
*/
|
|
93777
93783
|
untrack(): Word.InlinePicture;
|
|
93778
93784
|
/**
|
|
@@ -93829,7 +93835,7 @@ declare namespace Word {
|
|
|
93829
93835
|
*/
|
|
93830
93836
|
track(): Word.InlinePictureCollection;
|
|
93831
93837
|
/**
|
|
93832
|
-
* 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
|
|
93838
|
+
* 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.
|
|
93833
93839
|
*/
|
|
93834
93840
|
untrack(): Word.InlinePictureCollection;
|
|
93835
93841
|
/**
|
|
@@ -94058,7 +94064,7 @@ declare namespace Word {
|
|
|
94058
94064
|
*/
|
|
94059
94065
|
track(): Word.List;
|
|
94060
94066
|
/**
|
|
94061
|
-
* 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
|
|
94067
|
+
* 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.
|
|
94062
94068
|
*/
|
|
94063
94069
|
untrack(): Word.List;
|
|
94064
94070
|
/**
|
|
@@ -94142,7 +94148,7 @@ declare namespace Word {
|
|
|
94142
94148
|
*/
|
|
94143
94149
|
track(): Word.ListCollection;
|
|
94144
94150
|
/**
|
|
94145
|
-
* 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
|
|
94151
|
+
* 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.
|
|
94146
94152
|
*/
|
|
94147
94153
|
untrack(): Word.ListCollection;
|
|
94148
94154
|
/**
|
|
@@ -94242,7 +94248,7 @@ declare namespace Word {
|
|
|
94242
94248
|
*/
|
|
94243
94249
|
track(): Word.ListItem;
|
|
94244
94250
|
/**
|
|
94245
|
-
* 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
|
|
94251
|
+
* 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.
|
|
94246
94252
|
*/
|
|
94247
94253
|
untrack(): Word.ListItem;
|
|
94248
94254
|
/**
|
|
@@ -94383,7 +94389,7 @@ declare namespace Word {
|
|
|
94383
94389
|
*/
|
|
94384
94390
|
track(): Word.ListLevel;
|
|
94385
94391
|
/**
|
|
94386
|
-
* 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
|
|
94392
|
+
* 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.
|
|
94387
94393
|
*/
|
|
94388
94394
|
untrack(): Word.ListLevel;
|
|
94389
94395
|
/**
|
|
@@ -94443,7 +94449,7 @@ declare namespace Word {
|
|
|
94443
94449
|
*/
|
|
94444
94450
|
track(): Word.ListLevelCollection;
|
|
94445
94451
|
/**
|
|
94446
|
-
* 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
|
|
94452
|
+
* 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.
|
|
94447
94453
|
*/
|
|
94448
94454
|
untrack(): Word.ListLevelCollection;
|
|
94449
94455
|
/**
|
|
@@ -94512,7 +94518,7 @@ declare namespace Word {
|
|
|
94512
94518
|
*/
|
|
94513
94519
|
track(): Word.ListTemplate;
|
|
94514
94520
|
/**
|
|
94515
|
-
* 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
|
|
94521
|
+
* 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.
|
|
94516
94522
|
*/
|
|
94517
94523
|
untrack(): Word.ListTemplate;
|
|
94518
94524
|
/**
|
|
@@ -94606,7 +94612,7 @@ declare namespace Word {
|
|
|
94606
94612
|
*/
|
|
94607
94613
|
track(): Word.NoteItem;
|
|
94608
94614
|
/**
|
|
94609
|
-
* 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
|
|
94615
|
+
* 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.
|
|
94610
94616
|
*/
|
|
94611
94617
|
untrack(): Word.NoteItem;
|
|
94612
94618
|
/**
|
|
@@ -94663,7 +94669,7 @@ declare namespace Word {
|
|
|
94663
94669
|
*/
|
|
94664
94670
|
track(): Word.NoteItemCollection;
|
|
94665
94671
|
/**
|
|
94666
|
-
* 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
|
|
94672
|
+
* 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.
|
|
94667
94673
|
*/
|
|
94668
94674
|
untrack(): Word.NoteItemCollection;
|
|
94669
94675
|
/**
|
|
@@ -94962,8 +94968,7 @@ declare namespace Word {
|
|
|
94962
94968
|
* Gets annotations set on this Paragraph object.
|
|
94963
94969
|
*
|
|
94964
94970
|
* @remarks
|
|
94965
|
-
* [Api set: WordApi
|
|
94966
|
-
* @beta
|
|
94971
|
+
* [Api set: WordApi 1.7]
|
|
94967
94972
|
*/
|
|
94968
94973
|
getAnnotations(): Word.AnnotationCollection;
|
|
94969
94974
|
/**
|
|
@@ -95060,8 +95065,7 @@ declare namespace Word {
|
|
|
95060
95065
|
By default, hidden text and text marked as deleted are excluded.
|
|
95061
95066
|
*
|
|
95062
95067
|
* @remarks
|
|
95063
|
-
* [Api set: WordApi
|
|
95064
|
-
* @beta
|
|
95068
|
+
* [Api set: WordApi 1.7]
|
|
95065
95069
|
*
|
|
95066
95070
|
* @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted.
|
|
95067
95071
|
*/
|
|
@@ -95090,8 +95094,7 @@ declare namespace Word {
|
|
|
95090
95094
|
* Inserts annotations on this Paragraph object.
|
|
95091
95095
|
*
|
|
95092
95096
|
* @remarks
|
|
95093
|
-
* [Api set: WordApi
|
|
95094
|
-
* @beta
|
|
95097
|
+
* [Api set: WordApi 1.7]
|
|
95095
95098
|
*
|
|
95096
95099
|
* @param annotations Annotations to set.
|
|
95097
95100
|
* @returns An array of the inserted annotations identifiers.
|
|
@@ -95113,7 +95116,7 @@ declare namespace Word {
|
|
|
95113
95116
|
* @remarks
|
|
95114
95117
|
* [Api set: WordApi 1.1]
|
|
95115
95118
|
*
|
|
95116
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support
|
|
95119
|
+
* 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.
|
|
95117
95120
|
*
|
|
95118
95121
|
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
95119
95122
|
*/
|
|
@@ -95322,7 +95325,7 @@ declare namespace Word {
|
|
|
95322
95325
|
*/
|
|
95323
95326
|
track(): Word.Paragraph;
|
|
95324
95327
|
/**
|
|
95325
|
-
* 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
|
|
95328
|
+
* 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.
|
|
95326
95329
|
*/
|
|
95327
95330
|
untrack(): Word.Paragraph;
|
|
95328
95331
|
/**
|
|
@@ -95393,7 +95396,7 @@ declare namespace Word {
|
|
|
95393
95396
|
*/
|
|
95394
95397
|
track(): Word.ParagraphCollection;
|
|
95395
95398
|
/**
|
|
95396
|
-
* 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
|
|
95399
|
+
* 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.
|
|
95397
95400
|
*/
|
|
95398
95401
|
untrack(): Word.ParagraphCollection;
|
|
95399
95402
|
/**
|
|
@@ -95543,7 +95546,7 @@ declare namespace Word {
|
|
|
95543
95546
|
*/
|
|
95544
95547
|
track(): Word.ParagraphFormat;
|
|
95545
95548
|
/**
|
|
95546
|
-
* 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
|
|
95549
|
+
* 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.
|
|
95547
95550
|
*/
|
|
95548
95551
|
untrack(): Word.ParagraphFormat;
|
|
95549
95552
|
/**
|
|
@@ -95921,7 +95924,7 @@ declare namespace Word {
|
|
|
95921
95924
|
* @remarks
|
|
95922
95925
|
* [Api set: WordApi 1.1]
|
|
95923
95926
|
*
|
|
95924
|
-
* Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support
|
|
95927
|
+
* 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.
|
|
95925
95928
|
*
|
|
95926
95929
|
* @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
|
|
95927
95930
|
*/
|
|
@@ -96210,7 +96213,7 @@ declare namespace Word {
|
|
|
96210
96213
|
*/
|
|
96211
96214
|
track(): Word.Range;
|
|
96212
96215
|
/**
|
|
96213
|
-
* 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
|
|
96216
|
+
* 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.
|
|
96214
96217
|
*/
|
|
96215
96218
|
untrack(): Word.Range;
|
|
96216
96219
|
/**
|
|
@@ -96267,7 +96270,7 @@ declare namespace Word {
|
|
|
96267
96270
|
*/
|
|
96268
96271
|
track(): Word.RangeCollection;
|
|
96269
96272
|
/**
|
|
96270
|
-
* 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
|
|
96273
|
+
* 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.
|
|
96271
96274
|
*/
|
|
96272
96275
|
untrack(): Word.RangeCollection;
|
|
96273
96276
|
/**
|
|
@@ -96308,8 +96311,7 @@ declare namespace Word {
|
|
|
96308
96311
|
* Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.
|
|
96309
96312
|
*
|
|
96310
96313
|
* @remarks
|
|
96311
|
-
* [Api set: WordApi
|
|
96312
|
-
* @beta
|
|
96314
|
+
* [Api set: WordApi 1.7]
|
|
96313
96315
|
*/
|
|
96314
96316
|
importDifferentOddEvenPages?: boolean;
|
|
96315
96317
|
/**
|
|
@@ -96443,24 +96445,21 @@ declare namespace Word {
|
|
|
96443
96445
|
* Specifies the options to be included in a getText operation.
|
|
96444
96446
|
*
|
|
96445
96447
|
* @remarks
|
|
96446
|
-
* [Api set: WordApi
|
|
96447
|
-
* @beta
|
|
96448
|
+
* [Api set: WordApi 1.7]
|
|
96448
96449
|
*/
|
|
96449
96450
|
interface GetTextOptions {
|
|
96450
96451
|
/**
|
|
96451
96452
|
* Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False.
|
|
96452
96453
|
*
|
|
96453
96454
|
* @remarks
|
|
96454
|
-
* [Api set: WordApi
|
|
96455
|
-
* @beta
|
|
96455
|
+
* [Api set: WordApi 1.7]
|
|
96456
96456
|
*/
|
|
96457
96457
|
includeHiddenText?: boolean;
|
|
96458
96458
|
/**
|
|
96459
96459
|
* Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False.
|
|
96460
96460
|
*
|
|
96461
96461
|
* @remarks
|
|
96462
|
-
* [Api set: WordApi
|
|
96463
|
-
* @beta
|
|
96462
|
+
* [Api set: WordApi 1.7]
|
|
96464
96463
|
*/
|
|
96465
96464
|
includeTextMarkedAsDeleted?: boolean;
|
|
96466
96465
|
}
|
|
@@ -96630,7 +96629,7 @@ declare namespace Word {
|
|
|
96630
96629
|
*/
|
|
96631
96630
|
track(): Word.Section;
|
|
96632
96631
|
/**
|
|
96633
|
-
* 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
|
|
96632
|
+
* 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.
|
|
96634
96633
|
*/
|
|
96635
96634
|
untrack(): Word.Section;
|
|
96636
96635
|
/**
|
|
@@ -96687,7 +96686,7 @@ declare namespace Word {
|
|
|
96687
96686
|
*/
|
|
96688
96687
|
track(): Word.SectionCollection;
|
|
96689
96688
|
/**
|
|
96690
|
-
* 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
|
|
96689
|
+
* 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.
|
|
96691
96690
|
*/
|
|
96692
96691
|
untrack(): Word.SectionCollection;
|
|
96693
96692
|
/**
|
|
@@ -96760,7 +96759,7 @@ declare namespace Word {
|
|
|
96760
96759
|
*/
|
|
96761
96760
|
track(): Word.Setting;
|
|
96762
96761
|
/**
|
|
96763
|
-
* 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
|
|
96762
|
+
* 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.
|
|
96764
96763
|
*/
|
|
96765
96764
|
untrack(): Word.Setting;
|
|
96766
96765
|
/**
|
|
@@ -96845,7 +96844,7 @@ declare namespace Word {
|
|
|
96845
96844
|
*/
|
|
96846
96845
|
track(): Word.SettingCollection;
|
|
96847
96846
|
/**
|
|
96848
|
-
* 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
|
|
96847
|
+
* 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.
|
|
96849
96848
|
*/
|
|
96850
96849
|
untrack(): Word.SettingCollection;
|
|
96851
96850
|
/**
|
|
@@ -96922,7 +96921,7 @@ declare namespace Word {
|
|
|
96922
96921
|
*/
|
|
96923
96922
|
track(): Word.StyleCollection;
|
|
96924
96923
|
/**
|
|
96925
|
-
* 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
|
|
96924
|
+
* 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.
|
|
96926
96925
|
*/
|
|
96927
96926
|
untrack(): Word.StyleCollection;
|
|
96928
96927
|
/**
|
|
@@ -97114,7 +97113,7 @@ declare namespace Word {
|
|
|
97114
97113
|
*/
|
|
97115
97114
|
track(): Word.Style;
|
|
97116
97115
|
/**
|
|
97117
|
-
* 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
|
|
97116
|
+
* 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.
|
|
97118
97117
|
*/
|
|
97119
97118
|
untrack(): Word.Style;
|
|
97120
97119
|
/**
|
|
@@ -97189,7 +97188,7 @@ declare namespace Word {
|
|
|
97189
97188
|
*/
|
|
97190
97189
|
track(): Word.Shading;
|
|
97191
97190
|
/**
|
|
97192
|
-
* 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
|
|
97191
|
+
* 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.
|
|
97193
97192
|
*/
|
|
97194
97193
|
untrack(): Word.Shading;
|
|
97195
97194
|
/**
|
|
@@ -97725,7 +97724,7 @@ declare namespace Word {
|
|
|
97725
97724
|
*/
|
|
97726
97725
|
track(): Word.Table;
|
|
97727
97726
|
/**
|
|
97728
|
-
* 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
|
|
97727
|
+
* 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.
|
|
97729
97728
|
*/
|
|
97730
97729
|
untrack(): Word.Table;
|
|
97731
97730
|
/**
|
|
@@ -97828,7 +97827,7 @@ declare namespace Word {
|
|
|
97828
97827
|
*/
|
|
97829
97828
|
track(): Word.TableStyle;
|
|
97830
97829
|
/**
|
|
97831
|
-
* 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
|
|
97830
|
+
* 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.
|
|
97832
97831
|
*/
|
|
97833
97832
|
untrack(): Word.TableStyle;
|
|
97834
97833
|
/**
|
|
@@ -97885,7 +97884,7 @@ declare namespace Word {
|
|
|
97885
97884
|
*/
|
|
97886
97885
|
track(): Word.TableCollection;
|
|
97887
97886
|
/**
|
|
97888
|
-
* 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
|
|
97887
|
+
* 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.
|
|
97889
97888
|
*/
|
|
97890
97889
|
untrack(): Word.TableCollection;
|
|
97891
97890
|
/**
|
|
@@ -98181,7 +98180,7 @@ declare namespace Word {
|
|
|
98181
98180
|
*/
|
|
98182
98181
|
track(): Word.TableRow;
|
|
98183
98182
|
/**
|
|
98184
|
-
* 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
|
|
98183
|
+
* 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.
|
|
98185
98184
|
*/
|
|
98186
98185
|
untrack(): Word.TableRow;
|
|
98187
98186
|
/**
|
|
@@ -98238,7 +98237,7 @@ declare namespace Word {
|
|
|
98238
98237
|
*/
|
|
98239
98238
|
track(): Word.TableRowCollection;
|
|
98240
98239
|
/**
|
|
98241
|
-
* 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
|
|
98240
|
+
* 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.
|
|
98242
98241
|
*/
|
|
98243
98242
|
untrack(): Word.TableRowCollection;
|
|
98244
98243
|
/**
|
|
@@ -98483,7 +98482,7 @@ declare namespace Word {
|
|
|
98483
98482
|
*/
|
|
98484
98483
|
track(): Word.TableCell;
|
|
98485
98484
|
/**
|
|
98486
|
-
* 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
|
|
98485
|
+
* 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.
|
|
98487
98486
|
*/
|
|
98488
98487
|
untrack(): Word.TableCell;
|
|
98489
98488
|
/**
|
|
@@ -98540,7 +98539,7 @@ declare namespace Word {
|
|
|
98540
98539
|
*/
|
|
98541
98540
|
track(): Word.TableCellCollection;
|
|
98542
98541
|
/**
|
|
98543
|
-
* 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
|
|
98542
|
+
* 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.
|
|
98544
98543
|
*/
|
|
98545
98544
|
untrack(): Word.TableCellCollection;
|
|
98546
98545
|
/**
|
|
@@ -98613,7 +98612,7 @@ declare namespace Word {
|
|
|
98613
98612
|
*/
|
|
98614
98613
|
track(): Word.TableBorder;
|
|
98615
98614
|
/**
|
|
98616
|
-
* 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
|
|
98615
|
+
* 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.
|
|
98617
98616
|
*/
|
|
98618
98617
|
untrack(): Word.TableBorder;
|
|
98619
98618
|
/**
|
|
@@ -98720,7 +98719,7 @@ declare namespace Word {
|
|
|
98720
98719
|
*/
|
|
98721
98720
|
track(): Word.TrackedChange;
|
|
98722
98721
|
/**
|
|
98723
|
-
* 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
|
|
98722
|
+
* 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.
|
|
98724
98723
|
*/
|
|
98725
98724
|
untrack(): Word.TrackedChange;
|
|
98726
98725
|
/**
|
|
@@ -98791,7 +98790,7 @@ declare namespace Word {
|
|
|
98791
98790
|
*/
|
|
98792
98791
|
track(): Word.TrackedChangeCollection;
|
|
98793
98792
|
/**
|
|
98794
|
-
* 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
|
|
98793
|
+
* 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.
|
|
98795
98794
|
*/
|
|
98796
98795
|
untrack(): Word.TrackedChangeCollection;
|
|
98797
98796
|
/**
|
|
@@ -99021,29 +99020,25 @@ declare namespace Word {
|
|
|
99021
99020
|
/**
|
|
99022
99021
|
* Represents that an annotation was clicked (or selected with **Alt+Down**) in the document.
|
|
99023
99022
|
* @remarks
|
|
99024
|
-
* [Api set: WordApi
|
|
99025
|
-
* @beta
|
|
99023
|
+
* [Api set: WordApi 1.7]
|
|
99026
99024
|
*/
|
|
99027
99025
|
annotationClicked = "AnnotationClicked",
|
|
99028
99026
|
/**
|
|
99029
99027
|
* Represents that an annotation was hovered over in the document.
|
|
99030
99028
|
* @remarks
|
|
99031
|
-
* [Api set: WordApi
|
|
99032
|
-
* @beta
|
|
99029
|
+
* [Api set: WordApi 1.7]
|
|
99033
99030
|
*/
|
|
99034
99031
|
annotationHovered = "AnnotationHovered",
|
|
99035
99032
|
/**
|
|
99036
99033
|
* Represents that one or more annotations were added in the document.
|
|
99037
99034
|
* @remarks
|
|
99038
|
-
* [Api set: WordApi
|
|
99039
|
-
* @beta
|
|
99035
|
+
* [Api set: WordApi 1.7]
|
|
99040
99036
|
*/
|
|
99041
99037
|
annotationInserted = "AnnotationInserted",
|
|
99042
99038
|
/**
|
|
99043
99039
|
* Represents that one or more annotations were deleted from the document.
|
|
99044
99040
|
* @remarks
|
|
99045
|
-
* [Api set: WordApi
|
|
99046
|
-
* @beta
|
|
99041
|
+
* [Api set: WordApi 1.7]
|
|
99047
99042
|
*/
|
|
99048
99043
|
annotationRemoved = "AnnotationRemoved",
|
|
99049
99044
|
/**
|
|
@@ -102937,8 +102932,7 @@ declare namespace Word {
|
|
|
102937
102932
|
* Specifies the current state of the checkbox.
|
|
102938
102933
|
*
|
|
102939
102934
|
* @remarks
|
|
102940
|
-
* [Api set: WordApi
|
|
102941
|
-
* @beta
|
|
102935
|
+
* [Api set: WordApi 1.7]
|
|
102942
102936
|
*/
|
|
102943
102937
|
isChecked?: boolean;
|
|
102944
102938
|
}
|
|
@@ -103042,8 +103036,7 @@ declare namespace Word {
|
|
|
103042
103036
|
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
103043
103037
|
*
|
|
103044
103038
|
* @remarks
|
|
103045
|
-
* [Api set: WordApi
|
|
103046
|
-
* @beta
|
|
103039
|
+
* [Api set: WordApi 1.7]
|
|
103047
103040
|
*/
|
|
103048
103041
|
checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData;
|
|
103049
103042
|
/**
|
|
@@ -104331,8 +104324,7 @@ declare namespace Word {
|
|
|
104331
104324
|
* Gets the critique that was passed when the annotation was inserted.
|
|
104332
104325
|
*
|
|
104333
104326
|
* @remarks
|
|
104334
|
-
* [Api set: WordApi
|
|
104335
|
-
* @beta
|
|
104327
|
+
* [Api set: WordApi 1.7]
|
|
104336
104328
|
*/
|
|
104337
104329
|
critique?: Word.Critique;
|
|
104338
104330
|
}
|
|
@@ -104342,16 +104334,14 @@ declare namespace Word {
|
|
|
104342
104334
|
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
104343
104335
|
*
|
|
104344
104336
|
* @remarks
|
|
104345
|
-
* [Api set: WordApi
|
|
104346
|
-
* @beta
|
|
104337
|
+
* [Api set: WordApi 1.7]
|
|
104347
104338
|
*/
|
|
104348
104339
|
id?: string;
|
|
104349
104340
|
/**
|
|
104350
104341
|
* Gets the state of the annotation.
|
|
104351
104342
|
*
|
|
104352
104343
|
* @remarks
|
|
104353
|
-
* [Api set: WordApi
|
|
104354
|
-
* @beta
|
|
104344
|
+
* [Api set: WordApi 1.7]
|
|
104355
104345
|
*/
|
|
104356
104346
|
state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected";
|
|
104357
104347
|
}
|
|
@@ -104494,8 +104484,7 @@ declare namespace Word {
|
|
|
104494
104484
|
* Specifies the current state of the checkbox.
|
|
104495
104485
|
*
|
|
104496
104486
|
* @remarks
|
|
104497
|
-
* [Api set: WordApi
|
|
104498
|
-
* @beta
|
|
104487
|
+
* [Api set: WordApi 1.7]
|
|
104499
104488
|
*/
|
|
104500
104489
|
isChecked?: boolean;
|
|
104501
104490
|
}
|
|
@@ -104676,8 +104665,7 @@ declare namespace Word {
|
|
|
104676
104665
|
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
104677
104666
|
*
|
|
104678
104667
|
* @remarks
|
|
104679
|
-
* [Api set: WordApi
|
|
104680
|
-
* @beta
|
|
104668
|
+
* [Api set: WordApi 1.7]
|
|
104681
104669
|
*/
|
|
104682
104670
|
checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
|
|
104683
104671
|
/**
|
|
@@ -106537,8 +106525,7 @@ declare namespace Word {
|
|
|
106537
106525
|
* Represents an annotation wrapper around critique displayed in the document.
|
|
106538
106526
|
*
|
|
106539
106527
|
* @remarks
|
|
106540
|
-
* [Api set: WordApi
|
|
106541
|
-
* @beta
|
|
106528
|
+
* [Api set: WordApi 1.7]
|
|
106542
106529
|
*/
|
|
106543
106530
|
interface CritiqueAnnotationLoadOptions {
|
|
106544
106531
|
/**
|
|
@@ -106549,16 +106536,14 @@ declare namespace Word {
|
|
|
106549
106536
|
* Gets the range of text that is annotated.
|
|
106550
106537
|
*
|
|
106551
106538
|
* @remarks
|
|
106552
|
-
* [Api set: WordApi
|
|
106553
|
-
* @beta
|
|
106539
|
+
* [Api set: WordApi 1.7]
|
|
106554
106540
|
*/
|
|
106555
106541
|
range?: Word.Interfaces.RangeLoadOptions;
|
|
106556
106542
|
/**
|
|
106557
106543
|
* Gets the critique that was passed when the annotation was inserted.
|
|
106558
106544
|
*
|
|
106559
106545
|
* @remarks
|
|
106560
|
-
* [Api set: WordApi
|
|
106561
|
-
* @beta
|
|
106546
|
+
* [Api set: WordApi 1.7]
|
|
106562
106547
|
*/
|
|
106563
106548
|
critique?: boolean;
|
|
106564
106549
|
}
|
|
@@ -106566,8 +106551,7 @@ declare namespace Word {
|
|
|
106566
106551
|
* Represents an annotation attached to a paragraph.
|
|
106567
106552
|
*
|
|
106568
106553
|
* @remarks
|
|
106569
|
-
* [Api set: WordApi
|
|
106570
|
-
* @beta
|
|
106554
|
+
* [Api set: WordApi 1.7]
|
|
106571
106555
|
*/
|
|
106572
106556
|
interface AnnotationLoadOptions {
|
|
106573
106557
|
/**
|
|
@@ -106578,24 +106562,21 @@ declare namespace Word {
|
|
|
106578
106562
|
* Gets the critique annotation object.
|
|
106579
106563
|
*
|
|
106580
106564
|
* @remarks
|
|
106581
|
-
* [Api set: WordApi
|
|
106582
|
-
* @beta
|
|
106565
|
+
* [Api set: WordApi 1.7]
|
|
106583
106566
|
*/
|
|
106584
106567
|
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
106585
106568
|
/**
|
|
106586
106569
|
* Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
106587
106570
|
*
|
|
106588
106571
|
* @remarks
|
|
106589
|
-
* [Api set: WordApi
|
|
106590
|
-
* @beta
|
|
106572
|
+
* [Api set: WordApi 1.7]
|
|
106591
106573
|
*/
|
|
106592
106574
|
id?: boolean;
|
|
106593
106575
|
/**
|
|
106594
106576
|
* Gets the state of the annotation.
|
|
106595
106577
|
*
|
|
106596
106578
|
* @remarks
|
|
106597
|
-
* [Api set: WordApi
|
|
106598
|
-
* @beta
|
|
106579
|
+
* [Api set: WordApi 1.7]
|
|
106599
106580
|
*/
|
|
106600
106581
|
state?: boolean;
|
|
106601
106582
|
}
|
|
@@ -106603,8 +106584,7 @@ declare namespace Word {
|
|
|
106603
106584
|
* Contains a collection of {@link Word.Annotation} objects.
|
|
106604
106585
|
*
|
|
106605
106586
|
* @remarks
|
|
106606
|
-
* [Api set: WordApi
|
|
106607
|
-
* @beta
|
|
106587
|
+
* [Api set: WordApi 1.7]
|
|
106608
106588
|
*/
|
|
106609
106589
|
interface AnnotationCollectionLoadOptions {
|
|
106610
106590
|
/**
|
|
@@ -106615,24 +106595,21 @@ declare namespace Word {
|
|
|
106615
106595
|
* For EACH ITEM in the collection: Gets the critique annotation object.
|
|
106616
106596
|
*
|
|
106617
106597
|
* @remarks
|
|
106618
|
-
* [Api set: WordApi
|
|
106619
|
-
* @beta
|
|
106598
|
+
* [Api set: WordApi 1.7]
|
|
106620
106599
|
*/
|
|
106621
106600
|
critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
|
|
106622
106601
|
/**
|
|
106623
106602
|
* For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
|
|
106624
106603
|
*
|
|
106625
106604
|
* @remarks
|
|
106626
|
-
* [Api set: WordApi
|
|
106627
|
-
* @beta
|
|
106605
|
+
* [Api set: WordApi 1.7]
|
|
106628
106606
|
*/
|
|
106629
106607
|
id?: boolean;
|
|
106630
106608
|
/**
|
|
106631
106609
|
* For EACH ITEM in the collection: Gets the state of the annotation.
|
|
106632
106610
|
*
|
|
106633
106611
|
* @remarks
|
|
106634
|
-
* [Api set: WordApi
|
|
106635
|
-
* @beta
|
|
106612
|
+
* [Api set: WordApi 1.7]
|
|
106636
106613
|
*/
|
|
106637
106614
|
state?: boolean;
|
|
106638
106615
|
}
|
|
@@ -106835,8 +106812,7 @@ declare namespace Word {
|
|
|
106835
106812
|
* The data specific to content controls of type CheckBox.
|
|
106836
106813
|
*
|
|
106837
106814
|
* @remarks
|
|
106838
|
-
* [Api set: WordApi
|
|
106839
|
-
* @beta
|
|
106815
|
+
* [Api set: WordApi 1.7]
|
|
106840
106816
|
*/
|
|
106841
106817
|
interface CheckboxContentControlLoadOptions {
|
|
106842
106818
|
/**
|
|
@@ -106847,8 +106823,7 @@ declare namespace Word {
|
|
|
106847
106823
|
* Specifies the current state of the checkbox.
|
|
106848
106824
|
*
|
|
106849
106825
|
* @remarks
|
|
106850
|
-
* [Api set: WordApi
|
|
106851
|
-
* @beta
|
|
106826
|
+
* [Api set: WordApi 1.7]
|
|
106852
106827
|
*/
|
|
106853
106828
|
isChecked?: boolean;
|
|
106854
106829
|
}
|
|
@@ -107170,8 +107145,7 @@ declare namespace Word {
|
|
|
107170
107145
|
* Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
107171
107146
|
*
|
|
107172
107147
|
* @remarks
|
|
107173
|
-
* [Api set: WordApi
|
|
107174
|
-
* @beta
|
|
107148
|
+
* [Api set: WordApi 1.7]
|
|
107175
107149
|
*/
|
|
107176
107150
|
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
107177
107151
|
/**
|
|
@@ -107346,8 +107320,7 @@ declare namespace Word {
|
|
|
107346
107320
|
* For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
|
|
107347
107321
|
*
|
|
107348
107322
|
* @remarks
|
|
107349
|
-
* [Api set: WordApi
|
|
107350
|
-
* @beta
|
|
107323
|
+
* [Api set: WordApi 1.7]
|
|
107351
107324
|
*/
|
|
107352
107325
|
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
|
|
107353
107326
|
/**
|