@types/office-js-preview 1.0.294 → 1.0.297

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.
@@ -653,6 +653,7 @@ declare namespace Office {
653
653
 
654
654
  /**
655
655
  * Represents a modal notification dialog that can appear when the user attempts to close a document. The document won't close until the user responds.
656
+ * This API is only supported in Excel.
656
657
  *
657
658
  * @remarks
658
659
  * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
@@ -663,6 +664,7 @@ declare namespace Office {
663
664
  /**
664
665
  * Represents a modal notification dialog that can appear when the user attempts to close a document. The document won't close until the user responds.
665
666
  * The notification dialog will allow the user to confirm the request to close the document or cancel the request to close the document.
667
+ * This API is only supported in Excel.
666
668
  *
667
669
  * @remarks
668
670
  * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
@@ -672,6 +674,7 @@ declare namespace Office {
672
674
  /**
673
675
  * Enable a modal notification dialog that appears when the user attempts to close a document. The document won't close until the user responds.
674
676
  * This notification dialog asks the user to confirm the request to close the document, or allows the user to cancel the request to close the document.
677
+ * The `BeforeDocumentCloseNotification` API is only supported in Excel.
675
678
  *
676
679
  * @remarks
677
680
  * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
@@ -681,6 +684,7 @@ declare namespace Office {
681
684
 
682
685
  /**
683
686
  * Prevents the notification dialog from appearing when the user attempts to close a document.
687
+ * The `BeforeDocumentCloseNotification` API is only supported in Excel.
684
688
  *
685
689
  * @remarks
686
690
  * [Api set: SharedRuntime BETA (PREVIEW ONLY)]
@@ -693,6 +697,7 @@ declare namespace Office {
693
697
  * This event handler will be triggered if one of the following conditions is met:
694
698
  * 1. When the notification dialog is open, the end user clicks the **Don't close** button within the dialog, clicks the Close button in the upper right corner of the dialog, or presses the Esc key.
695
699
  * 2. When the add-in calls the `enable` method on the `BeforeDocumentCloseNotification` object.
700
+ * The `BeforeDocumentCloseNotification` API is only supported in Excel.
696
701
  * @param handler The event handler that is called when the dialog is cancelled.
697
702
  * @returns A promise that resolves when the event handler is added.
698
703
  *
@@ -8859,6 +8864,11 @@ declare namespace Office {
8859
8864
  * [Api set: Mailbox 1.1]
8860
8865
  *
8861
8866
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
8867
+ *
8868
+ * **Important**: A `recipientType` property value isn't returned by the
8869
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.from?view=outlook-js-preview#outlook-office-from-getasync-member(1) | Office.context.mailbox.item.from.getAsync}
8870
+ * and {@link https://docs.microsoft.com/javascript/api/outlook/office.organizer?view=outlook-js-preview#outlook-office-organizer-getasync-member(1) | Office.context.mailbox.item.organizer.getAsync} methods.
8871
+ * The email sender or appointment organizer is always a user whose email address is on the Exchange server.
8862
8872
  */
8863
8873
  enum RecipientType {
8864
8874
  /**
@@ -12957,6 +12967,12 @@ declare namespace Office {
12957
12967
  appointmentResponse: MailboxEnums.ResponseType | string;
12958
12968
  /**
12959
12969
  * Gets the email address type of a recipient.
12970
+ *
12971
+ * @remarks
12972
+ * **Important**: A `recipientType` property value isn't returned by the
12973
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.from?view=outlook-js-preview#outlook-office-from-getasync-member(1) | Office.context.mailbox.item.from.getAsync}
12974
+ * and {@link https://docs.microsoft.com/javascript/api/outlook/office.organizer?view=outlook-js-preview#outlook-office-organizer-getasync-member(1) | Office.context.mailbox.item.organizer.getAsync} methods.
12975
+ * The email sender or appointment organizer is always a user whose email address is on the Exchange server.
12960
12976
  */
12961
12977
  recipientType: MailboxEnums.RecipientType | string;
12962
12978
  }
@@ -13207,6 +13223,9 @@ declare namespace Office {
13207
13223
  *
13208
13224
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13209
13225
  *
13226
+ * **Important**: A `recipientType` property value isn't returned by the getAsync method.
13227
+ * The email sender is always a user whose email address is on the Exchange server.
13228
+ *
13210
13229
  * @param options - An object literal that contains one or more of the following properties.
13211
13230
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13212
13231
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -13227,6 +13246,9 @@ declare namespace Office {
13227
13246
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
13228
13247
  *
13229
13248
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13249
+ *
13250
+ * **Important**: A `recipientType` property value isn't returned by the getAsync methods.
13251
+ * The email sender is always a user whose email address is on the Exchange server.
13230
13252
  *
13231
13253
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13232
13254
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -17331,6 +17353,9 @@ declare namespace Office {
17331
17353
  *
17332
17354
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17333
17355
  *
17356
+ * **Important**: A `recipientType` property value isn't returned by the getAsync method.
17357
+ * The appointment organizer is always a user whose email address is on the Exchange server.
17358
+ *
17334
17359
  * @param options - An object literal that contains one or more of the following properties.
17335
17360
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17336
17361
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -17348,6 +17373,9 @@ declare namespace Office {
17348
17373
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
17349
17374
  *
17350
17375
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17376
+ *
17377
+ * **Important**: A `recipientType` property value isn't returned by the getAsync method.
17378
+ * The appointment organizer is always a user whose email address is on the Exchange server.
17351
17379
  *
17352
17380
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17353
17381
  * `asyncResult`, which is an `AsyncResult` object. The `value` property of the result is the appointment's organizer value,
@@ -83312,6 +83340,14 @@ declare namespace Word {
83312
83340
  * @beta
83313
83341
  */
83314
83342
  readonly endnotes: Word.NoteItemCollection;
83343
+ /**
83344
+ * Gets the collection of field objects in the body. Read-only.
83345
+ *
83346
+ * @remarks
83347
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83348
+ * @beta
83349
+ */
83350
+ readonly fields: Word.FieldCollection;
83315
83351
  /**
83316
83352
  * Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
83317
83353
  *
@@ -83468,7 +83504,7 @@ declare namespace Word {
83468
83504
  * @remarks
83469
83505
  * [Api set: WordApi 1.3]
83470
83506
  *
83471
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
83507
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83472
83508
  */
83473
83509
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
83474
83510
  /**
@@ -83477,7 +83513,7 @@ declare namespace Word {
83477
83513
  * @remarks
83478
83514
  * [Api set: WordApi 1.3]
83479
83515
  *
83480
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
83516
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83481
83517
  */
83482
83518
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
83483
83519
  /**
@@ -83487,7 +83523,7 @@ declare namespace Word {
83487
83523
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83488
83524
  * @beta
83489
83525
  *
83490
- * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
83526
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
83491
83527
  */
83492
83528
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
83493
83529
  /**
@@ -83497,7 +83533,7 @@ declare namespace Word {
83497
83533
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83498
83534
  * @beta
83499
83535
  *
83500
- * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
83536
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
83501
83537
  */
83502
83538
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
83503
83539
  /**
@@ -83507,7 +83543,7 @@ declare namespace Word {
83507
83543
  * [Api set: WordApi 1.1]
83508
83544
  *
83509
83545
  * @param breakType Required. The break type to add to the body.
83510
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83546
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83511
83547
  */
83512
83548
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
83513
83549
  /**
@@ -83517,7 +83553,7 @@ declare namespace Word {
83517
83553
  * [Api set: WordApi 1.1]
83518
83554
  *
83519
83555
  * @param breakType Required. The break type to add to the body.
83520
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83556
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83521
83557
  */
83522
83558
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
83523
83559
  /**
@@ -83534,7 +83570,7 @@ declare namespace Word {
83534
83570
  * [Api set: WordApi 1.1]
83535
83571
  *
83536
83572
  * @param base64File Required. The base64 encoded content of a .docx file.
83537
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83573
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83538
83574
  */
83539
83575
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
83540
83576
  /**
@@ -83544,7 +83580,7 @@ declare namespace Word {
83544
83580
  * [Api set: WordApi 1.1]
83545
83581
  *
83546
83582
  * @param base64File Required. The base64 encoded content of a .docx file.
83547
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83583
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83548
83584
  */
83549
83585
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83550
83586
  /**
@@ -83554,7 +83590,7 @@ declare namespace Word {
83554
83590
  * [Api set: WordApi 1.1]
83555
83591
  *
83556
83592
  * @param html Required. The HTML to be inserted in the document.
83557
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83593
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83558
83594
  */
83559
83595
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
83560
83596
  /**
@@ -83564,7 +83600,7 @@ declare namespace Word {
83564
83600
  * [Api set: WordApi 1.1]
83565
83601
  *
83566
83602
  * @param html Required. The HTML to be inserted in the document.
83567
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83603
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83568
83604
  */
83569
83605
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83570
83606
  /**
@@ -83574,7 +83610,7 @@ declare namespace Word {
83574
83610
  * [Api set: WordApi 1.2]
83575
83611
  *
83576
83612
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83577
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83613
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83578
83614
  */
83579
83615
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
83580
83616
  /**
@@ -83584,7 +83620,7 @@ declare namespace Word {
83584
83620
  * [Api set: WordApi 1.2]
83585
83621
  *
83586
83622
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83587
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83623
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83588
83624
  */
83589
83625
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
83590
83626
  /**
@@ -83594,7 +83630,7 @@ declare namespace Word {
83594
83630
  * [Api set: WordApi 1.1]
83595
83631
  *
83596
83632
  * @param ooxml Required. The OOXML to be inserted.
83597
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83633
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83598
83634
  */
83599
83635
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
83600
83636
  /**
@@ -83604,7 +83640,7 @@ declare namespace Word {
83604
83640
  * [Api set: WordApi 1.1]
83605
83641
  *
83606
83642
  * @param ooxml Required. The OOXML to be inserted.
83607
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83643
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83608
83644
  */
83609
83645
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83610
83646
  /**
@@ -83614,7 +83650,7 @@ declare namespace Word {
83614
83650
  * [Api set: WordApi 1.1]
83615
83651
  *
83616
83652
  * @param paragraphText Required. The paragraph text to be inserted.
83617
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83653
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83618
83654
  */
83619
83655
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
83620
83656
  /**
@@ -83624,7 +83660,7 @@ declare namespace Word {
83624
83660
  * [Api set: WordApi 1.1]
83625
83661
  *
83626
83662
  * @param paragraphText Required. The paragraph text to be inserted.
83627
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83663
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83628
83664
  */
83629
83665
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
83630
83666
  /**
@@ -83635,7 +83671,7 @@ declare namespace Word {
83635
83671
  *
83636
83672
  * @param rowCount Required. The number of rows in the table.
83637
83673
  * @param columnCount Required. The number of columns in the table.
83638
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83674
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83639
83675
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
83640
83676
  */
83641
83677
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -83647,7 +83683,7 @@ declare namespace Word {
83647
83683
  *
83648
83684
  * @param rowCount Required. The number of rows in the table.
83649
83685
  * @param columnCount Required. The number of columns in the table.
83650
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83686
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83651
83687
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
83652
83688
  */
83653
83689
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -83658,7 +83694,7 @@ declare namespace Word {
83658
83694
  * [Api set: WordApi 1.1]
83659
83695
  *
83660
83696
  * @param text Required. Text to be inserted.
83661
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83697
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83662
83698
  */
83663
83699
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
83664
83700
  /**
@@ -83668,7 +83704,7 @@ declare namespace Word {
83668
83704
  * [Api set: WordApi 1.1]
83669
83705
  *
83670
83706
  * @param text Required. Text to be inserted.
83671
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83707
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83672
83708
  */
83673
83709
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83674
83710
  /**
@@ -83695,7 +83731,7 @@ declare namespace Word {
83695
83731
  * @remarks
83696
83732
  * [Api set: WordApi 1.1]
83697
83733
  *
83698
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
83734
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
83699
83735
  */
83700
83736
  select(selectionMode?: Word.SelectionMode): void;
83701
83737
  /**
@@ -83704,7 +83740,7 @@ declare namespace Word {
83704
83740
  * @remarks
83705
83741
  * [Api set: WordApi 1.1]
83706
83742
  *
83707
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
83743
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
83708
83744
  */
83709
83745
  select(selectionMode?: "Select" | "Start" | "End"): void;
83710
83746
  /**
@@ -83801,7 +83837,7 @@ declare namespace Word {
83801
83837
  */
83802
83838
  readonly creationDate: Date;
83803
83839
  /**
83804
- * ID
83840
+ * Gets the ID of the comment. Read-only.
83805
83841
  *
83806
83842
  * @remarks
83807
83843
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84035,7 +84071,7 @@ declare namespace Word {
84035
84071
  * @beta
84036
84072
  *
84037
84073
  * @param text Required. The text to be inserted in to the CommentContentRange.
84038
- * @param insertLocation Required. The value can be 'After', 'Before', 'Replace', 'Start', or 'End'.
84074
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
84039
84075
  */
84040
84076
  insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
84041
84077
  /**
@@ -84046,7 +84082,7 @@ declare namespace Word {
84046
84082
  * @beta
84047
84083
  *
84048
84084
  * @param text Required. The text to be inserted in to the CommentContentRange.
84049
- * @param insertLocation Required. The value can be 'After', 'Before', 'Replace', 'Start', or 'End'.
84085
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
84050
84086
  */
84051
84087
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
84052
84088
  /**
@@ -84143,7 +84179,7 @@ declare namespace Word {
84143
84179
  */
84144
84180
  readonly creationDate: Date;
84145
84181
  /**
84146
- * ID
84182
+ * Gets the ID of the comment reply. Read-only.
84147
84183
  *
84148
84184
  * @remarks
84149
84185
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84295,6 +84331,14 @@ declare namespace Word {
84295
84331
  * @beta
84296
84332
  */
84297
84333
  readonly endnotes: Word.NoteItemCollection;
84334
+ /**
84335
+ * Gets the collection of field objects in the contentcontrol. Read-only.
84336
+ *
84337
+ * @remarks
84338
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84339
+ * @beta
84340
+ */
84341
+ readonly fields: Word.FieldCollection;
84298
84342
  /**
84299
84343
  * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
84300
84344
  *
@@ -84325,7 +84369,7 @@ declare namespace Word {
84325
84369
  */
84326
84370
  readonly lists: Word.ListCollection;
84327
84371
  /**
84328
- * Get the collection of paragraph objects in the content control. Read-only. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
84372
+ * Gets the collection of paragraph objects in the content control. Read-only. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
84329
84373
  *
84330
84374
  * @remarks
84331
84375
  * [Api set: WordApi 1.1]
@@ -84424,7 +84468,6 @@ declare namespace Word {
84424
84468
  readonly id: number;
84425
84469
  /**
84426
84470
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
84427
- *
84428
84471
  * **Note**: The set operation for this property is not supported in Word on the web.
84429
84472
  *
84430
84473
  * @remarks
@@ -84539,7 +84582,7 @@ declare namespace Word {
84539
84582
  * @remarks
84540
84583
  * [Api set: WordApi 1.3]
84541
84584
  *
84542
- * @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84585
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84543
84586
  */
84544
84587
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
84545
84588
  /**
@@ -84548,7 +84591,7 @@ declare namespace Word {
84548
84591
  * @remarks
84549
84592
  * [Api set: WordApi 1.3]
84550
84593
  *
84551
- * @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84594
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84552
84595
  */
84553
84596
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
84554
84597
  /**
@@ -84558,7 +84601,7 @@ declare namespace Word {
84558
84601
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84559
84602
  * @beta
84560
84603
  *
84561
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
84604
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
84562
84605
  */
84563
84606
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
84564
84607
  /**
@@ -84568,7 +84611,7 @@ declare namespace Word {
84568
84611
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84569
84612
  * @beta
84570
84613
  *
84571
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
84614
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
84572
84615
  */
84573
84616
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
84574
84617
  /**
@@ -84588,7 +84631,7 @@ declare namespace Word {
84588
84631
  * [Api set: WordApi 1.1]
84589
84632
  *
84590
84633
  * @param breakType Required. Type of break.
84591
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
84634
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84592
84635
  */
84593
84636
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
84594
84637
  /**
@@ -84598,7 +84641,7 @@ declare namespace Word {
84598
84641
  * [Api set: WordApi 1.1]
84599
84642
  *
84600
84643
  * @param breakType Required. Type of break.
84601
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
84644
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84602
84645
  */
84603
84646
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
84604
84647
  /**
@@ -84608,7 +84651,7 @@ declare namespace Word {
84608
84651
  * [Api set: WordApi 1.1]
84609
84652
  *
84610
84653
  * @param base64File Required. The base64 encoded content of a .docx file.
84611
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84654
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84612
84655
  */
84613
84656
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
84614
84657
  /**
@@ -84618,7 +84661,7 @@ declare namespace Word {
84618
84661
  * [Api set: WordApi 1.1]
84619
84662
  *
84620
84663
  * @param base64File Required. The base64 encoded content of a .docx file.
84621
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84664
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84622
84665
  */
84623
84666
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84624
84667
  /**
@@ -84628,7 +84671,7 @@ declare namespace Word {
84628
84671
  * [Api set: WordApi 1.1]
84629
84672
  *
84630
84673
  * @param html Required. The HTML to be inserted in to the content control.
84631
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84674
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84632
84675
  */
84633
84676
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
84634
84677
  /**
@@ -84638,7 +84681,7 @@ declare namespace Word {
84638
84681
  * [Api set: WordApi 1.1]
84639
84682
  *
84640
84683
  * @param html Required. The HTML to be inserted in to the content control.
84641
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84684
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84642
84685
  */
84643
84686
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84644
84687
  /**
@@ -84648,7 +84691,7 @@ declare namespace Word {
84648
84691
  * [Api set: WordApi 1.2]
84649
84692
  *
84650
84693
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84651
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84694
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84652
84695
  */
84653
84696
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
84654
84697
  /**
@@ -84658,7 +84701,7 @@ declare namespace Word {
84658
84701
  * [Api set: WordApi 1.2]
84659
84702
  *
84660
84703
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84661
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84704
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84662
84705
  */
84663
84706
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
84664
84707
  /**
@@ -84668,7 +84711,7 @@ declare namespace Word {
84668
84711
  * [Api set: WordApi 1.1]
84669
84712
  *
84670
84713
  * @param ooxml Required. The OOXML to be inserted in to the content control.
84671
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84714
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84672
84715
  */
84673
84716
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
84674
84717
  /**
@@ -84678,7 +84721,7 @@ declare namespace Word {
84678
84721
  * [Api set: WordApi 1.1]
84679
84722
  *
84680
84723
  * @param ooxml Required. The OOXML to be inserted in to the content control.
84681
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84724
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84682
84725
  */
84683
84726
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84684
84727
  /**
@@ -84688,7 +84731,7 @@ declare namespace Word {
84688
84731
  * [Api set: WordApi 1.1]
84689
84732
  *
84690
84733
  * @param paragraphText Required. The paragraph text to be inserted.
84691
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84734
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84692
84735
  */
84693
84736
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
84694
84737
  /**
@@ -84698,7 +84741,7 @@ declare namespace Word {
84698
84741
  * [Api set: WordApi 1.1]
84699
84742
  *
84700
84743
  * @param paragraphText Required. The paragraph text to be inserted.
84701
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84744
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84702
84745
  */
84703
84746
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
84704
84747
  /**
@@ -84709,7 +84752,7 @@ declare namespace Word {
84709
84752
  *
84710
84753
  * @param rowCount Required. The number of rows in the table.
84711
84754
  * @param columnCount Required. The number of columns in the table.
84712
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84755
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84713
84756
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84714
84757
  */
84715
84758
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -84721,7 +84764,7 @@ declare namespace Word {
84721
84764
  *
84722
84765
  * @param rowCount Required. The number of rows in the table.
84723
84766
  * @param columnCount Required. The number of columns in the table.
84724
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84767
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
84725
84768
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84726
84769
  */
84727
84770
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -84732,7 +84775,7 @@ declare namespace Word {
84732
84775
  * [Api set: WordApi 1.1]
84733
84776
  *
84734
84777
  * @param text Required. The text to be inserted in to the content control.
84735
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84778
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84736
84779
  */
84737
84780
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
84738
84781
  /**
@@ -84742,7 +84785,7 @@ declare namespace Word {
84742
84785
  * [Api set: WordApi 1.1]
84743
84786
  *
84744
84787
  * @param text Required. The text to be inserted in to the content control.
84745
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84788
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84746
84789
  */
84747
84790
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84748
84791
  /**
@@ -84769,7 +84812,7 @@ declare namespace Word {
84769
84812
  * @remarks
84770
84813
  * [Api set: WordApi 1.1]
84771
84814
  *
84772
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
84815
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
84773
84816
  */
84774
84817
  select(selectionMode?: Word.SelectionMode): void;
84775
84818
  /**
@@ -84778,7 +84821,7 @@ declare namespace Word {
84778
84821
  * @remarks
84779
84822
  * [Api set: WordApi 1.1]
84780
84823
  *
84781
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
84824
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
84782
84825
  */
84783
84826
  select(selectionMode?: "Select" | "Start" | "End"): void;
84784
84827
  /**
@@ -85194,7 +85237,9 @@ declare namespace Word {
85194
85237
  * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that does not used reserved XPath characters, such as the forward slash "/".
85195
85238
  * @param name Required. Name of the attribute.
85196
85239
  */
85197
- deleteAttribute(xpath: string, namespaceMappings: any, name: string): void;
85240
+ deleteAttribute(xpath: string, namespaceMappings: {
85241
+ [key: string]: string;
85242
+ }, name: string): void;
85198
85243
  /**
85199
85244
  * Deletes the element identified by xpath.
85200
85245
  *
@@ -85220,7 +85265,9 @@ declare namespace Word {
85220
85265
  * @param xpath Required. Absolute path to the single element in XPath notation.
85221
85266
  * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that does not used reserved XPath characters, such as the forward slash "/".
85222
85267
  */
85223
- deleteElement(xpath: string, namespaceMappings: any): void;
85268
+ deleteElement(xpath: string, namespaceMappings: {
85269
+ [key: string]: string;
85270
+ }): void;
85224
85271
  /**
85225
85272
  * Gets the full XML content of the custom XML part.
85226
85273
  *
@@ -85256,7 +85303,9 @@ declare namespace Word {
85256
85303
  * @param name Required. Name of the attribute.
85257
85304
  * @param value Required. Value of the attribute.
85258
85305
  */
85259
- insertAttribute(xpath: string, namespaceMappings: any, name: string, value: string): void;
85306
+ insertAttribute(xpath: string, namespaceMappings: {
85307
+ [key: string]: string;
85308
+ }, name: string, value: string): void;
85260
85309
  /**
85261
85310
  * Inserts the given XML under the parent element identified by xpath at child position index.
85262
85311
  *
@@ -85284,7 +85333,9 @@ declare namespace Word {
85284
85333
  * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that does not used reserved XPath characters, such as the forward slash "/".
85285
85334
  * @param index Optional. Zero-based position at which the new XML to be inserted. If omitted, the XML will be appended as the last child of this parent.
85286
85335
  */
85287
- insertElement(xpath: string, xml: string, namespaceMappings: any, index?: number): void;
85336
+ insertElement(xpath: string, xml: string, namespaceMappings: {
85337
+ [key: string]: string;
85338
+ }, index?: number): void;
85288
85339
  /**
85289
85340
  * Queries the XML content of the custom XML part.
85290
85341
  *
@@ -85311,7 +85362,9 @@ declare namespace Word {
85311
85362
  * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that does not used reserved XPath characters, such as the forward slash "/".
85312
85363
  * @returns An array where each item represents an entry matched by the XPath query.
85313
85364
  */
85314
- query(xpath: string, namespaceMappings: any): OfficeExtension.ClientResult<string[]>;
85365
+ query(xpath: string, namespaceMappings: {
85366
+ [key: string]: string;
85367
+ }): OfficeExtension.ClientResult<string[]>;
85315
85368
  /**
85316
85369
  * Sets the full XML content of the custom XML part.
85317
85370
  *
@@ -85349,7 +85402,9 @@ declare namespace Word {
85349
85402
  * @param name Required. Name of the attribute.
85350
85403
  * @param value Required. New value of the attribute.
85351
85404
  */
85352
- updateAttribute(xpath: string, namespaceMappings: any, name: string, value: string): void;
85405
+ updateAttribute(xpath: string, namespaceMappings: {
85406
+ [key: string]: string;
85407
+ }, name: string, value: string): void;
85353
85408
  /**
85354
85409
  * Updates the XML of the element identified by xpath.
85355
85410
  *
@@ -85376,7 +85431,9 @@ declare namespace Word {
85376
85431
  * @param xml Required. New XML content to be stored.
85377
85432
  * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that does not used reserved XPath characters, such as the forward slash "/".
85378
85433
  */
85379
- updateElement(xpath: string, xml: string, namespaceMappings: any): void;
85434
+ updateElement(xpath: string, xml: string, namespaceMappings: {
85435
+ [key: string]: string;
85436
+ }): void;
85380
85437
  /**
85381
85438
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
85382
85439
  *
@@ -86116,6 +86173,215 @@ declare namespace Word {
86116
86173
  */
86117
86174
  toJSON(): Word.Interfaces.DocumentPropertiesData;
86118
86175
  }
86176
+ /**
86177
+ * Represents a field.
86178
+ *
86179
+ * @remarks
86180
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86181
+ * @beta
86182
+ */
86183
+ class Field extends OfficeExtension.ClientObject {
86184
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86185
+ context: RequestContext;
86186
+ /**
86187
+ * Gets the parent body of the field. Read-only.
86188
+ *
86189
+ * @remarks
86190
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86191
+ * @beta
86192
+ */
86193
+ readonly parentBody: Word.Body;
86194
+ /**
86195
+ * Gets the content control that contains the field. Throws an error if there isn't a parent content control. Read-only.
86196
+ *
86197
+ * @remarks
86198
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86199
+ * @beta
86200
+ */
86201
+ readonly parentContentControl: Word.ContentControl;
86202
+ /**
86203
+ * Gets the content control that contains the field. Returns a null object if there isn't a parent content control. Read-only.
86204
+ *
86205
+ * @remarks
86206
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86207
+ * @beta
86208
+ */
86209
+ readonly parentContentControlOrNullObject: Word.ContentControl;
86210
+ /**
86211
+ * Gets the table that contains the field. Throws an error if it is not contained in a table. Read-only.
86212
+ *
86213
+ * @remarks
86214
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86215
+ * @beta
86216
+ */
86217
+ readonly parentTable: Word.Table;
86218
+ /**
86219
+ * Gets the table cell that contains the field. Throws an error if it is not contained in a table cell. Read-only.
86220
+ *
86221
+ * @remarks
86222
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86223
+ * @beta
86224
+ */
86225
+ readonly parentTableCell: Word.TableCell;
86226
+ /**
86227
+ * Gets the table cell that contains the field. Returns a null object if it is not contained in a table cell. Read-only.
86228
+ *
86229
+ * @remarks
86230
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86231
+ * @beta
86232
+ */
86233
+ readonly parentTableCellOrNullObject: Word.TableCell;
86234
+ /**
86235
+ * Gets the table that contains the field. Returns a null object if it is not contained in a table. Read-only.
86236
+ *
86237
+ * @remarks
86238
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86239
+ * @beta
86240
+ */
86241
+ readonly parentTableOrNullObject: Word.Table;
86242
+ /**
86243
+ * Gets the field's code instruction. Read-only.
86244
+ *
86245
+ * @remarks
86246
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86247
+ * @beta
86248
+ */
86249
+ readonly code: string;
86250
+ /**
86251
+ * Gets the field's result data. Read-only.
86252
+ *
86253
+ * @remarks
86254
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86255
+ * @beta
86256
+ */
86257
+ readonly result: string;
86258
+ /**
86259
+ * Deletes the field.
86260
+ *
86261
+ * @remarks
86262
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86263
+ * @beta
86264
+ */
86265
+ delete(): void;
86266
+ /**
86267
+ * Gets the next field. Throws an error if this field is the last one.
86268
+ *
86269
+ * @remarks
86270
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86271
+ * @beta
86272
+ */
86273
+ getNext(): Word.Field;
86274
+ /**
86275
+ * Gets the next field. Returns a null object if this field is the last one.
86276
+ *
86277
+ * @remarks
86278
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86279
+ * @beta
86280
+ */
86281
+ getNextOrNullObject(): Word.Field;
86282
+ /**
86283
+ * Gets the whole field as a range.
86284
+ *
86285
+ * @remarks
86286
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86287
+ * @beta
86288
+ */
86289
+ getRange(): Word.Range;
86290
+ /**
86291
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86292
+ *
86293
+ * @param options Provides options for which properties of the object to load.
86294
+ */
86295
+ load(options?: Word.Interfaces.FieldLoadOptions): Word.Field;
86296
+ /**
86297
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86298
+ *
86299
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86300
+ */
86301
+ load(propertyNames?: string | string[]): Word.Field;
86302
+ /**
86303
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86304
+ *
86305
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
86306
+ */
86307
+ load(propertyNamesAndPaths?: {
86308
+ select?: string;
86309
+ expand?: string;
86310
+ }): Word.Field;
86311
+ /**
86312
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
86313
+ */
86314
+ track(): Word.Field;
86315
+ /**
86316
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
86317
+ */
86318
+ untrack(): Word.Field;
86319
+ /**
86320
+ * 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.)
86321
+ * Whereas the original Word.Field object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object.
86322
+ */
86323
+ toJSON(): Word.Interfaces.FieldData;
86324
+ }
86325
+ /**
86326
+ * Contains a collection of {@link Word.Field} objects.
86327
+ *
86328
+ * @remarks
86329
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86330
+ * @beta
86331
+ */
86332
+ class FieldCollection extends OfficeExtension.ClientObject {
86333
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86334
+ context: RequestContext;
86335
+ /** Gets the loaded child items in this collection. */
86336
+ readonly items: Word.Field[];
86337
+ /**
86338
+ * Gets the first field in this collection. Throws an error if this collection is empty.
86339
+ *
86340
+ * @remarks
86341
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86342
+ * @beta
86343
+ */
86344
+ getFirst(): Word.Field;
86345
+ /**
86346
+ * Gets the first field in this collection. Returns a null object if this collection is empty.
86347
+ *
86348
+ * @remarks
86349
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86350
+ * @beta
86351
+ */
86352
+ getFirstOrNullObject(): Word.Field;
86353
+ /**
86354
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86355
+ *
86356
+ * @param options Provides options for which properties of the object to load.
86357
+ */
86358
+ load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection;
86359
+ /**
86360
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86361
+ *
86362
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86363
+ */
86364
+ load(propertyNames?: string | string[]): Word.FieldCollection;
86365
+ /**
86366
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86367
+ *
86368
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
86369
+ */
86370
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection;
86371
+ /**
86372
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
86373
+ */
86374
+ track(): Word.FieldCollection;
86375
+ /**
86376
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `context.trackedObjects.remove(thisObject)`. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
86377
+ */
86378
+ untrack(): Word.FieldCollection;
86379
+ /**
86380
+ * 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.)
86381
+ * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86382
+ */
86383
+ toJSON(): Word.Interfaces.FieldCollectionData;
86384
+ }
86119
86385
  /**
86120
86386
  * Represents a font.
86121
86387
  *
@@ -86148,7 +86414,7 @@ declare namespace Word {
86148
86414
  doubleStrikeThrough: boolean;
86149
86415
  /**
86150
86416
  * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color.
86151
- **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
86417
+ * **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
86152
86418
  *
86153
86419
  * @remarks
86154
86420
  * [Api set: WordApi 1.1]
@@ -86396,7 +86662,7 @@ declare namespace Word {
86396
86662
  * @remarks
86397
86663
  * [Api set: WordApi 1.3]
86398
86664
  *
86399
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', or 'End'.
86665
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86400
86666
  */
86401
86667
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
86402
86668
  /**
@@ -86405,7 +86671,7 @@ declare namespace Word {
86405
86671
  * @remarks
86406
86672
  * [Api set: WordApi 1.3]
86407
86673
  *
86408
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', or 'End'.
86674
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86409
86675
  */
86410
86676
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
86411
86677
  /**
@@ -86415,7 +86681,7 @@ declare namespace Word {
86415
86681
  * [Api set: WordApi 1.2]
86416
86682
  *
86417
86683
  * @param breakType Required. The break type to add.
86418
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86684
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86419
86685
  */
86420
86686
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
86421
86687
  /**
@@ -86425,7 +86691,7 @@ declare namespace Word {
86425
86691
  * [Api set: WordApi 1.2]
86426
86692
  *
86427
86693
  * @param breakType Required. The break type to add.
86428
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86694
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86429
86695
  */
86430
86696
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
86431
86697
  /**
@@ -86442,7 +86708,7 @@ declare namespace Word {
86442
86708
  * [Api set: WordApi 1.2]
86443
86709
  *
86444
86710
  * @param base64File Required. The base64 encoded content of a .docx file.
86445
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86711
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86446
86712
  */
86447
86713
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
86448
86714
  /**
@@ -86452,7 +86718,7 @@ declare namespace Word {
86452
86718
  * [Api set: WordApi 1.2]
86453
86719
  *
86454
86720
  * @param base64File Required. The base64 encoded content of a .docx file.
86455
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86721
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86456
86722
  */
86457
86723
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86458
86724
  /**
@@ -86462,7 +86728,7 @@ declare namespace Word {
86462
86728
  * [Api set: WordApi 1.2]
86463
86729
  *
86464
86730
  * @param html Required. The HTML to be inserted.
86465
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86731
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86466
86732
  */
86467
86733
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
86468
86734
  /**
@@ -86472,7 +86738,7 @@ declare namespace Word {
86472
86738
  * [Api set: WordApi 1.2]
86473
86739
  *
86474
86740
  * @param html Required. The HTML to be inserted.
86475
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86741
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86476
86742
  */
86477
86743
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86478
86744
  /**
@@ -86482,7 +86748,7 @@ declare namespace Word {
86482
86748
  * [Api set: WordApi 1.2]
86483
86749
  *
86484
86750
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
86485
- * @param insertLocation Required. The value can be 'Replace', 'Before', or 'After'.
86751
+ * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
86486
86752
  */
86487
86753
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
86488
86754
  /**
@@ -86492,7 +86758,7 @@ declare namespace Word {
86492
86758
  * [Api set: WordApi 1.2]
86493
86759
  *
86494
86760
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
86495
- * @param insertLocation Required. The value can be 'Replace', 'Before', or 'After'.
86761
+ * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
86496
86762
  */
86497
86763
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
86498
86764
  /**
@@ -86502,7 +86768,7 @@ declare namespace Word {
86502
86768
  * [Api set: WordApi 1.2]
86503
86769
  *
86504
86770
  * @param ooxml Required. The OOXML to be inserted.
86505
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86771
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86506
86772
  */
86507
86773
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
86508
86774
  /**
@@ -86512,7 +86778,7 @@ declare namespace Word {
86512
86778
  * [Api set: WordApi 1.2]
86513
86779
  *
86514
86780
  * @param ooxml Required. The OOXML to be inserted.
86515
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86781
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86516
86782
  */
86517
86783
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86518
86784
  /**
@@ -86522,7 +86788,7 @@ declare namespace Word {
86522
86788
  * [Api set: WordApi 1.2]
86523
86789
  *
86524
86790
  * @param paragraphText Required. The paragraph text to be inserted.
86525
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86791
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86526
86792
  */
86527
86793
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
86528
86794
  /**
@@ -86532,7 +86798,7 @@ declare namespace Word {
86532
86798
  * [Api set: WordApi 1.2]
86533
86799
  *
86534
86800
  * @param paragraphText Required. The paragraph text to be inserted.
86535
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86801
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86536
86802
  */
86537
86803
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
86538
86804
  /**
@@ -86542,7 +86808,7 @@ declare namespace Word {
86542
86808
  * [Api set: WordApi 1.2]
86543
86809
  *
86544
86810
  * @param text Required. Text to be inserted.
86545
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86811
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86546
86812
  */
86547
86813
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
86548
86814
  /**
@@ -86552,7 +86818,7 @@ declare namespace Word {
86552
86818
  * [Api set: WordApi 1.2]
86553
86819
  *
86554
86820
  * @param text Required. Text to be inserted.
86555
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86821
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86556
86822
  */
86557
86823
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86558
86824
  /**
@@ -86561,7 +86827,7 @@ declare namespace Word {
86561
86827
  * @remarks
86562
86828
  * [Api set: WordApi 1.2]
86563
86829
  *
86564
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
86830
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
86565
86831
  */
86566
86832
  select(selectionMode?: Word.SelectionMode): void;
86567
86833
  /**
@@ -86570,7 +86836,7 @@ declare namespace Word {
86570
86836
  * @remarks
86571
86837
  * [Api set: WordApi 1.2]
86572
86838
  *
86573
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
86839
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
86574
86840
  */
86575
86841
  select(selectionMode?: "Select" | "Start" | "End"): void;
86576
86842
  /**
@@ -86747,7 +87013,7 @@ declare namespace Word {
86747
87013
  * [Api set: WordApi 1.3]
86748
87014
  *
86749
87015
  * @param paragraphText Required. The paragraph text to be inserted.
86750
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
87016
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
86751
87017
  */
86752
87018
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
86753
87019
  /**
@@ -86757,7 +87023,7 @@ declare namespace Word {
86757
87023
  * [Api set: WordApi 1.3]
86758
87024
  *
86759
87025
  * @param paragraphText Required. The paragraph text to be inserted.
86760
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
87026
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
86761
87027
  */
86762
87028
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
86763
87029
  /**
@@ -86778,7 +87044,7 @@ declare namespace Word {
86778
87044
  * [Api set: WordApi 1.3]
86779
87045
  *
86780
87046
  * @param level Required. The level in the list.
86781
- * @param alignment Required. The level alignment that can be 'Left', 'Centered', or 'Right'.
87047
+ * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'.
86782
87048
  */
86783
87049
  setLevelAlignment(level: number, alignment: Word.Alignment): void;
86784
87050
  /**
@@ -86788,7 +87054,7 @@ declare namespace Word {
86788
87054
  * [Api set: WordApi 1.3]
86789
87055
  *
86790
87056
  * @param level Required. The level in the list.
86791
- * @param alignment Required. The level alignment that can be 'Left', 'Centered', or 'Right'.
87057
+ * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'.
86792
87058
  */
86793
87059
  setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;
86794
87060
  /**
@@ -87273,6 +87539,14 @@ declare namespace Word {
87273
87539
  * @beta
87274
87540
  */
87275
87541
  readonly endnotes: Word.NoteItemCollection;
87542
+ /**
87543
+ * Gets the collection of fields in the paragraph. Read-only.
87544
+ *
87545
+ * @remarks
87546
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87547
+ * @beta
87548
+ */
87549
+ readonly fields: Word.FieldCollection;
87276
87550
  /**
87277
87551
  * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
87278
87552
  *
@@ -87579,7 +87853,7 @@ declare namespace Word {
87579
87853
  * @remarks
87580
87854
  * [Api set: WordApi 1.3]
87581
87855
  *
87582
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
87856
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
87583
87857
  */
87584
87858
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
87585
87859
  /**
@@ -87588,7 +87862,7 @@ declare namespace Word {
87588
87862
  * @remarks
87589
87863
  * [Api set: WordApi 1.3]
87590
87864
  *
87591
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
87865
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
87592
87866
  */
87593
87867
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
87594
87868
  /**
@@ -87598,7 +87872,7 @@ declare namespace Word {
87598
87872
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87599
87873
  * @beta
87600
87874
  *
87601
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
87875
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
87602
87876
  */
87603
87877
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
87604
87878
  /**
@@ -87608,7 +87882,7 @@ declare namespace Word {
87608
87882
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87609
87883
  * @beta
87610
87884
  *
87611
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
87885
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
87612
87886
  */
87613
87887
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
87614
87888
  /**
@@ -87628,7 +87902,7 @@ declare namespace Word {
87628
87902
  * [Api set: WordApi 1.1]
87629
87903
  *
87630
87904
  * @param breakType Required. The break type to add to the document.
87631
- * @param insertLocation Required. The value can be 'Before' or 'After'.
87905
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87632
87906
  */
87633
87907
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
87634
87908
  /**
@@ -87638,7 +87912,7 @@ declare namespace Word {
87638
87912
  * [Api set: WordApi 1.1]
87639
87913
  *
87640
87914
  * @param breakType Required. The break type to add to the document.
87641
- * @param insertLocation Required. The value can be 'Before' or 'After'.
87915
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87642
87916
  */
87643
87917
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
87644
87918
  /**
@@ -87655,7 +87929,7 @@ declare namespace Word {
87655
87929
  * [Api set: WordApi 1.1]
87656
87930
  *
87657
87931
  * @param base64File Required. The base64 encoded content of a .docx file.
87658
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87932
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87659
87933
  */
87660
87934
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
87661
87935
  /**
@@ -87665,7 +87939,7 @@ declare namespace Word {
87665
87939
  * [Api set: WordApi 1.1]
87666
87940
  *
87667
87941
  * @param base64File Required. The base64 encoded content of a .docx file.
87668
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87942
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87669
87943
  */
87670
87944
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87671
87945
  /**
@@ -87675,7 +87949,7 @@ declare namespace Word {
87675
87949
  * [Api set: WordApi 1.1]
87676
87950
  *
87677
87951
  * @param html Required. The HTML to be inserted in the paragraph.
87678
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87952
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87679
87953
  */
87680
87954
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
87681
87955
  /**
@@ -87685,7 +87959,7 @@ declare namespace Word {
87685
87959
  * [Api set: WordApi 1.1]
87686
87960
  *
87687
87961
  * @param html Required. The HTML to be inserted in the paragraph.
87688
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87962
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87689
87963
  */
87690
87964
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87691
87965
  /**
@@ -87695,7 +87969,7 @@ declare namespace Word {
87695
87969
  * [Api set: WordApi 1.1]
87696
87970
  *
87697
87971
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87698
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87972
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87699
87973
  */
87700
87974
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
87701
87975
  /**
@@ -87705,7 +87979,7 @@ declare namespace Word {
87705
87979
  * [Api set: WordApi 1.1]
87706
87980
  *
87707
87981
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87708
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87982
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87709
87983
  */
87710
87984
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
87711
87985
  /**
@@ -87715,7 +87989,7 @@ declare namespace Word {
87715
87989
  * [Api set: WordApi 1.1]
87716
87990
  *
87717
87991
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
87718
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87992
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87719
87993
  */
87720
87994
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
87721
87995
  /**
@@ -87725,7 +87999,7 @@ declare namespace Word {
87725
87999
  * [Api set: WordApi 1.1]
87726
88000
  *
87727
88001
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
87728
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88002
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87729
88003
  */
87730
88004
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87731
88005
  /**
@@ -87735,7 +88009,7 @@ declare namespace Word {
87735
88009
  * [Api set: WordApi 1.1]
87736
88010
  *
87737
88011
  * @param paragraphText Required. The paragraph text to be inserted.
87738
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88012
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87739
88013
  */
87740
88014
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
87741
88015
  /**
@@ -87745,7 +88019,7 @@ declare namespace Word {
87745
88019
  * [Api set: WordApi 1.1]
87746
88020
  *
87747
88021
  * @param paragraphText Required. The paragraph text to be inserted.
87748
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88022
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87749
88023
  */
87750
88024
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
87751
88025
  /**
@@ -87756,7 +88030,7 @@ declare namespace Word {
87756
88030
  *
87757
88031
  * @param rowCount Required. The number of rows in the table.
87758
88032
  * @param columnCount Required. The number of columns in the table.
87759
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88033
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87760
88034
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
87761
88035
  */
87762
88036
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -87768,7 +88042,7 @@ declare namespace Word {
87768
88042
  *
87769
88043
  * @param rowCount Required. The number of rows in the table.
87770
88044
  * @param columnCount Required. The number of columns in the table.
87771
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88045
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87772
88046
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
87773
88047
  */
87774
88048
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -87779,7 +88053,7 @@ declare namespace Word {
87779
88053
  * [Api set: WordApi 1.1]
87780
88054
  *
87781
88055
  * @param text Required. Text to be inserted.
87782
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88056
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87783
88057
  */
87784
88058
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
87785
88059
  /**
@@ -87789,7 +88063,7 @@ declare namespace Word {
87789
88063
  * [Api set: WordApi 1.1]
87790
88064
  *
87791
88065
  * @param text Required. Text to be inserted.
87792
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88066
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87793
88067
  */
87794
88068
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87795
88069
  /**
@@ -87816,7 +88090,7 @@ declare namespace Word {
87816
88090
  * @remarks
87817
88091
  * [Api set: WordApi 1.1]
87818
88092
  *
87819
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88093
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
87820
88094
  */
87821
88095
  select(selectionMode?: Word.SelectionMode): void;
87822
88096
  /**
@@ -87825,7 +88099,7 @@ declare namespace Word {
87825
88099
  * @remarks
87826
88100
  * [Api set: WordApi 1.1]
87827
88101
  *
87828
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88102
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
87829
88103
  */
87830
88104
  select(selectionMode?: "Select" | "Start" | "End"): void;
87831
88105
  /**
@@ -87976,6 +88250,14 @@ declare namespace Word {
87976
88250
  * @beta
87977
88251
  */
87978
88252
  readonly endnotes: Word.NoteItemCollection;
88253
+ /**
88254
+ * Gets the collection of field objects in the range. Read-only.
88255
+ *
88256
+ * @remarks
88257
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88258
+ * @beta
88259
+ */
88260
+ readonly fields: Word.FieldCollection;
87979
88261
  /**
87980
88262
  * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
87981
88263
  *
@@ -88219,7 +88501,7 @@ declare namespace Word {
88219
88501
  * @remarks
88220
88502
  * [Api set: WordApi 1.3]
88221
88503
  *
88222
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
88504
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88223
88505
  */
88224
88506
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
88225
88507
  /**
@@ -88228,7 +88510,7 @@ declare namespace Word {
88228
88510
  * @remarks
88229
88511
  * [Api set: WordApi 1.3]
88230
88512
  *
88231
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
88513
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88232
88514
  */
88233
88515
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
88234
88516
  /**
@@ -88238,7 +88520,7 @@ declare namespace Word {
88238
88520
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88239
88521
  * @beta
88240
88522
  *
88241
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
88523
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
88242
88524
  */
88243
88525
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
88244
88526
  /**
@@ -88248,7 +88530,7 @@ declare namespace Word {
88248
88530
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88249
88531
  * @beta
88250
88532
  *
88251
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
88533
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
88252
88534
  */
88253
88535
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
88254
88536
  /**
@@ -88278,7 +88560,7 @@ declare namespace Word {
88278
88560
  * [Api set: WordApi 1.1]
88279
88561
  *
88280
88562
  * @param breakType Required. The break type to add.
88281
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88563
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88282
88564
  */
88283
88565
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
88284
88566
  /**
@@ -88288,7 +88570,7 @@ declare namespace Word {
88288
88570
  * [Api set: WordApi 1.1]
88289
88571
  *
88290
88572
  * @param breakType Required. The break type to add.
88291
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88573
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88292
88574
  */
88293
88575
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
88294
88576
  /**
@@ -88315,6 +88597,8 @@ declare namespace Word {
88315
88597
  * @remarks
88316
88598
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88317
88599
  * @beta
88600
+ *
88601
+ * @param insertText Optional. Text to be inserted into the endnote body. The default is "".
88318
88602
  */
88319
88603
  insertEndnote(insertText?: string): Word.NoteItem;
88320
88604
  /**
@@ -88324,7 +88608,7 @@ declare namespace Word {
88324
88608
  * [Api set: WordApi 1.1]
88325
88609
  *
88326
88610
  * @param base64File Required. The base64 encoded content of a .docx file.
88327
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88611
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88328
88612
  */
88329
88613
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
88330
88614
  /**
@@ -88334,7 +88618,7 @@ declare namespace Word {
88334
88618
  * [Api set: WordApi 1.1]
88335
88619
  *
88336
88620
  * @param base64File Required. The base64 encoded content of a .docx file.
88337
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88621
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88338
88622
  */
88339
88623
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88340
88624
  /**
@@ -88343,6 +88627,8 @@ declare namespace Word {
88343
88627
  * @remarks
88344
88628
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88345
88629
  * @beta
88630
+ *
88631
+ * @param insertText Optional. Text to be inserted into the footnote body. The default is "".
88346
88632
  */
88347
88633
  insertFootnote(insertText?: string): Word.NoteItem;
88348
88634
  /**
@@ -88352,7 +88638,7 @@ declare namespace Word {
88352
88638
  * [Api set: WordApi 1.1]
88353
88639
  *
88354
88640
  * @param html Required. The HTML to be inserted.
88355
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88641
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88356
88642
  */
88357
88643
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
88358
88644
  /**
@@ -88362,7 +88648,7 @@ declare namespace Word {
88362
88648
  * [Api set: WordApi 1.1]
88363
88649
  *
88364
88650
  * @param html Required. The HTML to be inserted.
88365
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88651
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88366
88652
  */
88367
88653
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88368
88654
  /**
@@ -88372,7 +88658,7 @@ declare namespace Word {
88372
88658
  * [Api set: WordApi 1.2]
88373
88659
  *
88374
88660
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88375
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88661
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88376
88662
  */
88377
88663
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
88378
88664
  /**
@@ -88382,7 +88668,7 @@ declare namespace Word {
88382
88668
  * [Api set: WordApi 1.2]
88383
88669
  *
88384
88670
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88385
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88671
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88386
88672
  */
88387
88673
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
88388
88674
  /**
@@ -88392,7 +88678,7 @@ declare namespace Word {
88392
88678
  * [Api set: WordApi 1.1]
88393
88679
  *
88394
88680
  * @param ooxml Required. The OOXML to be inserted.
88395
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88681
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88396
88682
  */
88397
88683
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
88398
88684
  /**
@@ -88402,7 +88688,7 @@ declare namespace Word {
88402
88688
  * [Api set: WordApi 1.1]
88403
88689
  *
88404
88690
  * @param ooxml Required. The OOXML to be inserted.
88405
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88691
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88406
88692
  */
88407
88693
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88408
88694
  /**
@@ -88412,7 +88698,7 @@ declare namespace Word {
88412
88698
  * [Api set: WordApi 1.1]
88413
88699
  *
88414
88700
  * @param paragraphText Required. The paragraph text to be inserted.
88415
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88701
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88416
88702
  */
88417
88703
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
88418
88704
  /**
@@ -88422,7 +88708,7 @@ declare namespace Word {
88422
88708
  * [Api set: WordApi 1.1]
88423
88709
  *
88424
88710
  * @param paragraphText Required. The paragraph text to be inserted.
88425
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88711
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88426
88712
  */
88427
88713
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
88428
88714
  /**
@@ -88433,7 +88719,7 @@ declare namespace Word {
88433
88719
  *
88434
88720
  * @param rowCount Required. The number of rows in the table.
88435
88721
  * @param columnCount Required. The number of columns in the table.
88436
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88722
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88437
88723
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88438
88724
  */
88439
88725
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -88445,7 +88731,7 @@ declare namespace Word {
88445
88731
  *
88446
88732
  * @param rowCount Required. The number of rows in the table.
88447
88733
  * @param columnCount Required. The number of columns in the table.
88448
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88734
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88449
88735
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88450
88736
  */
88451
88737
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -88456,7 +88742,7 @@ declare namespace Word {
88456
88742
  * [Api set: WordApi 1.1]
88457
88743
  *
88458
88744
  * @param text Required. Text to be inserted.
88459
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88745
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88460
88746
  */
88461
88747
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
88462
88748
  /**
@@ -88466,7 +88752,7 @@ declare namespace Word {
88466
88752
  * [Api set: WordApi 1.1]
88467
88753
  *
88468
88754
  * @param text Required. Text to be inserted.
88469
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88755
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88470
88756
  */
88471
88757
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88472
88758
  /**
@@ -88511,7 +88797,7 @@ declare namespace Word {
88511
88797
  * @remarks
88512
88798
  * [Api set: WordApi 1.1]
88513
88799
  *
88514
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88800
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
88515
88801
  */
88516
88802
  select(selectionMode?: Word.SelectionMode): void;
88517
88803
  /**
@@ -88520,7 +88806,7 @@ declare namespace Word {
88520
88806
  * @remarks
88521
88807
  * [Api set: WordApi 1.1]
88522
88808
  *
88523
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88809
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
88524
88810
  */
88525
88811
  select(selectionMode?: "Select" | "Start" | "End"): void;
88526
88812
  /**
@@ -88756,7 +89042,7 @@ declare namespace Word {
88756
89042
  * @remarks
88757
89043
  * [Api set: WordApi 1.1]
88758
89044
  *
88759
- * @param type Required. The type of footer to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89045
+ * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88760
89046
  */
88761
89047
  getFooter(type: Word.HeaderFooterType): Word.Body;
88762
89048
  /**
@@ -88765,7 +89051,7 @@ declare namespace Word {
88765
89051
  * @remarks
88766
89052
  * [Api set: WordApi 1.1]
88767
89053
  *
88768
- * @param type Required. The type of footer to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89054
+ * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88769
89055
  */
88770
89056
  getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;
88771
89057
  /**
@@ -88774,7 +89060,7 @@ declare namespace Word {
88774
89060
  * @remarks
88775
89061
  * [Api set: WordApi 1.1]
88776
89062
  *
88777
- * @param type Required. The type of header to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89063
+ * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88778
89064
  */
88779
89065
  getHeader(type: Word.HeaderFooterType): Word.Body;
88780
89066
  /**
@@ -88783,7 +89069,7 @@ declare namespace Word {
88783
89069
  * @remarks
88784
89070
  * [Api set: WordApi 1.1]
88785
89071
  *
88786
- * @param type Required. The type of header to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89072
+ * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88787
89073
  */
88788
89074
  getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;
88789
89075
  /**
@@ -89077,6 +89363,14 @@ declare namespace Word {
89077
89363
  * @beta
89078
89364
  */
89079
89365
  readonly endnotes: Word.NoteItemCollection;
89366
+ /**
89367
+ * Gets the collection of field objects in the table. Read-only.
89368
+ *
89369
+ * @remarks
89370
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
89371
+ * @beta
89372
+ */
89373
+ readonly fields: Word.FieldCollection;
89080
89374
  /**
89081
89375
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
89082
89376
  *
@@ -89288,7 +89582,7 @@ declare namespace Word {
89288
89582
  * @remarks
89289
89583
  * [Api set: WordApi 1.3]
89290
89584
  *
89291
- * @param insertLocation Required. It can be 'Start' or 'End', corresponding to the appropriate side of the table.
89585
+ * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
89292
89586
  * @param columnCount Required. Number of columns to add.
89293
89587
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89294
89588
  */
@@ -89299,7 +89593,7 @@ declare namespace Word {
89299
89593
  * @remarks
89300
89594
  * [Api set: WordApi 1.3]
89301
89595
  *
89302
- * @param insertLocation Required. It can be 'Start' or 'End', corresponding to the appropriate side of the table.
89596
+ * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
89303
89597
  * @param columnCount Required. Number of columns to add.
89304
89598
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89305
89599
  */
@@ -89310,7 +89604,7 @@ declare namespace Word {
89310
89604
  * @remarks
89311
89605
  * [Api set: WordApi 1.3]
89312
89606
  *
89313
- * @param insertLocation Required. It can be 'Start' or 'End'.
89607
+ * @param insertLocation Required. It must be 'Start' or 'End'.
89314
89608
  * @param rowCount Required. Number of rows to add.
89315
89609
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89316
89610
  */
@@ -89321,7 +89615,7 @@ declare namespace Word {
89321
89615
  * @remarks
89322
89616
  * [Api set: WordApi 1.3]
89323
89617
  *
89324
- * @param insertLocation Required. It can be 'Start' or 'End'.
89618
+ * @param insertLocation Required. It must be 'Start' or 'End'.
89325
89619
  * @param rowCount Required. Number of rows to add.
89326
89620
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89327
89621
  */
@@ -89418,7 +89712,7 @@ declare namespace Word {
89418
89712
  * @remarks
89419
89713
  * [Api set: WordApi 1.3]
89420
89714
  *
89421
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89715
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89422
89716
  */
89423
89717
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
89424
89718
  /**
@@ -89427,7 +89721,7 @@ declare namespace Word {
89427
89721
  * @remarks
89428
89722
  * [Api set: WordApi 1.3]
89429
89723
  *
89430
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89724
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89431
89725
  */
89432
89726
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
89433
89727
  /**
@@ -89478,7 +89772,7 @@ declare namespace Word {
89478
89772
  * @remarks
89479
89773
  * [Api set: WordApi 1.3]
89480
89774
  *
89481
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', or 'After'.
89775
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
89482
89776
  */
89483
89777
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
89484
89778
  /**
@@ -89487,7 +89781,7 @@ declare namespace Word {
89487
89781
  * @remarks
89488
89782
  * [Api set: WordApi 1.3]
89489
89783
  *
89490
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', or 'After'.
89784
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
89491
89785
  */
89492
89786
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
89493
89787
  /**
@@ -89504,7 +89798,7 @@ declare namespace Word {
89504
89798
  * [Api set: WordApi 1.3]
89505
89799
  *
89506
89800
  * @param paragraphText Required. The paragraph text to be inserted.
89507
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89801
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89508
89802
  */
89509
89803
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
89510
89804
  /**
@@ -89514,7 +89808,7 @@ declare namespace Word {
89514
89808
  * [Api set: WordApi 1.3]
89515
89809
  *
89516
89810
  * @param paragraphText Required. The paragraph text to be inserted.
89517
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89811
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89518
89812
  */
89519
89813
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
89520
89814
  /**
@@ -89525,7 +89819,7 @@ declare namespace Word {
89525
89819
  *
89526
89820
  * @param rowCount Required. The number of rows in the table.
89527
89821
  * @param columnCount Required. The number of columns in the table.
89528
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89822
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89529
89823
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89530
89824
  */
89531
89825
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -89537,7 +89831,7 @@ declare namespace Word {
89537
89831
  *
89538
89832
  * @param rowCount Required. The number of rows in the table.
89539
89833
  * @param columnCount Required. The number of columns in the table.
89540
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89834
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89541
89835
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89542
89836
  */
89543
89837
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -89578,7 +89872,7 @@ declare namespace Word {
89578
89872
  * @remarks
89579
89873
  * [Api set: WordApi 1.3]
89580
89874
  *
89581
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
89875
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89582
89876
  */
89583
89877
  select(selectionMode?: Word.SelectionMode): void;
89584
89878
  /**
@@ -89587,7 +89881,7 @@ declare namespace Word {
89587
89881
  * @remarks
89588
89882
  * [Api set: WordApi 1.3]
89589
89883
  *
89590
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
89884
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89591
89885
  */
89592
89886
  select(selectionMode?: "Select" | "Start" | "End"): void;
89593
89887
  /**
@@ -89596,7 +89890,7 @@ declare namespace Word {
89596
89890
  * @remarks
89597
89891
  * [Api set: WordApi 1.3]
89598
89892
  *
89599
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89893
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89600
89894
  * @param cellPadding Required. The cell padding.
89601
89895
  */
89602
89896
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -89606,7 +89900,7 @@ declare namespace Word {
89606
89900
  * @remarks
89607
89901
  * [Api set: WordApi 1.3]
89608
89902
  *
89609
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89903
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89610
89904
  * @param cellPadding Required. The cell padding.
89611
89905
  */
89612
89906
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -89726,6 +90020,14 @@ declare namespace Word {
89726
90020
  * @beta
89727
90021
  */
89728
90022
  readonly endnotes: Word.NoteItemCollection;
90023
+ /**
90024
+ * Gets the collection of field objects in the table row. Read-only.
90025
+ *
90026
+ * @remarks
90027
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
90028
+ * @beta
90029
+ */
90030
+ readonly fields: Word.FieldCollection;
89729
90031
  /**
89730
90032
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
89731
90033
  *
@@ -89850,7 +90152,7 @@ declare namespace Word {
89850
90152
  * @remarks
89851
90153
  * [Api set: WordApi 1.3]
89852
90154
  *
89853
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90155
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89854
90156
  */
89855
90157
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
89856
90158
  /**
@@ -89859,7 +90161,7 @@ declare namespace Word {
89859
90161
  * @remarks
89860
90162
  * [Api set: WordApi 1.3]
89861
90163
  *
89862
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90164
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89863
90165
  */
89864
90166
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
89865
90167
  /**
@@ -89890,7 +90192,7 @@ declare namespace Word {
89890
90192
  * @remarks
89891
90193
  * [Api set: WordApi 1.3]
89892
90194
  *
89893
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It can be 'Before' or 'After'.
90195
+ * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
89894
90196
  * @param rowCount Required. Number of rows to add
89895
90197
  * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
89896
90198
  */
@@ -89901,7 +90203,7 @@ declare namespace Word {
89901
90203
  * @remarks
89902
90204
  * [Api set: WordApi 1.3]
89903
90205
  *
89904
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It can be 'Before' or 'After'.
90206
+ * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
89905
90207
  * @param rowCount Required. Number of rows to add
89906
90208
  * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
89907
90209
  */
@@ -89938,7 +90240,7 @@ declare namespace Word {
89938
90240
  * @remarks
89939
90241
  * [Api set: WordApi 1.3]
89940
90242
  *
89941
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
90243
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89942
90244
  */
89943
90245
  select(selectionMode?: Word.SelectionMode): void;
89944
90246
  /**
@@ -89947,7 +90249,7 @@ declare namespace Word {
89947
90249
  * @remarks
89948
90250
  * [Api set: WordApi 1.3]
89949
90251
  *
89950
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
90252
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89951
90253
  */
89952
90254
  select(selectionMode?: "Select" | "Start" | "End"): void;
89953
90255
  /**
@@ -89956,7 +90258,7 @@ declare namespace Word {
89956
90258
  * @remarks
89957
90259
  * [Api set: WordApi 1.3]
89958
90260
  *
89959
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90261
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89960
90262
  * @param cellPadding Required. The cell padding.
89961
90263
  */
89962
90264
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -89966,7 +90268,7 @@ declare namespace Word {
89966
90268
  * @remarks
89967
90269
  * [Api set: WordApi 1.3]
89968
90270
  *
89969
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90271
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89970
90272
  * @param cellPadding Required. The cell padding.
89971
90273
  */
89972
90274
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -90194,7 +90496,7 @@ declare namespace Word {
90194
90496
  * @remarks
90195
90497
  * [Api set: WordApi 1.3]
90196
90498
  *
90197
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90499
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90198
90500
  */
90199
90501
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
90200
90502
  /**
@@ -90203,7 +90505,7 @@ declare namespace Word {
90203
90505
  * @remarks
90204
90506
  * [Api set: WordApi 1.3]
90205
90507
  *
90206
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90508
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90207
90509
  */
90208
90510
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
90209
90511
  /**
@@ -90226,7 +90528,7 @@ declare namespace Word {
90226
90528
  * @remarks
90227
90529
  * [Api set: WordApi 1.3]
90228
90530
  *
90229
- * @param insertLocation Required. It can be 'Before' or 'After'.
90531
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90230
90532
  * @param columnCount Required. Number of columns to add.
90231
90533
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90232
90534
  */
@@ -90237,7 +90539,7 @@ declare namespace Word {
90237
90539
  * @remarks
90238
90540
  * [Api set: WordApi 1.3]
90239
90541
  *
90240
- * @param insertLocation Required. It can be 'Before' or 'After'.
90542
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90241
90543
  * @param columnCount Required. Number of columns to add.
90242
90544
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90243
90545
  */
@@ -90248,7 +90550,7 @@ declare namespace Word {
90248
90550
  * @remarks
90249
90551
  * [Api set: WordApi 1.3]
90250
90552
  *
90251
- * @param insertLocation Required. It can be 'Before' or 'After'.
90553
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90252
90554
  * @param rowCount Required. Number of rows to add.
90253
90555
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90254
90556
  */
@@ -90259,7 +90561,7 @@ declare namespace Word {
90259
90561
  * @remarks
90260
90562
  * [Api set: WordApi 1.3]
90261
90563
  *
90262
- * @param insertLocation Required. It can be 'Before' or 'After'.
90564
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90263
90565
  * @param rowCount Required. Number of rows to add.
90264
90566
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90265
90567
  */
@@ -90270,7 +90572,7 @@ declare namespace Word {
90270
90572
  * @remarks
90271
90573
  * [Api set: WordApi 1.3]
90272
90574
  *
90273
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90575
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90274
90576
  * @param cellPadding Required. The cell padding.
90275
90577
  */
90276
90578
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -90280,7 +90582,7 @@ declare namespace Word {
90280
90582
  * @remarks
90281
90583
  * [Api set: WordApi 1.3]
90282
90584
  *
90283
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90585
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90284
90586
  * @param cellPadding Required. The cell padding.
90285
90587
  */
90286
90588
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -90491,7 +90793,7 @@ declare namespace Word {
90491
90793
  trackMineOnly = "TrackMineOnly",
90492
90794
  }
90493
90795
  /**
90494
- * Specify the current version or the original version of the document.
90796
+ * Specify the current version or the original version of the text.
90495
90797
  *
90496
90798
  * @remarks
90497
90799
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -90910,7 +91212,7 @@ declare namespace Word {
90910
91212
  line = "Line",
90911
91213
  }
90912
91214
  /**
90913
- * The insertion location types
91215
+ * The insertion location types.
90914
91216
  *
90915
91217
  * @remarks
90916
91218
  * [Api set: WordApi 1.1]
@@ -92604,7 +92906,6 @@ declare namespace Word {
92604
92906
  color?: string;
92605
92907
  /**
92606
92908
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
92607
- *
92608
92909
  * **Note**: The set operation for this property is not supported in Word on the web.
92609
92910
  *
92610
92911
  * @remarks
@@ -92781,6 +93082,10 @@ declare namespace Word {
92781
93082
  */
92782
93083
  title?: string;
92783
93084
  }
93085
+ /** An interface for updating data on the FieldCollection object, for use in `fieldCollection.set({ ... })`. */
93086
+ interface FieldCollectionUpdateData {
93087
+ items?: Word.Interfaces.FieldData[];
93088
+ }
92784
93089
  /** An interface for updating data on the Font object, for use in `font.set({ ... })`. */
92785
93090
  interface FontUpdateData {
92786
93091
  /**
@@ -92806,7 +93111,7 @@ declare namespace Word {
92806
93111
  doubleStrikeThrough?: boolean;
92807
93112
  /**
92808
93113
  * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color.
92809
- **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
93114
+ * **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
92810
93115
  *
92811
93116
  * @remarks
92812
93117
  * [Api set: WordApi 1.1]
@@ -93420,6 +93725,14 @@ declare namespace Word {
93420
93725
  */
93421
93726
  contentControls?: Word.Interfaces.ContentControlData[];
93422
93727
  /**
93728
+ * Gets the collection of field objects in the body. Read-only.
93729
+ *
93730
+ * @remarks
93731
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
93732
+ * @beta
93733
+ */
93734
+ fields?: Word.Interfaces.FieldData[];
93735
+ /**
93423
93736
  * Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
93424
93737
  *
93425
93738
  * @remarks
@@ -93534,7 +93847,7 @@ declare namespace Word {
93534
93847
  */
93535
93848
  creationDate?: Date;
93536
93849
  /**
93537
- * ID
93850
+ * Gets the ID of the comment. Read-only.
93538
93851
  *
93539
93852
  * @remarks
93540
93853
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -93664,7 +93977,7 @@ declare namespace Word {
93664
93977
  */
93665
93978
  creationDate?: Date;
93666
93979
  /**
93667
- * ID
93980
+ * Gets the ID of the comment reply. Read-only.
93668
93981
  *
93669
93982
  * @remarks
93670
93983
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -93686,6 +93999,14 @@ declare namespace Word {
93686
93999
  */
93687
94000
  contentControls?: Word.Interfaces.ContentControlData[];
93688
94001
  /**
94002
+ * Gets the collection of field objects in the contentcontrol. Read-only.
94003
+ *
94004
+ * @remarks
94005
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94006
+ * @beta
94007
+ */
94008
+ fields?: Word.Interfaces.FieldData[];
94009
+ /**
93689
94010
  * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
93690
94011
  *
93691
94012
  * @remarks
@@ -93757,7 +94078,6 @@ declare namespace Word {
93757
94078
  id?: number;
93758
94079
  /**
93759
94080
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
93760
- *
93761
94081
  * **Note**: The set operation for this property is not supported in Word on the web.
93762
94082
  *
93763
94083
  * @remarks
@@ -94125,6 +94445,29 @@ declare namespace Word {
94125
94445
  */
94126
94446
  title?: string;
94127
94447
  }
94448
+ /** An interface describing the data returned by calling `field.toJSON()`. */
94449
+ interface FieldData {
94450
+ /**
94451
+ * Gets the field's code instruction. Read-only.
94452
+ *
94453
+ * @remarks
94454
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94455
+ * @beta
94456
+ */
94457
+ code?: string;
94458
+ /**
94459
+ * Gets the field's result data. Read-only.
94460
+ *
94461
+ * @remarks
94462
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94463
+ * @beta
94464
+ */
94465
+ result?: string;
94466
+ }
94467
+ /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */
94468
+ interface FieldCollectionData {
94469
+ items?: Word.Interfaces.FieldData[];
94470
+ }
94128
94471
  /** An interface describing the data returned by calling `font.toJSON()`. */
94129
94472
  interface FontData {
94130
94473
  /**
@@ -94150,7 +94493,7 @@ declare namespace Word {
94150
94493
  doubleStrikeThrough?: boolean;
94151
94494
  /**
94152
94495
  * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color.
94153
- **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
94496
+ * **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
94154
94497
  *
94155
94498
  * @remarks
94156
94499
  * [Api set: WordApi 1.1]
@@ -94355,6 +94698,14 @@ declare namespace Word {
94355
94698
  }
94356
94699
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
94357
94700
  interface ParagraphData {
94701
+ /**
94702
+ * Gets the collection of fields in the paragraph. Read-only.
94703
+ *
94704
+ * @remarks
94705
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94706
+ * @beta
94707
+ */
94708
+ fields?: Word.Interfaces.FieldData[];
94358
94709
  /**
94359
94710
  * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
94360
94711
  *
@@ -94502,6 +94853,14 @@ declare namespace Word {
94502
94853
  }
94503
94854
  /** An interface describing the data returned by calling `range.toJSON()`. */
94504
94855
  interface RangeData {
94856
+ /**
94857
+ * Gets the collection of field objects in the range. Read-only.
94858
+ *
94859
+ * @remarks
94860
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94861
+ * @beta
94862
+ */
94863
+ fields?: Word.Interfaces.FieldData[];
94505
94864
  /**
94506
94865
  * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
94507
94866
  *
@@ -94647,6 +95006,14 @@ declare namespace Word {
94647
95006
  }
94648
95007
  /** An interface describing the data returned by calling `table.toJSON()`. */
94649
95008
  interface TableData {
95009
+ /**
95010
+ * Gets the collection of field objects in the table. Read-only.
95011
+ *
95012
+ * @remarks
95013
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
95014
+ * @beta
95015
+ */
95016
+ fields?: Word.Interfaces.FieldData[];
94650
95017
  /**
94651
95018
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
94652
95019
  *
@@ -94802,6 +95169,14 @@ declare namespace Word {
94802
95169
  */
94803
95170
  cells?: Word.Interfaces.TableCellData[];
94804
95171
  /**
95172
+ * Gets the collection of field objects in the table row. Read-only.
95173
+ *
95174
+ * @remarks
95175
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
95176
+ * @beta
95177
+ */
95178
+ fields?: Word.Interfaces.FieldData[];
95179
+ /**
94805
95180
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
94806
95181
  *
94807
95182
  * @remarks
@@ -95105,7 +95480,7 @@ declare namespace Word {
95105
95480
  */
95106
95481
  creationDate?: boolean;
95107
95482
  /**
95108
- * ID
95483
+ * Gets the ID of the comment. Read-only.
95109
95484
  *
95110
95485
  * @remarks
95111
95486
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95174,7 +95549,7 @@ declare namespace Word {
95174
95549
  */
95175
95550
  creationDate?: boolean;
95176
95551
  /**
95177
- * For EACH ITEM in the collection: ID
95552
+ * For EACH ITEM in the collection: Gets the ID of the comment. Read-only.
95178
95553
  *
95179
95554
  * @remarks
95180
95555
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95318,7 +95693,7 @@ declare namespace Word {
95318
95693
  */
95319
95694
  creationDate?: boolean;
95320
95695
  /**
95321
- * ID
95696
+ * Gets the ID of the comment reply. Read-only.
95322
95697
  *
95323
95698
  * @remarks
95324
95699
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95387,7 +95762,7 @@ declare namespace Word {
95387
95762
  */
95388
95763
  creationDate?: boolean;
95389
95764
  /**
95390
- * For EACH ITEM in the collection: ID
95765
+ * For EACH ITEM in the collection: Gets the ID of the comment reply. Read-only.
95391
95766
  *
95392
95767
  * @remarks
95393
95768
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95499,7 +95874,6 @@ declare namespace Word {
95499
95874
  id?: boolean;
95500
95875
  /**
95501
95876
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
95502
- *
95503
95877
  * **Note**: The set operation for this property is not supported in Word on the web.
95504
95878
  *
95505
95879
  * @remarks
@@ -95667,7 +96041,6 @@ declare namespace Word {
95667
96041
  id?: boolean;
95668
96042
  /**
95669
96043
  * For EACH ITEM in the collection: Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
95670
- *
95671
96044
  * **Note**: The set operation for this property is not supported in Word on the web.
95672
96045
  *
95673
96046
  * @remarks
@@ -96089,6 +96462,176 @@ declare namespace Word {
96089
96462
  */
96090
96463
  title?: boolean;
96091
96464
  }
96465
+ /**
96466
+ * Represents a field.
96467
+ *
96468
+ * @remarks
96469
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96470
+ * @beta
96471
+ */
96472
+ interface FieldLoadOptions {
96473
+ /**
96474
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96475
+ */
96476
+ $all?: boolean;
96477
+ /**
96478
+ * Gets the parent body of the field.
96479
+ *
96480
+ * @remarks
96481
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96482
+ * @beta
96483
+ */
96484
+ parentBody?: Word.Interfaces.BodyLoadOptions;
96485
+ /**
96486
+ * Gets the content control that contains the field. Throws an error if there isn't a parent content control.
96487
+ *
96488
+ * @remarks
96489
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96490
+ * @beta
96491
+ */
96492
+ parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
96493
+ /**
96494
+ * Gets the content control that contains the field. Returns a null object if there isn't a parent content control.
96495
+ *
96496
+ * @remarks
96497
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96498
+ * @beta
96499
+ */
96500
+ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
96501
+ /**
96502
+ * Gets the table that contains the field. Throws an error if it is not contained in a table.
96503
+ *
96504
+ * @remarks
96505
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96506
+ * @beta
96507
+ */
96508
+ parentTable?: Word.Interfaces.TableLoadOptions;
96509
+ /**
96510
+ * Gets the table cell that contains the field. Throws an error if it is not contained in a table cell.
96511
+ *
96512
+ * @remarks
96513
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96514
+ * @beta
96515
+ */
96516
+ parentTableCell?: Word.Interfaces.TableCellLoadOptions;
96517
+ /**
96518
+ * Gets the table cell that contains the field. Returns a null object if it is not contained in a table cell.
96519
+ *
96520
+ * @remarks
96521
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96522
+ * @beta
96523
+ */
96524
+ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
96525
+ /**
96526
+ * Gets the table that contains the field. Returns a null object if it is not contained in a table.
96527
+ *
96528
+ * @remarks
96529
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96530
+ * @beta
96531
+ */
96532
+ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
96533
+ /**
96534
+ * Gets the field's code instruction. Read-only.
96535
+ *
96536
+ * @remarks
96537
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96538
+ * @beta
96539
+ */
96540
+ code?: boolean;
96541
+ /**
96542
+ * Gets the field's result data. Read-only.
96543
+ *
96544
+ * @remarks
96545
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96546
+ * @beta
96547
+ */
96548
+ result?: boolean;
96549
+ }
96550
+ /**
96551
+ * Contains a collection of {@link Word.Field} objects.
96552
+ *
96553
+ * @remarks
96554
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96555
+ * @beta
96556
+ */
96557
+ interface FieldCollectionLoadOptions {
96558
+ /**
96559
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96560
+ */
96561
+ $all?: boolean;
96562
+ /**
96563
+ * For EACH ITEM in the collection: Gets the parent body of the field.
96564
+ *
96565
+ * @remarks
96566
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96567
+ * @beta
96568
+ */
96569
+ parentBody?: Word.Interfaces.BodyLoadOptions;
96570
+ /**
96571
+ * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an error if there isn't a parent content control.
96572
+ *
96573
+ * @remarks
96574
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96575
+ * @beta
96576
+ */
96577
+ parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
96578
+ /**
96579
+ * For EACH ITEM in the collection: Gets the content control that contains the field. Returns a null object if there isn't a parent content control.
96580
+ *
96581
+ * @remarks
96582
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96583
+ * @beta
96584
+ */
96585
+ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
96586
+ /**
96587
+ * For EACH ITEM in the collection: Gets the table that contains the field. Throws an error if it is not contained in a table.
96588
+ *
96589
+ * @remarks
96590
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96591
+ * @beta
96592
+ */
96593
+ parentTable?: Word.Interfaces.TableLoadOptions;
96594
+ /**
96595
+ * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an error if it is not contained in a table cell.
96596
+ *
96597
+ * @remarks
96598
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96599
+ * @beta
96600
+ */
96601
+ parentTableCell?: Word.Interfaces.TableCellLoadOptions;
96602
+ /**
96603
+ * For EACH ITEM in the collection: Gets the table cell that contains the field. Returns a null object if it is not contained in a table cell.
96604
+ *
96605
+ * @remarks
96606
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96607
+ * @beta
96608
+ */
96609
+ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
96610
+ /**
96611
+ * For EACH ITEM in the collection: Gets the table that contains the field. Returns a null object if it is not contained in a table.
96612
+ *
96613
+ * @remarks
96614
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96615
+ * @beta
96616
+ */
96617
+ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
96618
+ /**
96619
+ * For EACH ITEM in the collection: Gets the field's code instruction. Read-only.
96620
+ *
96621
+ * @remarks
96622
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96623
+ * @beta
96624
+ */
96625
+ code?: boolean;
96626
+ /**
96627
+ * For EACH ITEM in the collection: Gets the field's result data. Read-only.
96628
+ *
96629
+ * @remarks
96630
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96631
+ * @beta
96632
+ */
96633
+ result?: boolean;
96634
+ }
96092
96635
  /**
96093
96636
  * Represents a font.
96094
96637
  *
@@ -96123,7 +96666,7 @@ declare namespace Word {
96123
96666
  doubleStrikeThrough?: boolean;
96124
96667
  /**
96125
96668
  * Gets or sets the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or null for no highlight color.
96126
- **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
96669
+ * **Note**: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font.
96127
96670
  *
96128
96671
  * @remarks
96129
96672
  * [Api set: WordApi 1.1]