@types/office-js-preview 1.0.295 → 1.0.298

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.
@@ -8864,6 +8864,11 @@ declare namespace Office {
8864
8864
  * [Api set: Mailbox 1.1]
8865
8865
  *
8866
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.
8867
8872
  */
8868
8873
  enum RecipientType {
8869
8874
  /**
@@ -12962,6 +12967,12 @@ declare namespace Office {
12962
12967
  appointmentResponse: MailboxEnums.ResponseType | string;
12963
12968
  /**
12964
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.
12965
12976
  */
12966
12977
  recipientType: MailboxEnums.RecipientType | string;
12967
12978
  }
@@ -13212,6 +13223,9 @@ declare namespace Office {
13212
13223
  *
13213
13224
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
13214
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
+ *
13215
13229
  * @param options - An object literal that contains one or more of the following properties.
13216
13230
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
13217
13231
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -13232,6 +13246,9 @@ declare namespace Office {
13232
13246
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
13233
13247
  *
13234
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.
13235
13252
  *
13236
13253
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
13237
13254
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -17336,6 +17353,9 @@ declare namespace Office {
17336
17353
  *
17337
17354
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
17338
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
+ *
17339
17359
  * @param options - An object literal that contains one or more of the following properties.
17340
17360
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
17341
17361
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
@@ -17353,6 +17373,9 @@ declare namespace Office {
17353
17373
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
17354
17374
  *
17355
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.
17356
17379
  *
17357
17380
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
17358
17381
  * `asyncResult`, which is an `AsyncResult` object. The `value` property of the result is the appointment's organizer value,
@@ -20009,7 +20032,7 @@ declare namespace Excel {
20009
20032
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20010
20033
  * @beta
20011
20034
  */
20012
- type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & CellValueExtraProperties;
20035
+ type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
20013
20036
  /**
20014
20037
  * These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
20015
20038
  *
@@ -20045,7 +20068,7 @@ declare namespace Excel {
20045
20068
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20046
20069
  * @beta
20047
20070
  */
20048
- type CellValueAndPropertyMetadata = CellValue & EntityPropertyExtraProperties;
20071
+ type CellValueAndPropertyMetadata = (CellValue) & EntityPropertyExtraProperties;
20049
20072
  /**
20050
20073
  * The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source.
20051
20074
  *
@@ -21499,7 +21522,7 @@ declare namespace Excel {
21499
21522
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
21500
21523
  * @beta
21501
21524
  */
21502
- spilledRows?: number;
21525
+ rowCount?: number;
21503
21526
  /**
21504
21527
  * Represents the number of columns that would spill if there were no #SPILL! error.
21505
21528
  *
@@ -21507,7 +21530,7 @@ declare namespace Excel {
21507
21530
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
21508
21531
  * @beta
21509
21532
  */
21510
- spilledColumns?: number;
21533
+ columnCount?: number;
21511
21534
  }
21512
21535
  /**
21513
21536
  * Represents the value of a cell containing a string.
@@ -31836,7 +31859,7 @@ declare namespace Excel {
31836
31859
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
31837
31860
  * @beta
31838
31861
  */
31839
- readonly valueAsJson: CellValue;
31862
+ readonly valueAsJson: CellValue | string;
31840
31863
  /**
31841
31864
  * A JSON representation of the values in this named item.
31842
31865
  Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
@@ -31846,7 +31869,7 @@ declare namespace Excel {
31846
31869
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
31847
31870
  * @beta
31848
31871
  */
31849
- readonly valueAsJsonLocal: CellValue[][];
31872
+ readonly valueAsJsonLocal: CellValue | string;
31850
31873
  /**
31851
31874
  * Specifies if the object is visible.
31852
31875
  *
@@ -37660,13 +37683,32 @@ declare namespace Excel {
37660
37683
  * @param color HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
37661
37684
  */
37662
37685
  setSolidColor(color: string): void;
37686
+ /**
37687
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
37688
+ *
37689
+ * @param options Provides options for which properties of the object to load.
37690
+ */
37691
+ load(options?: Excel.Interfaces.ChartFillLoadOptions): Excel.ChartFill;
37692
+ /**
37693
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
37694
+ *
37695
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
37696
+ */
37697
+ load(propertyNames?: string | string[]): Excel.ChartFill;
37698
+ /**
37699
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
37700
+ *
37701
+ * @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.
37702
+ */
37703
+ load(propertyNamesAndPaths?: {
37704
+ select?: string;
37705
+ expand?: string;
37706
+ }): Excel.ChartFill;
37663
37707
  /**
37664
37708
  * 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.)
37665
37709
  * Whereas the original Excel.ChartFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFillData`) that contains shallow copies of any loaded child properties from the original object.
37666
37710
  */
37667
- toJSON(): {
37668
- [key: string]: string;
37669
- };
37711
+ toJSON(): Excel.Interfaces.ChartFillData;
37670
37712
  }
37671
37713
  /**
37672
37714
  * Represents the border formatting of a chart element.
@@ -52572,7 +52614,14 @@ declare namespace Excel {
52572
52614
  * @remarks
52573
52615
  * [Api set: ExcelApi 1.7]
52574
52616
  */
52575
- lineageActivityUpdateAvailable = "LineageActivityUpdateAvailable"
52617
+ workbookNavigationObjectChanged = "WorkbookNavigationObjectChanged",
52618
+ /**
52619
+ * WorksheetRowHeightChanged represents the type of event registered when the height of a worksheet row is changed.
52620
+ * @remarks
52621
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
52622
+ * @beta
52623
+ */
52624
+ worksheetRowHeightChanged = "WorksheetRowHeightChanged"
52576
52625
  }
52577
52626
  /**
52578
52627
  * @remarks
@@ -65777,7 +65826,7 @@ declare namespace Excel {
65777
65826
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65778
65827
  * @beta
65779
65828
  */
65780
- valueAsJson?: CellValue;
65829
+ valueAsJson?: CellValue | string;
65781
65830
  /**
65782
65831
  * A JSON representation of the values in this named item.
65783
65832
  Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
@@ -65787,7 +65836,7 @@ declare namespace Excel {
65787
65836
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65788
65837
  * @beta
65789
65838
  */
65790
- valueAsJsonLocal?: CellValue[][];
65839
+ valueAsJsonLocal?: CellValue | string;
65791
65840
  /**
65792
65841
  * Specifies if the object is visible.
65793
65842
  *
@@ -83317,6 +83366,14 @@ declare namespace Word {
83317
83366
  * @beta
83318
83367
  */
83319
83368
  readonly endnotes: Word.NoteItemCollection;
83369
+ /**
83370
+ * Gets the collection of field objects in the body. Read-only.
83371
+ *
83372
+ * @remarks
83373
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83374
+ * @beta
83375
+ */
83376
+ readonly fields: Word.FieldCollection;
83320
83377
  /**
83321
83378
  * Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
83322
83379
  *
@@ -83473,7 +83530,7 @@ declare namespace Word {
83473
83530
  * @remarks
83474
83531
  * [Api set: WordApi 1.3]
83475
83532
  *
83476
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
83533
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83477
83534
  */
83478
83535
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
83479
83536
  /**
@@ -83482,7 +83539,7 @@ declare namespace Word {
83482
83539
  * @remarks
83483
83540
  * [Api set: WordApi 1.3]
83484
83541
  *
83485
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
83542
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
83486
83543
  */
83487
83544
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
83488
83545
  /**
@@ -83492,7 +83549,7 @@ declare namespace Word {
83492
83549
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83493
83550
  * @beta
83494
83551
  *
83495
- * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
83552
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
83496
83553
  */
83497
83554
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
83498
83555
  /**
@@ -83502,7 +83559,7 @@ declare namespace Word {
83502
83559
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
83503
83560
  * @beta
83504
83561
  *
83505
- * @param changeTrackingVersion Optional. The changeTrackingVersion can be: Original, Current. The default value is Current.
83562
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
83506
83563
  */
83507
83564
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
83508
83565
  /**
@@ -83512,7 +83569,7 @@ declare namespace Word {
83512
83569
  * [Api set: WordApi 1.1]
83513
83570
  *
83514
83571
  * @param breakType Required. The break type to add to the body.
83515
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83572
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83516
83573
  */
83517
83574
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
83518
83575
  /**
@@ -83522,7 +83579,7 @@ declare namespace Word {
83522
83579
  * [Api set: WordApi 1.1]
83523
83580
  *
83524
83581
  * @param breakType Required. The break type to add to the body.
83525
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83582
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83526
83583
  */
83527
83584
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
83528
83585
  /**
@@ -83539,7 +83596,7 @@ declare namespace Word {
83539
83596
  * [Api set: WordApi 1.1]
83540
83597
  *
83541
83598
  * @param base64File Required. The base64 encoded content of a .docx file.
83542
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83599
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83543
83600
  */
83544
83601
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
83545
83602
  /**
@@ -83549,7 +83606,7 @@ declare namespace Word {
83549
83606
  * [Api set: WordApi 1.1]
83550
83607
  *
83551
83608
  * @param base64File Required. The base64 encoded content of a .docx file.
83552
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83609
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83553
83610
  */
83554
83611
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83555
83612
  /**
@@ -83559,7 +83616,7 @@ declare namespace Word {
83559
83616
  * [Api set: WordApi 1.1]
83560
83617
  *
83561
83618
  * @param html Required. The HTML to be inserted in the document.
83562
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83619
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83563
83620
  */
83564
83621
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
83565
83622
  /**
@@ -83569,7 +83626,7 @@ declare namespace Word {
83569
83626
  * [Api set: WordApi 1.1]
83570
83627
  *
83571
83628
  * @param html Required. The HTML to be inserted in the document.
83572
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83629
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83573
83630
  */
83574
83631
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83575
83632
  /**
@@ -83579,7 +83636,7 @@ declare namespace Word {
83579
83636
  * [Api set: WordApi 1.2]
83580
83637
  *
83581
83638
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83582
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83639
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83583
83640
  */
83584
83641
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
83585
83642
  /**
@@ -83589,7 +83646,7 @@ declare namespace Word {
83589
83646
  * [Api set: WordApi 1.2]
83590
83647
  *
83591
83648
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
83592
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83649
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83593
83650
  */
83594
83651
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
83595
83652
  /**
@@ -83599,7 +83656,7 @@ declare namespace Word {
83599
83656
  * [Api set: WordApi 1.1]
83600
83657
  *
83601
83658
  * @param ooxml Required. The OOXML to be inserted.
83602
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83659
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83603
83660
  */
83604
83661
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
83605
83662
  /**
@@ -83609,7 +83666,7 @@ declare namespace Word {
83609
83666
  * [Api set: WordApi 1.1]
83610
83667
  *
83611
83668
  * @param ooxml Required. The OOXML to be inserted.
83612
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83669
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83613
83670
  */
83614
83671
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83615
83672
  /**
@@ -83619,7 +83676,7 @@ declare namespace Word {
83619
83676
  * [Api set: WordApi 1.1]
83620
83677
  *
83621
83678
  * @param paragraphText Required. The paragraph text to be inserted.
83622
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83679
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83623
83680
  */
83624
83681
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
83625
83682
  /**
@@ -83629,7 +83686,7 @@ declare namespace Word {
83629
83686
  * [Api set: WordApi 1.1]
83630
83687
  *
83631
83688
  * @param paragraphText Required. The paragraph text to be inserted.
83632
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83689
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83633
83690
  */
83634
83691
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
83635
83692
  /**
@@ -83640,7 +83697,7 @@ declare namespace Word {
83640
83697
  *
83641
83698
  * @param rowCount Required. The number of rows in the table.
83642
83699
  * @param columnCount Required. The number of columns in the table.
83643
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83700
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83644
83701
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
83645
83702
  */
83646
83703
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -83652,7 +83709,7 @@ declare namespace Word {
83652
83709
  *
83653
83710
  * @param rowCount Required. The number of rows in the table.
83654
83711
  * @param columnCount Required. The number of columns in the table.
83655
- * @param insertLocation Required. The value can be 'Start' or 'End'.
83712
+ * @param insertLocation Required. The value must be 'Start' or 'End'.
83656
83713
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
83657
83714
  */
83658
83715
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -83663,7 +83720,7 @@ declare namespace Word {
83663
83720
  * [Api set: WordApi 1.1]
83664
83721
  *
83665
83722
  * @param text Required. Text to be inserted.
83666
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83723
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83667
83724
  */
83668
83725
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
83669
83726
  /**
@@ -83673,7 +83730,7 @@ declare namespace Word {
83673
83730
  * [Api set: WordApi 1.1]
83674
83731
  *
83675
83732
  * @param text Required. Text to be inserted.
83676
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
83733
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
83677
83734
  */
83678
83735
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
83679
83736
  /**
@@ -83700,7 +83757,7 @@ declare namespace Word {
83700
83757
  * @remarks
83701
83758
  * [Api set: WordApi 1.1]
83702
83759
  *
83703
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
83760
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
83704
83761
  */
83705
83762
  select(selectionMode?: Word.SelectionMode): void;
83706
83763
  /**
@@ -83709,7 +83766,7 @@ declare namespace Word {
83709
83766
  * @remarks
83710
83767
  * [Api set: WordApi 1.1]
83711
83768
  *
83712
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
83769
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
83713
83770
  */
83714
83771
  select(selectionMode?: "Select" | "Start" | "End"): void;
83715
83772
  /**
@@ -83806,7 +83863,7 @@ declare namespace Word {
83806
83863
  */
83807
83864
  readonly creationDate: Date;
83808
83865
  /**
83809
- * ID
83866
+ * Gets the ID of the comment. Read-only.
83810
83867
  *
83811
83868
  * @remarks
83812
83869
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84040,7 +84097,7 @@ declare namespace Word {
84040
84097
  * @beta
84041
84098
  *
84042
84099
  * @param text Required. The text to be inserted in to the CommentContentRange.
84043
- * @param insertLocation Required. The value can be 'After', 'Before', 'Replace', 'Start', or 'End'.
84100
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
84044
84101
  */
84045
84102
  insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
84046
84103
  /**
@@ -84051,7 +84108,7 @@ declare namespace Word {
84051
84108
  * @beta
84052
84109
  *
84053
84110
  * @param text Required. The text to be inserted in to the CommentContentRange.
84054
- * @param insertLocation Required. The value can be 'After', 'Before', 'Replace', 'Start', or 'End'.
84111
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
84055
84112
  */
84056
84113
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
84057
84114
  /**
@@ -84148,7 +84205,7 @@ declare namespace Word {
84148
84205
  */
84149
84206
  readonly creationDate: Date;
84150
84207
  /**
84151
- * ID
84208
+ * Gets the ID of the comment reply. Read-only.
84152
84209
  *
84153
84210
  * @remarks
84154
84211
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -84300,6 +84357,14 @@ declare namespace Word {
84300
84357
  * @beta
84301
84358
  */
84302
84359
  readonly endnotes: Word.NoteItemCollection;
84360
+ /**
84361
+ * Gets the collection of field objects in the contentcontrol. Read-only.
84362
+ *
84363
+ * @remarks
84364
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84365
+ * @beta
84366
+ */
84367
+ readonly fields: Word.FieldCollection;
84303
84368
  /**
84304
84369
  * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
84305
84370
  *
@@ -84330,7 +84395,7 @@ declare namespace Word {
84330
84395
  */
84331
84396
  readonly lists: Word.ListCollection;
84332
84397
  /**
84333
- * 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.
84398
+ * 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.
84334
84399
  *
84335
84400
  * @remarks
84336
84401
  * [Api set: WordApi 1.1]
@@ -84429,7 +84494,6 @@ declare namespace Word {
84429
84494
  readonly id: number;
84430
84495
  /**
84431
84496
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
84432
- *
84433
84497
  * **Note**: The set operation for this property is not supported in Word on the web.
84434
84498
  *
84435
84499
  * @remarks
@@ -84544,7 +84608,7 @@ declare namespace Word {
84544
84608
  * @remarks
84545
84609
  * [Api set: WordApi 1.3]
84546
84610
  *
84547
- * @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84611
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84548
84612
  */
84549
84613
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
84550
84614
  /**
@@ -84553,7 +84617,7 @@ declare namespace Word {
84553
84617
  * @remarks
84554
84618
  * [Api set: WordApi 1.3]
84555
84619
  *
84556
- * @param rangeLocation Optional. The range location can be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84620
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
84557
84621
  */
84558
84622
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
84559
84623
  /**
@@ -84563,7 +84627,7 @@ declare namespace Word {
84563
84627
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84564
84628
  * @beta
84565
84629
  *
84566
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
84630
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
84567
84631
  */
84568
84632
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
84569
84633
  /**
@@ -84573,7 +84637,7 @@ declare namespace Word {
84573
84637
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
84574
84638
  * @beta
84575
84639
  *
84576
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
84640
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
84577
84641
  */
84578
84642
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
84579
84643
  /**
@@ -84593,7 +84657,7 @@ declare namespace Word {
84593
84657
  * [Api set: WordApi 1.1]
84594
84658
  *
84595
84659
  * @param breakType Required. Type of break.
84596
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
84660
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84597
84661
  */
84598
84662
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
84599
84663
  /**
@@ -84603,7 +84667,7 @@ declare namespace Word {
84603
84667
  * [Api set: WordApi 1.1]
84604
84668
  *
84605
84669
  * @param breakType Required. Type of break.
84606
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
84670
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
84607
84671
  */
84608
84672
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
84609
84673
  /**
@@ -84613,7 +84677,7 @@ declare namespace Word {
84613
84677
  * [Api set: WordApi 1.1]
84614
84678
  *
84615
84679
  * @param base64File Required. The base64 encoded content of a .docx file.
84616
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84680
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84617
84681
  */
84618
84682
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
84619
84683
  /**
@@ -84623,7 +84687,7 @@ declare namespace Word {
84623
84687
  * [Api set: WordApi 1.1]
84624
84688
  *
84625
84689
  * @param base64File Required. The base64 encoded content of a .docx file.
84626
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84690
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84627
84691
  */
84628
84692
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84629
84693
  /**
@@ -84633,7 +84697,7 @@ declare namespace Word {
84633
84697
  * [Api set: WordApi 1.1]
84634
84698
  *
84635
84699
  * @param html Required. The HTML to be inserted in to the content control.
84636
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84700
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84637
84701
  */
84638
84702
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
84639
84703
  /**
@@ -84643,7 +84707,7 @@ declare namespace Word {
84643
84707
  * [Api set: WordApi 1.1]
84644
84708
  *
84645
84709
  * @param html Required. The HTML to be inserted in to the content control.
84646
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84710
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84647
84711
  */
84648
84712
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84649
84713
  /**
@@ -84653,7 +84717,7 @@ declare namespace Word {
84653
84717
  * [Api set: WordApi 1.2]
84654
84718
  *
84655
84719
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84656
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84720
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84657
84721
  */
84658
84722
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
84659
84723
  /**
@@ -84663,7 +84727,7 @@ declare namespace Word {
84663
84727
  * [Api set: WordApi 1.2]
84664
84728
  *
84665
84729
  * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
84666
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84730
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84667
84731
  */
84668
84732
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
84669
84733
  /**
@@ -84673,7 +84737,7 @@ declare namespace Word {
84673
84737
  * [Api set: WordApi 1.1]
84674
84738
  *
84675
84739
  * @param ooxml Required. The OOXML to be inserted in to the content control.
84676
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84740
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84677
84741
  */
84678
84742
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
84679
84743
  /**
@@ -84683,7 +84747,7 @@ declare namespace Word {
84683
84747
  * [Api set: WordApi 1.1]
84684
84748
  *
84685
84749
  * @param ooxml Required. The OOXML to be inserted in to the content control.
84686
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84750
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84687
84751
  */
84688
84752
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84689
84753
  /**
@@ -84693,7 +84757,7 @@ declare namespace Word {
84693
84757
  * [Api set: WordApi 1.1]
84694
84758
  *
84695
84759
  * @param paragraphText Required. The paragraph text to be inserted.
84696
- * @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.
84760
+ * @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.
84697
84761
  */
84698
84762
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
84699
84763
  /**
@@ -84703,7 +84767,7 @@ declare namespace Word {
84703
84767
  * [Api set: WordApi 1.1]
84704
84768
  *
84705
84769
  * @param paragraphText Required. The paragraph text to be inserted.
84706
- * @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.
84770
+ * @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.
84707
84771
  */
84708
84772
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
84709
84773
  /**
@@ -84714,7 +84778,7 @@ declare namespace Word {
84714
84778
  *
84715
84779
  * @param rowCount Required. The number of rows in the table.
84716
84780
  * @param columnCount Required. The number of columns in the table.
84717
- * @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.
84781
+ * @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.
84718
84782
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84719
84783
  */
84720
84784
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -84726,7 +84790,7 @@ declare namespace Word {
84726
84790
  *
84727
84791
  * @param rowCount Required. The number of rows in the table.
84728
84792
  * @param columnCount Required. The number of columns in the table.
84729
- * @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.
84793
+ * @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.
84730
84794
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
84731
84795
  */
84732
84796
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -84737,7 +84801,7 @@ declare namespace Word {
84737
84801
  * [Api set: WordApi 1.1]
84738
84802
  *
84739
84803
  * @param text Required. The text to be inserted in to the content control.
84740
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84804
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84741
84805
  */
84742
84806
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
84743
84807
  /**
@@ -84747,7 +84811,7 @@ declare namespace Word {
84747
84811
  * [Api set: WordApi 1.1]
84748
84812
  *
84749
84813
  * @param text Required. The text to be inserted in to the content control.
84750
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84814
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
84751
84815
  */
84752
84816
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
84753
84817
  /**
@@ -84774,7 +84838,7 @@ declare namespace Word {
84774
84838
  * @remarks
84775
84839
  * [Api set: WordApi 1.1]
84776
84840
  *
84777
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
84841
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
84778
84842
  */
84779
84843
  select(selectionMode?: Word.SelectionMode): void;
84780
84844
  /**
@@ -84783,7 +84847,7 @@ declare namespace Word {
84783
84847
  * @remarks
84784
84848
  * [Api set: WordApi 1.1]
84785
84849
  *
84786
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
84850
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
84787
84851
  */
84788
84852
  select(selectionMode?: "Select" | "Start" | "End"): void;
84789
84853
  /**
@@ -85199,7 +85263,9 @@ declare namespace Word {
85199
85263
  * @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 "/".
85200
85264
  * @param name Required. Name of the attribute.
85201
85265
  */
85202
- deleteAttribute(xpath: string, namespaceMappings: any, name: string): void;
85266
+ deleteAttribute(xpath: string, namespaceMappings: {
85267
+ [key: string]: string;
85268
+ }, name: string): void;
85203
85269
  /**
85204
85270
  * Deletes the element identified by xpath.
85205
85271
  *
@@ -85225,7 +85291,9 @@ declare namespace Word {
85225
85291
  * @param xpath Required. Absolute path to the single element in XPath notation.
85226
85292
  * @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 "/".
85227
85293
  */
85228
- deleteElement(xpath: string, namespaceMappings: any): void;
85294
+ deleteElement(xpath: string, namespaceMappings: {
85295
+ [key: string]: string;
85296
+ }): void;
85229
85297
  /**
85230
85298
  * Gets the full XML content of the custom XML part.
85231
85299
  *
@@ -85261,7 +85329,9 @@ declare namespace Word {
85261
85329
  * @param name Required. Name of the attribute.
85262
85330
  * @param value Required. Value of the attribute.
85263
85331
  */
85264
- insertAttribute(xpath: string, namespaceMappings: any, name: string, value: string): void;
85332
+ insertAttribute(xpath: string, namespaceMappings: {
85333
+ [key: string]: string;
85334
+ }, name: string, value: string): void;
85265
85335
  /**
85266
85336
  * Inserts the given XML under the parent element identified by xpath at child position index.
85267
85337
  *
@@ -85289,7 +85359,9 @@ declare namespace Word {
85289
85359
  * @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 "/".
85290
85360
  * @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.
85291
85361
  */
85292
- insertElement(xpath: string, xml: string, namespaceMappings: any, index?: number): void;
85362
+ insertElement(xpath: string, xml: string, namespaceMappings: {
85363
+ [key: string]: string;
85364
+ }, index?: number): void;
85293
85365
  /**
85294
85366
  * Queries the XML content of the custom XML part.
85295
85367
  *
@@ -85316,7 +85388,9 @@ declare namespace Word {
85316
85388
  * @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 "/".
85317
85389
  * @returns An array where each item represents an entry matched by the XPath query.
85318
85390
  */
85319
- query(xpath: string, namespaceMappings: any): OfficeExtension.ClientResult<string[]>;
85391
+ query(xpath: string, namespaceMappings: {
85392
+ [key: string]: string;
85393
+ }): OfficeExtension.ClientResult<string[]>;
85320
85394
  /**
85321
85395
  * Sets the full XML content of the custom XML part.
85322
85396
  *
@@ -85354,7 +85428,9 @@ declare namespace Word {
85354
85428
  * @param name Required. Name of the attribute.
85355
85429
  * @param value Required. New value of the attribute.
85356
85430
  */
85357
- updateAttribute(xpath: string, namespaceMappings: any, name: string, value: string): void;
85431
+ updateAttribute(xpath: string, namespaceMappings: {
85432
+ [key: string]: string;
85433
+ }, name: string, value: string): void;
85358
85434
  /**
85359
85435
  * Updates the XML of the element identified by xpath.
85360
85436
  *
@@ -85381,7 +85457,9 @@ declare namespace Word {
85381
85457
  * @param xml Required. New XML content to be stored.
85382
85458
  * @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 "/".
85383
85459
  */
85384
- updateElement(xpath: string, xml: string, namespaceMappings: any): void;
85460
+ updateElement(xpath: string, xml: string, namespaceMappings: {
85461
+ [key: string]: string;
85462
+ }): void;
85385
85463
  /**
85386
85464
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
85387
85465
  *
@@ -86121,6 +86199,215 @@ declare namespace Word {
86121
86199
  */
86122
86200
  toJSON(): Word.Interfaces.DocumentPropertiesData;
86123
86201
  }
86202
+ /**
86203
+ * Represents a field.
86204
+ *
86205
+ * @remarks
86206
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86207
+ * @beta
86208
+ */
86209
+ class Field extends OfficeExtension.ClientObject {
86210
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86211
+ context: RequestContext;
86212
+ /**
86213
+ * Gets the parent body of the field. Read-only.
86214
+ *
86215
+ * @remarks
86216
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86217
+ * @beta
86218
+ */
86219
+ readonly parentBody: Word.Body;
86220
+ /**
86221
+ * Gets the content control that contains the field. Throws an error if there isn't a parent content control. Read-only.
86222
+ *
86223
+ * @remarks
86224
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86225
+ * @beta
86226
+ */
86227
+ readonly parentContentControl: Word.ContentControl;
86228
+ /**
86229
+ * Gets the content control that contains the field. Returns a null object if there isn't a parent content control. Read-only.
86230
+ *
86231
+ * @remarks
86232
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86233
+ * @beta
86234
+ */
86235
+ readonly parentContentControlOrNullObject: Word.ContentControl;
86236
+ /**
86237
+ * Gets the table that contains the field. Throws an error if it is not contained in a table. Read-only.
86238
+ *
86239
+ * @remarks
86240
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86241
+ * @beta
86242
+ */
86243
+ readonly parentTable: Word.Table;
86244
+ /**
86245
+ * Gets the table cell that contains the field. Throws an error if it is not contained in a table cell. Read-only.
86246
+ *
86247
+ * @remarks
86248
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86249
+ * @beta
86250
+ */
86251
+ readonly parentTableCell: Word.TableCell;
86252
+ /**
86253
+ * Gets the table cell that contains the field. Returns a null object if it is not contained in a table cell. Read-only.
86254
+ *
86255
+ * @remarks
86256
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86257
+ * @beta
86258
+ */
86259
+ readonly parentTableCellOrNullObject: Word.TableCell;
86260
+ /**
86261
+ * Gets the table that contains the field. Returns a null object if it is not contained in a table. Read-only.
86262
+ *
86263
+ * @remarks
86264
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86265
+ * @beta
86266
+ */
86267
+ readonly parentTableOrNullObject: Word.Table;
86268
+ /**
86269
+ * Gets the field's code instruction. Read-only.
86270
+ *
86271
+ * @remarks
86272
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86273
+ * @beta
86274
+ */
86275
+ readonly code: string;
86276
+ /**
86277
+ * Gets the field's result data. Read-only.
86278
+ *
86279
+ * @remarks
86280
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86281
+ * @beta
86282
+ */
86283
+ readonly result: string;
86284
+ /**
86285
+ * Deletes the field.
86286
+ *
86287
+ * @remarks
86288
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86289
+ * @beta
86290
+ */
86291
+ delete(): void;
86292
+ /**
86293
+ * Gets the next field. Throws an error if this field is the last one.
86294
+ *
86295
+ * @remarks
86296
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86297
+ * @beta
86298
+ */
86299
+ getNext(): Word.Field;
86300
+ /**
86301
+ * Gets the next field. Returns a null object if this field is the last one.
86302
+ *
86303
+ * @remarks
86304
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86305
+ * @beta
86306
+ */
86307
+ getNextOrNullObject(): Word.Field;
86308
+ /**
86309
+ * Gets the whole field as a range.
86310
+ *
86311
+ * @remarks
86312
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86313
+ * @beta
86314
+ */
86315
+ getRange(): Word.Range;
86316
+ /**
86317
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86318
+ *
86319
+ * @param options Provides options for which properties of the object to load.
86320
+ */
86321
+ load(options?: Word.Interfaces.FieldLoadOptions): Word.Field;
86322
+ /**
86323
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86324
+ *
86325
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86326
+ */
86327
+ load(propertyNames?: string | string[]): Word.Field;
86328
+ /**
86329
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86330
+ *
86331
+ * @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.
86332
+ */
86333
+ load(propertyNamesAndPaths?: {
86334
+ select?: string;
86335
+ expand?: string;
86336
+ }): Word.Field;
86337
+ /**
86338
+ * 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.
86339
+ */
86340
+ track(): Word.Field;
86341
+ /**
86342
+ * 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.
86343
+ */
86344
+ untrack(): Word.Field;
86345
+ /**
86346
+ * 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.)
86347
+ * 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.
86348
+ */
86349
+ toJSON(): Word.Interfaces.FieldData;
86350
+ }
86351
+ /**
86352
+ * Contains a collection of {@link Word.Field} objects.
86353
+ *
86354
+ * @remarks
86355
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86356
+ * @beta
86357
+ */
86358
+ class FieldCollection extends OfficeExtension.ClientObject {
86359
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86360
+ context: RequestContext;
86361
+ /** Gets the loaded child items in this collection. */
86362
+ readonly items: Word.Field[];
86363
+ /**
86364
+ * Gets the first field in this collection. Throws an error if this collection is empty.
86365
+ *
86366
+ * @remarks
86367
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86368
+ * @beta
86369
+ */
86370
+ getFirst(): Word.Field;
86371
+ /**
86372
+ * Gets the first field in this collection. Returns a null object if this collection is empty.
86373
+ *
86374
+ * @remarks
86375
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
86376
+ * @beta
86377
+ */
86378
+ getFirstOrNullObject(): Word.Field;
86379
+ /**
86380
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86381
+ *
86382
+ * @param options Provides options for which properties of the object to load.
86383
+ */
86384
+ load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection;
86385
+ /**
86386
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86387
+ *
86388
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86389
+ */
86390
+ load(propertyNames?: string | string[]): Word.FieldCollection;
86391
+ /**
86392
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86393
+ *
86394
+ * @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.
86395
+ */
86396
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection;
86397
+ /**
86398
+ * 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.
86399
+ */
86400
+ track(): Word.FieldCollection;
86401
+ /**
86402
+ * 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.
86403
+ */
86404
+ untrack(): Word.FieldCollection;
86405
+ /**
86406
+ * 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.)
86407
+ * 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.
86408
+ */
86409
+ toJSON(): Word.Interfaces.FieldCollectionData;
86410
+ }
86124
86411
  /**
86125
86412
  * Represents a font.
86126
86413
  *
@@ -86153,7 +86440,7 @@ declare namespace Word {
86153
86440
  doubleStrikeThrough: boolean;
86154
86441
  /**
86155
86442
  * 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.
86156
- **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.
86443
+ * **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.
86157
86444
  *
86158
86445
  * @remarks
86159
86446
  * [Api set: WordApi 1.1]
@@ -86401,7 +86688,7 @@ declare namespace Word {
86401
86688
  * @remarks
86402
86689
  * [Api set: WordApi 1.3]
86403
86690
  *
86404
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', or 'End'.
86691
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86405
86692
  */
86406
86693
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
86407
86694
  /**
@@ -86410,7 +86697,7 @@ declare namespace Word {
86410
86697
  * @remarks
86411
86698
  * [Api set: WordApi 1.3]
86412
86699
  *
86413
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', or 'End'.
86700
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
86414
86701
  */
86415
86702
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
86416
86703
  /**
@@ -86420,7 +86707,7 @@ declare namespace Word {
86420
86707
  * [Api set: WordApi 1.2]
86421
86708
  *
86422
86709
  * @param breakType Required. The break type to add.
86423
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86710
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86424
86711
  */
86425
86712
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
86426
86713
  /**
@@ -86430,7 +86717,7 @@ declare namespace Word {
86430
86717
  * [Api set: WordApi 1.2]
86431
86718
  *
86432
86719
  * @param breakType Required. The break type to add.
86433
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86720
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86434
86721
  */
86435
86722
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
86436
86723
  /**
@@ -86447,7 +86734,7 @@ declare namespace Word {
86447
86734
  * [Api set: WordApi 1.2]
86448
86735
  *
86449
86736
  * @param base64File Required. The base64 encoded content of a .docx file.
86450
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86737
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86451
86738
  */
86452
86739
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
86453
86740
  /**
@@ -86457,7 +86744,7 @@ declare namespace Word {
86457
86744
  * [Api set: WordApi 1.2]
86458
86745
  *
86459
86746
  * @param base64File Required. The base64 encoded content of a .docx file.
86460
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86747
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86461
86748
  */
86462
86749
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86463
86750
  /**
@@ -86467,7 +86754,7 @@ declare namespace Word {
86467
86754
  * [Api set: WordApi 1.2]
86468
86755
  *
86469
86756
  * @param html Required. The HTML to be inserted.
86470
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86757
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86471
86758
  */
86472
86759
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
86473
86760
  /**
@@ -86477,7 +86764,7 @@ declare namespace Word {
86477
86764
  * [Api set: WordApi 1.2]
86478
86765
  *
86479
86766
  * @param html Required. The HTML to be inserted.
86480
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86767
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86481
86768
  */
86482
86769
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86483
86770
  /**
@@ -86487,7 +86774,7 @@ declare namespace Word {
86487
86774
  * [Api set: WordApi 1.2]
86488
86775
  *
86489
86776
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
86490
- * @param insertLocation Required. The value can be 'Replace', 'Before', or 'After'.
86777
+ * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
86491
86778
  */
86492
86779
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
86493
86780
  /**
@@ -86497,7 +86784,7 @@ declare namespace Word {
86497
86784
  * [Api set: WordApi 1.2]
86498
86785
  *
86499
86786
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
86500
- * @param insertLocation Required. The value can be 'Replace', 'Before', or 'After'.
86787
+ * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
86501
86788
  */
86502
86789
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
86503
86790
  /**
@@ -86507,7 +86794,7 @@ declare namespace Word {
86507
86794
  * [Api set: WordApi 1.2]
86508
86795
  *
86509
86796
  * @param ooxml Required. The OOXML to be inserted.
86510
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86797
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86511
86798
  */
86512
86799
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
86513
86800
  /**
@@ -86517,7 +86804,7 @@ declare namespace Word {
86517
86804
  * [Api set: WordApi 1.2]
86518
86805
  *
86519
86806
  * @param ooxml Required. The OOXML to be inserted.
86520
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86807
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86521
86808
  */
86522
86809
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86523
86810
  /**
@@ -86527,7 +86814,7 @@ declare namespace Word {
86527
86814
  * [Api set: WordApi 1.2]
86528
86815
  *
86529
86816
  * @param paragraphText Required. The paragraph text to be inserted.
86530
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86817
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86531
86818
  */
86532
86819
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
86533
86820
  /**
@@ -86537,7 +86824,7 @@ declare namespace Word {
86537
86824
  * [Api set: WordApi 1.2]
86538
86825
  *
86539
86826
  * @param paragraphText Required. The paragraph text to be inserted.
86540
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86827
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86541
86828
  */
86542
86829
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
86543
86830
  /**
@@ -86547,7 +86834,7 @@ declare namespace Word {
86547
86834
  * [Api set: WordApi 1.2]
86548
86835
  *
86549
86836
  * @param text Required. Text to be inserted.
86550
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86837
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86551
86838
  */
86552
86839
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
86553
86840
  /**
@@ -86557,7 +86844,7 @@ declare namespace Word {
86557
86844
  * [Api set: WordApi 1.2]
86558
86845
  *
86559
86846
  * @param text Required. Text to be inserted.
86560
- * @param insertLocation Required. The value can be 'Before' or 'After'.
86847
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
86561
86848
  */
86562
86849
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
86563
86850
  /**
@@ -86566,7 +86853,7 @@ declare namespace Word {
86566
86853
  * @remarks
86567
86854
  * [Api set: WordApi 1.2]
86568
86855
  *
86569
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
86856
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
86570
86857
  */
86571
86858
  select(selectionMode?: Word.SelectionMode): void;
86572
86859
  /**
@@ -86575,7 +86862,7 @@ declare namespace Word {
86575
86862
  * @remarks
86576
86863
  * [Api set: WordApi 1.2]
86577
86864
  *
86578
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
86865
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
86579
86866
  */
86580
86867
  select(selectionMode?: "Select" | "Start" | "End"): void;
86581
86868
  /**
@@ -86752,7 +87039,7 @@ declare namespace Word {
86752
87039
  * [Api set: WordApi 1.3]
86753
87040
  *
86754
87041
  * @param paragraphText Required. The paragraph text to be inserted.
86755
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
87042
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
86756
87043
  */
86757
87044
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
86758
87045
  /**
@@ -86762,7 +87049,7 @@ declare namespace Word {
86762
87049
  * [Api set: WordApi 1.3]
86763
87050
  *
86764
87051
  * @param paragraphText Required. The paragraph text to be inserted.
86765
- * @param insertLocation Required. The value can be 'Start', 'End', 'Before', or 'After'.
87052
+ * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
86766
87053
  */
86767
87054
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
86768
87055
  /**
@@ -86783,7 +87070,7 @@ declare namespace Word {
86783
87070
  * [Api set: WordApi 1.3]
86784
87071
  *
86785
87072
  * @param level Required. The level in the list.
86786
- * @param alignment Required. The level alignment that can be 'Left', 'Centered', or 'Right'.
87073
+ * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'.
86787
87074
  */
86788
87075
  setLevelAlignment(level: number, alignment: Word.Alignment): void;
86789
87076
  /**
@@ -86793,7 +87080,7 @@ declare namespace Word {
86793
87080
  * [Api set: WordApi 1.3]
86794
87081
  *
86795
87082
  * @param level Required. The level in the list.
86796
- * @param alignment Required. The level alignment that can be 'Left', 'Centered', or 'Right'.
87083
+ * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'.
86797
87084
  */
86798
87085
  setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;
86799
87086
  /**
@@ -87278,6 +87565,14 @@ declare namespace Word {
87278
87565
  * @beta
87279
87566
  */
87280
87567
  readonly endnotes: Word.NoteItemCollection;
87568
+ /**
87569
+ * Gets the collection of fields in the paragraph. Read-only.
87570
+ *
87571
+ * @remarks
87572
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87573
+ * @beta
87574
+ */
87575
+ readonly fields: Word.FieldCollection;
87281
87576
  /**
87282
87577
  * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
87283
87578
  *
@@ -87584,7 +87879,7 @@ declare namespace Word {
87584
87879
  * @remarks
87585
87880
  * [Api set: WordApi 1.3]
87586
87881
  *
87587
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
87882
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
87588
87883
  */
87589
87884
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
87590
87885
  /**
@@ -87593,7 +87888,7 @@ declare namespace Word {
87593
87888
  * @remarks
87594
87889
  * [Api set: WordApi 1.3]
87595
87890
  *
87596
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
87891
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
87597
87892
  */
87598
87893
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
87599
87894
  /**
@@ -87603,7 +87898,7 @@ declare namespace Word {
87603
87898
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87604
87899
  * @beta
87605
87900
  *
87606
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
87901
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
87607
87902
  */
87608
87903
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
87609
87904
  /**
@@ -87613,7 +87908,7 @@ declare namespace Word {
87613
87908
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
87614
87909
  * @beta
87615
87910
  *
87616
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
87911
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
87617
87912
  */
87618
87913
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
87619
87914
  /**
@@ -87633,7 +87928,7 @@ declare namespace Word {
87633
87928
  * [Api set: WordApi 1.1]
87634
87929
  *
87635
87930
  * @param breakType Required. The break type to add to the document.
87636
- * @param insertLocation Required. The value can be 'Before' or 'After'.
87931
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87637
87932
  */
87638
87933
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
87639
87934
  /**
@@ -87643,7 +87938,7 @@ declare namespace Word {
87643
87938
  * [Api set: WordApi 1.1]
87644
87939
  *
87645
87940
  * @param breakType Required. The break type to add to the document.
87646
- * @param insertLocation Required. The value can be 'Before' or 'After'.
87941
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87647
87942
  */
87648
87943
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
87649
87944
  /**
@@ -87660,7 +87955,7 @@ declare namespace Word {
87660
87955
  * [Api set: WordApi 1.1]
87661
87956
  *
87662
87957
  * @param base64File Required. The base64 encoded content of a .docx file.
87663
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87958
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87664
87959
  */
87665
87960
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
87666
87961
  /**
@@ -87670,7 +87965,7 @@ declare namespace Word {
87670
87965
  * [Api set: WordApi 1.1]
87671
87966
  *
87672
87967
  * @param base64File Required. The base64 encoded content of a .docx file.
87673
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87968
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87674
87969
  */
87675
87970
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87676
87971
  /**
@@ -87680,7 +87975,7 @@ declare namespace Word {
87680
87975
  * [Api set: WordApi 1.1]
87681
87976
  *
87682
87977
  * @param html Required. The HTML to be inserted in the paragraph.
87683
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87978
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87684
87979
  */
87685
87980
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
87686
87981
  /**
@@ -87690,7 +87985,7 @@ declare namespace Word {
87690
87985
  * [Api set: WordApi 1.1]
87691
87986
  *
87692
87987
  * @param html Required. The HTML to be inserted in the paragraph.
87693
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87988
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87694
87989
  */
87695
87990
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87696
87991
  /**
@@ -87700,7 +87995,7 @@ declare namespace Word {
87700
87995
  * [Api set: WordApi 1.1]
87701
87996
  *
87702
87997
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87703
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
87998
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87704
87999
  */
87705
88000
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
87706
88001
  /**
@@ -87710,7 +88005,7 @@ declare namespace Word {
87710
88005
  * [Api set: WordApi 1.1]
87711
88006
  *
87712
88007
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
87713
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88008
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87714
88009
  */
87715
88010
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
87716
88011
  /**
@@ -87720,7 +88015,7 @@ declare namespace Word {
87720
88015
  * [Api set: WordApi 1.1]
87721
88016
  *
87722
88017
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
87723
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88018
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87724
88019
  */
87725
88020
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
87726
88021
  /**
@@ -87730,7 +88025,7 @@ declare namespace Word {
87730
88025
  * [Api set: WordApi 1.1]
87731
88026
  *
87732
88027
  * @param ooxml Required. The OOXML to be inserted in the paragraph.
87733
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88028
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87734
88029
  */
87735
88030
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87736
88031
  /**
@@ -87740,7 +88035,7 @@ declare namespace Word {
87740
88035
  * [Api set: WordApi 1.1]
87741
88036
  *
87742
88037
  * @param paragraphText Required. The paragraph text to be inserted.
87743
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88038
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87744
88039
  */
87745
88040
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
87746
88041
  /**
@@ -87750,7 +88045,7 @@ declare namespace Word {
87750
88045
  * [Api set: WordApi 1.1]
87751
88046
  *
87752
88047
  * @param paragraphText Required. The paragraph text to be inserted.
87753
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88048
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87754
88049
  */
87755
88050
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
87756
88051
  /**
@@ -87761,7 +88056,7 @@ declare namespace Word {
87761
88056
  *
87762
88057
  * @param rowCount Required. The number of rows in the table.
87763
88058
  * @param columnCount Required. The number of columns in the table.
87764
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88059
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87765
88060
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
87766
88061
  */
87767
88062
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -87773,7 +88068,7 @@ declare namespace Word {
87773
88068
  *
87774
88069
  * @param rowCount Required. The number of rows in the table.
87775
88070
  * @param columnCount Required. The number of columns in the table.
87776
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88071
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
87777
88072
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
87778
88073
  */
87779
88074
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -87784,7 +88079,7 @@ declare namespace Word {
87784
88079
  * [Api set: WordApi 1.1]
87785
88080
  *
87786
88081
  * @param text Required. Text to be inserted.
87787
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88082
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87788
88083
  */
87789
88084
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
87790
88085
  /**
@@ -87794,7 +88089,7 @@ declare namespace Word {
87794
88089
  * [Api set: WordApi 1.1]
87795
88090
  *
87796
88091
  * @param text Required. Text to be inserted.
87797
- * @param insertLocation Required. The value can be 'Replace', 'Start', or 'End'.
88092
+ * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
87798
88093
  */
87799
88094
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
87800
88095
  /**
@@ -87821,7 +88116,7 @@ declare namespace Word {
87821
88116
  * @remarks
87822
88117
  * [Api set: WordApi 1.1]
87823
88118
  *
87824
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88119
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
87825
88120
  */
87826
88121
  select(selectionMode?: Word.SelectionMode): void;
87827
88122
  /**
@@ -87830,7 +88125,7 @@ declare namespace Word {
87830
88125
  * @remarks
87831
88126
  * [Api set: WordApi 1.1]
87832
88127
  *
87833
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88128
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
87834
88129
  */
87835
88130
  select(selectionMode?: "Select" | "Start" | "End"): void;
87836
88131
  /**
@@ -87981,6 +88276,14 @@ declare namespace Word {
87981
88276
  * @beta
87982
88277
  */
87983
88278
  readonly endnotes: Word.NoteItemCollection;
88279
+ /**
88280
+ * Gets the collection of field objects in the range. Read-only.
88281
+ *
88282
+ * @remarks
88283
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88284
+ * @beta
88285
+ */
88286
+ readonly fields: Word.FieldCollection;
87984
88287
  /**
87985
88288
  * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
87986
88289
  *
@@ -88224,7 +88527,7 @@ declare namespace Word {
88224
88527
  * @remarks
88225
88528
  * [Api set: WordApi 1.3]
88226
88529
  *
88227
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
88530
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88228
88531
  */
88229
88532
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
88230
88533
  /**
@@ -88233,7 +88536,7 @@ declare namespace Word {
88233
88536
  * @remarks
88234
88537
  * [Api set: WordApi 1.3]
88235
88538
  *
88236
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', 'After', or 'Content'.
88539
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
88237
88540
  */
88238
88541
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
88239
88542
  /**
@@ -88243,7 +88546,7 @@ declare namespace Word {
88243
88546
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88244
88547
  * @beta
88245
88548
  *
88246
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
88549
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
88247
88550
  */
88248
88551
  getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
88249
88552
  /**
@@ -88253,7 +88556,7 @@ declare namespace Word {
88253
88556
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88254
88557
  * @beta
88255
88558
  *
88256
- * @param changeTrackingVersion Optional. The changeTrackingVersion might be: Original, Current. The default value is Current.
88559
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
88257
88560
  */
88258
88561
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
88259
88562
  /**
@@ -88283,7 +88586,7 @@ declare namespace Word {
88283
88586
  * [Api set: WordApi 1.1]
88284
88587
  *
88285
88588
  * @param breakType Required. The break type to add.
88286
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88589
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88287
88590
  */
88288
88591
  insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
88289
88592
  /**
@@ -88293,7 +88596,7 @@ declare namespace Word {
88293
88596
  * [Api set: WordApi 1.1]
88294
88597
  *
88295
88598
  * @param breakType Required. The break type to add.
88296
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88599
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88297
88600
  */
88298
88601
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
88299
88602
  /**
@@ -88320,6 +88623,8 @@ declare namespace Word {
88320
88623
  * @remarks
88321
88624
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88322
88625
  * @beta
88626
+ *
88627
+ * @param insertText Optional. Text to be inserted into the endnote body. The default is "".
88323
88628
  */
88324
88629
  insertEndnote(insertText?: string): Word.NoteItem;
88325
88630
  /**
@@ -88329,7 +88634,7 @@ declare namespace Word {
88329
88634
  * [Api set: WordApi 1.1]
88330
88635
  *
88331
88636
  * @param base64File Required. The base64 encoded content of a .docx file.
88332
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88637
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88333
88638
  */
88334
88639
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
88335
88640
  /**
@@ -88339,7 +88644,7 @@ declare namespace Word {
88339
88644
  * [Api set: WordApi 1.1]
88340
88645
  *
88341
88646
  * @param base64File Required. The base64 encoded content of a .docx file.
88342
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88647
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88343
88648
  */
88344
88649
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88345
88650
  /**
@@ -88348,6 +88653,8 @@ declare namespace Word {
88348
88653
  * @remarks
88349
88654
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
88350
88655
  * @beta
88656
+ *
88657
+ * @param insertText Optional. Text to be inserted into the footnote body. The default is "".
88351
88658
  */
88352
88659
  insertFootnote(insertText?: string): Word.NoteItem;
88353
88660
  /**
@@ -88357,7 +88664,7 @@ declare namespace Word {
88357
88664
  * [Api set: WordApi 1.1]
88358
88665
  *
88359
88666
  * @param html Required. The HTML to be inserted.
88360
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88667
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88361
88668
  */
88362
88669
  insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
88363
88670
  /**
@@ -88367,7 +88674,7 @@ declare namespace Word {
88367
88674
  * [Api set: WordApi 1.1]
88368
88675
  *
88369
88676
  * @param html Required. The HTML to be inserted.
88370
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88677
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88371
88678
  */
88372
88679
  insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88373
88680
  /**
@@ -88377,7 +88684,7 @@ declare namespace Word {
88377
88684
  * [Api set: WordApi 1.2]
88378
88685
  *
88379
88686
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88380
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88687
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88381
88688
  */
88382
88689
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
88383
88690
  /**
@@ -88387,7 +88694,7 @@ declare namespace Word {
88387
88694
  * [Api set: WordApi 1.2]
88388
88695
  *
88389
88696
  * @param base64EncodedImage Required. The base64 encoded image to be inserted.
88390
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88697
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88391
88698
  */
88392
88699
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
88393
88700
  /**
@@ -88397,7 +88704,7 @@ declare namespace Word {
88397
88704
  * [Api set: WordApi 1.1]
88398
88705
  *
88399
88706
  * @param ooxml Required. The OOXML to be inserted.
88400
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88707
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88401
88708
  */
88402
88709
  insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
88403
88710
  /**
@@ -88407,7 +88714,7 @@ declare namespace Word {
88407
88714
  * [Api set: WordApi 1.1]
88408
88715
  *
88409
88716
  * @param ooxml Required. The OOXML to be inserted.
88410
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88717
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88411
88718
  */
88412
88719
  insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88413
88720
  /**
@@ -88417,7 +88724,7 @@ declare namespace Word {
88417
88724
  * [Api set: WordApi 1.1]
88418
88725
  *
88419
88726
  * @param paragraphText Required. The paragraph text to be inserted.
88420
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88727
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88421
88728
  */
88422
88729
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
88423
88730
  /**
@@ -88427,7 +88734,7 @@ declare namespace Word {
88427
88734
  * [Api set: WordApi 1.1]
88428
88735
  *
88429
88736
  * @param paragraphText Required. The paragraph text to be inserted.
88430
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88737
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88431
88738
  */
88432
88739
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
88433
88740
  /**
@@ -88438,7 +88745,7 @@ declare namespace Word {
88438
88745
  *
88439
88746
  * @param rowCount Required. The number of rows in the table.
88440
88747
  * @param columnCount Required. The number of columns in the table.
88441
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88748
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88442
88749
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88443
88750
  */
88444
88751
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -88450,7 +88757,7 @@ declare namespace Word {
88450
88757
  *
88451
88758
  * @param rowCount Required. The number of rows in the table.
88452
88759
  * @param columnCount Required. The number of columns in the table.
88453
- * @param insertLocation Required. The value can be 'Before' or 'After'.
88760
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
88454
88761
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
88455
88762
  */
88456
88763
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -88461,7 +88768,7 @@ declare namespace Word {
88461
88768
  * [Api set: WordApi 1.1]
88462
88769
  *
88463
88770
  * @param text Required. Text to be inserted.
88464
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88771
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88465
88772
  */
88466
88773
  insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
88467
88774
  /**
@@ -88471,7 +88778,7 @@ declare namespace Word {
88471
88778
  * [Api set: WordApi 1.1]
88472
88779
  *
88473
88780
  * @param text Required. Text to be inserted.
88474
- * @param insertLocation Required. The value can be 'Replace', 'Start', 'End', 'Before', or 'After'.
88781
+ * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
88475
88782
  */
88476
88783
  insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
88477
88784
  /**
@@ -88516,7 +88823,7 @@ declare namespace Word {
88516
88823
  * @remarks
88517
88824
  * [Api set: WordApi 1.1]
88518
88825
  *
88519
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88826
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
88520
88827
  */
88521
88828
  select(selectionMode?: Word.SelectionMode): void;
88522
88829
  /**
@@ -88525,7 +88832,7 @@ declare namespace Word {
88525
88832
  * @remarks
88526
88833
  * [Api set: WordApi 1.1]
88527
88834
  *
88528
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
88835
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
88529
88836
  */
88530
88837
  select(selectionMode?: "Select" | "Start" | "End"): void;
88531
88838
  /**
@@ -88761,7 +89068,7 @@ declare namespace Word {
88761
89068
  * @remarks
88762
89069
  * [Api set: WordApi 1.1]
88763
89070
  *
88764
- * @param type Required. The type of footer to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89071
+ * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88765
89072
  */
88766
89073
  getFooter(type: Word.HeaderFooterType): Word.Body;
88767
89074
  /**
@@ -88770,7 +89077,7 @@ declare namespace Word {
88770
89077
  * @remarks
88771
89078
  * [Api set: WordApi 1.1]
88772
89079
  *
88773
- * @param type Required. The type of footer to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89080
+ * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88774
89081
  */
88775
89082
  getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;
88776
89083
  /**
@@ -88779,7 +89086,7 @@ declare namespace Word {
88779
89086
  * @remarks
88780
89087
  * [Api set: WordApi 1.1]
88781
89088
  *
88782
- * @param type Required. The type of header to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89089
+ * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88783
89090
  */
88784
89091
  getHeader(type: Word.HeaderFooterType): Word.Body;
88785
89092
  /**
@@ -88788,7 +89095,7 @@ declare namespace Word {
88788
89095
  * @remarks
88789
89096
  * [Api set: WordApi 1.1]
88790
89097
  *
88791
- * @param type Required. The type of header to return. This value can be: 'Primary', 'FirstPage', or 'EvenPages'.
89098
+ * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'.
88792
89099
  */
88793
89100
  getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;
88794
89101
  /**
@@ -89082,6 +89389,14 @@ declare namespace Word {
89082
89389
  * @beta
89083
89390
  */
89084
89391
  readonly endnotes: Word.NoteItemCollection;
89392
+ /**
89393
+ * Gets the collection of field objects in the table. Read-only.
89394
+ *
89395
+ * @remarks
89396
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
89397
+ * @beta
89398
+ */
89399
+ readonly fields: Word.FieldCollection;
89085
89400
  /**
89086
89401
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
89087
89402
  *
@@ -89293,7 +89608,7 @@ declare namespace Word {
89293
89608
  * @remarks
89294
89609
  * [Api set: WordApi 1.3]
89295
89610
  *
89296
- * @param insertLocation Required. It can be 'Start' or 'End', corresponding to the appropriate side of the table.
89611
+ * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
89297
89612
  * @param columnCount Required. Number of columns to add.
89298
89613
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89299
89614
  */
@@ -89304,7 +89619,7 @@ declare namespace Word {
89304
89619
  * @remarks
89305
89620
  * [Api set: WordApi 1.3]
89306
89621
  *
89307
- * @param insertLocation Required. It can be 'Start' or 'End', corresponding to the appropriate side of the table.
89622
+ * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
89308
89623
  * @param columnCount Required. Number of columns to add.
89309
89624
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89310
89625
  */
@@ -89315,7 +89630,7 @@ declare namespace Word {
89315
89630
  * @remarks
89316
89631
  * [Api set: WordApi 1.3]
89317
89632
  *
89318
- * @param insertLocation Required. It can be 'Start' or 'End'.
89633
+ * @param insertLocation Required. It must be 'Start' or 'End'.
89319
89634
  * @param rowCount Required. Number of rows to add.
89320
89635
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89321
89636
  */
@@ -89326,7 +89641,7 @@ declare namespace Word {
89326
89641
  * @remarks
89327
89642
  * [Api set: WordApi 1.3]
89328
89643
  *
89329
- * @param insertLocation Required. It can be 'Start' or 'End'.
89644
+ * @param insertLocation Required. It must be 'Start' or 'End'.
89330
89645
  * @param rowCount Required. Number of rows to add.
89331
89646
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89332
89647
  */
@@ -89423,7 +89738,7 @@ declare namespace Word {
89423
89738
  * @remarks
89424
89739
  * [Api set: WordApi 1.3]
89425
89740
  *
89426
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89741
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89427
89742
  */
89428
89743
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
89429
89744
  /**
@@ -89432,7 +89747,7 @@ declare namespace Word {
89432
89747
  * @remarks
89433
89748
  * [Api set: WordApi 1.3]
89434
89749
  *
89435
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89750
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89436
89751
  */
89437
89752
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
89438
89753
  /**
@@ -89483,7 +89798,7 @@ declare namespace Word {
89483
89798
  * @remarks
89484
89799
  * [Api set: WordApi 1.3]
89485
89800
  *
89486
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', or 'After'.
89801
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
89487
89802
  */
89488
89803
  getRange(rangeLocation?: Word.RangeLocation): Word.Range;
89489
89804
  /**
@@ -89492,7 +89807,7 @@ declare namespace Word {
89492
89807
  * @remarks
89493
89808
  * [Api set: WordApi 1.3]
89494
89809
  *
89495
- * @param rangeLocation Optional. The range location can be 'Whole', 'Start', 'End', or 'After'.
89810
+ * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
89496
89811
  */
89497
89812
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
89498
89813
  /**
@@ -89509,7 +89824,7 @@ declare namespace Word {
89509
89824
  * [Api set: WordApi 1.3]
89510
89825
  *
89511
89826
  * @param paragraphText Required. The paragraph text to be inserted.
89512
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89827
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89513
89828
  */
89514
89829
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
89515
89830
  /**
@@ -89519,7 +89834,7 @@ declare namespace Word {
89519
89834
  * [Api set: WordApi 1.3]
89520
89835
  *
89521
89836
  * @param paragraphText Required. The paragraph text to be inserted.
89522
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89837
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89523
89838
  */
89524
89839
  insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
89525
89840
  /**
@@ -89530,7 +89845,7 @@ declare namespace Word {
89530
89845
  *
89531
89846
  * @param rowCount Required. The number of rows in the table.
89532
89847
  * @param columnCount Required. The number of columns in the table.
89533
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89848
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89534
89849
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89535
89850
  */
89536
89851
  insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
@@ -89542,7 +89857,7 @@ declare namespace Word {
89542
89857
  *
89543
89858
  * @param rowCount Required. The number of rows in the table.
89544
89859
  * @param columnCount Required. The number of columns in the table.
89545
- * @param insertLocation Required. The value can be 'Before' or 'After'.
89860
+ * @param insertLocation Required. The value must be 'Before' or 'After'.
89546
89861
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
89547
89862
  */
89548
89863
  insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
@@ -89583,7 +89898,7 @@ declare namespace Word {
89583
89898
  * @remarks
89584
89899
  * [Api set: WordApi 1.3]
89585
89900
  *
89586
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
89901
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89587
89902
  */
89588
89903
  select(selectionMode?: Word.SelectionMode): void;
89589
89904
  /**
@@ -89592,7 +89907,7 @@ declare namespace Word {
89592
89907
  * @remarks
89593
89908
  * [Api set: WordApi 1.3]
89594
89909
  *
89595
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
89910
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89596
89911
  */
89597
89912
  select(selectionMode?: "Select" | "Start" | "End"): void;
89598
89913
  /**
@@ -89601,7 +89916,7 @@ declare namespace Word {
89601
89916
  * @remarks
89602
89917
  * [Api set: WordApi 1.3]
89603
89918
  *
89604
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89919
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89605
89920
  * @param cellPadding Required. The cell padding.
89606
89921
  */
89607
89922
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -89611,7 +89926,7 @@ declare namespace Word {
89611
89926
  * @remarks
89612
89927
  * [Api set: WordApi 1.3]
89613
89928
  *
89614
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
89929
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89615
89930
  * @param cellPadding Required. The cell padding.
89616
89931
  */
89617
89932
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -89731,6 +90046,14 @@ declare namespace Word {
89731
90046
  * @beta
89732
90047
  */
89733
90048
  readonly endnotes: Word.NoteItemCollection;
90049
+ /**
90050
+ * Gets the collection of field objects in the table row. Read-only.
90051
+ *
90052
+ * @remarks
90053
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
90054
+ * @beta
90055
+ */
90056
+ readonly fields: Word.FieldCollection;
89734
90057
  /**
89735
90058
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
89736
90059
  *
@@ -89855,7 +90178,7 @@ declare namespace Word {
89855
90178
  * @remarks
89856
90179
  * [Api set: WordApi 1.3]
89857
90180
  *
89858
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90181
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89859
90182
  */
89860
90183
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
89861
90184
  /**
@@ -89864,7 +90187,7 @@ declare namespace Word {
89864
90187
  * @remarks
89865
90188
  * [Api set: WordApi 1.3]
89866
90189
  *
89867
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90190
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89868
90191
  */
89869
90192
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
89870
90193
  /**
@@ -89895,7 +90218,7 @@ declare namespace Word {
89895
90218
  * @remarks
89896
90219
  * [Api set: WordApi 1.3]
89897
90220
  *
89898
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It can be 'Before' or 'After'.
90221
+ * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
89899
90222
  * @param rowCount Required. Number of rows to add
89900
90223
  * @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.
89901
90224
  */
@@ -89906,7 +90229,7 @@ declare namespace Word {
89906
90229
  * @remarks
89907
90230
  * [Api set: WordApi 1.3]
89908
90231
  *
89909
- * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It can be 'Before' or 'After'.
90232
+ * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
89910
90233
  * @param rowCount Required. Number of rows to add
89911
90234
  * @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.
89912
90235
  */
@@ -89943,7 +90266,7 @@ declare namespace Word {
89943
90266
  * @remarks
89944
90267
  * [Api set: WordApi 1.3]
89945
90268
  *
89946
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
90269
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89947
90270
  */
89948
90271
  select(selectionMode?: Word.SelectionMode): void;
89949
90272
  /**
@@ -89952,7 +90275,7 @@ declare namespace Word {
89952
90275
  * @remarks
89953
90276
  * [Api set: WordApi 1.3]
89954
90277
  *
89955
- * @param selectionMode Optional. The selection mode can be 'Select', 'Start', or 'End'. 'Select' is the default.
90278
+ * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.
89956
90279
  */
89957
90280
  select(selectionMode?: "Select" | "Start" | "End"): void;
89958
90281
  /**
@@ -89961,7 +90284,7 @@ declare namespace Word {
89961
90284
  * @remarks
89962
90285
  * [Api set: WordApi 1.3]
89963
90286
  *
89964
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90287
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89965
90288
  * @param cellPadding Required. The cell padding.
89966
90289
  */
89967
90290
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -89971,7 +90294,7 @@ declare namespace Word {
89971
90294
  * @remarks
89972
90295
  * [Api set: WordApi 1.3]
89973
90296
  *
89974
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90297
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
89975
90298
  * @param cellPadding Required. The cell padding.
89976
90299
  */
89977
90300
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -90199,7 +90522,7 @@ declare namespace Word {
90199
90522
  * @remarks
90200
90523
  * [Api set: WordApi 1.3]
90201
90524
  *
90202
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90525
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90203
90526
  */
90204
90527
  getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
90205
90528
  /**
@@ -90208,7 +90531,7 @@ declare namespace Word {
90208
90531
  * @remarks
90209
90532
  * [Api set: WordApi 1.3]
90210
90533
  *
90211
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90534
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90212
90535
  */
90213
90536
  getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
90214
90537
  /**
@@ -90231,7 +90554,7 @@ declare namespace Word {
90231
90554
  * @remarks
90232
90555
  * [Api set: WordApi 1.3]
90233
90556
  *
90234
- * @param insertLocation Required. It can be 'Before' or 'After'.
90557
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90235
90558
  * @param columnCount Required. Number of columns to add.
90236
90559
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90237
90560
  */
@@ -90242,7 +90565,7 @@ declare namespace Word {
90242
90565
  * @remarks
90243
90566
  * [Api set: WordApi 1.3]
90244
90567
  *
90245
- * @param insertLocation Required. It can be 'Before' or 'After'.
90568
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90246
90569
  * @param columnCount Required. Number of columns to add.
90247
90570
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90248
90571
  */
@@ -90253,7 +90576,7 @@ declare namespace Word {
90253
90576
  * @remarks
90254
90577
  * [Api set: WordApi 1.3]
90255
90578
  *
90256
- * @param insertLocation Required. It can be 'Before' or 'After'.
90579
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90257
90580
  * @param rowCount Required. Number of rows to add.
90258
90581
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90259
90582
  */
@@ -90264,7 +90587,7 @@ declare namespace Word {
90264
90587
  * @remarks
90265
90588
  * [Api set: WordApi 1.3]
90266
90589
  *
90267
- * @param insertLocation Required. It can be 'Before' or 'After'.
90590
+ * @param insertLocation Required. It must be 'Before' or 'After'.
90268
90591
  * @param rowCount Required. Number of rows to add.
90269
90592
  * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
90270
90593
  */
@@ -90275,7 +90598,7 @@ declare namespace Word {
90275
90598
  * @remarks
90276
90599
  * [Api set: WordApi 1.3]
90277
90600
  *
90278
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90601
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90279
90602
  * @param cellPadding Required. The cell padding.
90280
90603
  */
90281
90604
  setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
@@ -90285,7 +90608,7 @@ declare namespace Word {
90285
90608
  * @remarks
90286
90609
  * [Api set: WordApi 1.3]
90287
90610
  *
90288
- * @param cellPaddingLocation Required. The cell padding location can be 'Top', 'Left', 'Bottom', or 'Right'.
90611
+ * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'.
90289
90612
  * @param cellPadding Required. The cell padding.
90290
90613
  */
90291
90614
  setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
@@ -90496,7 +90819,7 @@ declare namespace Word {
90496
90819
  trackMineOnly = "TrackMineOnly",
90497
90820
  }
90498
90821
  /**
90499
- * Specify the current version or the original version of the document.
90822
+ * Specify the current version or the original version of the text.
90500
90823
  *
90501
90824
  * @remarks
90502
90825
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -90915,7 +91238,7 @@ declare namespace Word {
90915
91238
  line = "Line",
90916
91239
  }
90917
91240
  /**
90918
- * The insertion location types
91241
+ * The insertion location types.
90919
91242
  *
90920
91243
  * @remarks
90921
91244
  * [Api set: WordApi 1.1]
@@ -92609,7 +92932,6 @@ declare namespace Word {
92609
92932
  color?: string;
92610
92933
  /**
92611
92934
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
92612
- *
92613
92935
  * **Note**: The set operation for this property is not supported in Word on the web.
92614
92936
  *
92615
92937
  * @remarks
@@ -92786,6 +93108,10 @@ declare namespace Word {
92786
93108
  */
92787
93109
  title?: string;
92788
93110
  }
93111
+ /** An interface for updating data on the FieldCollection object, for use in `fieldCollection.set({ ... })`. */
93112
+ interface FieldCollectionUpdateData {
93113
+ items?: Word.Interfaces.FieldData[];
93114
+ }
92789
93115
  /** An interface for updating data on the Font object, for use in `font.set({ ... })`. */
92790
93116
  interface FontUpdateData {
92791
93117
  /**
@@ -92811,7 +93137,7 @@ declare namespace Word {
92811
93137
  doubleStrikeThrough?: boolean;
92812
93138
  /**
92813
93139
  * 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.
92814
- **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.
93140
+ * **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.
92815
93141
  *
92816
93142
  * @remarks
92817
93143
  * [Api set: WordApi 1.1]
@@ -93425,6 +93751,14 @@ declare namespace Word {
93425
93751
  */
93426
93752
  contentControls?: Word.Interfaces.ContentControlData[];
93427
93753
  /**
93754
+ * Gets the collection of field objects in the body. Read-only.
93755
+ *
93756
+ * @remarks
93757
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
93758
+ * @beta
93759
+ */
93760
+ fields?: Word.Interfaces.FieldData[];
93761
+ /**
93428
93762
  * Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
93429
93763
  *
93430
93764
  * @remarks
@@ -93539,7 +93873,7 @@ declare namespace Word {
93539
93873
  */
93540
93874
  creationDate?: Date;
93541
93875
  /**
93542
- * ID
93876
+ * Gets the ID of the comment. Read-only.
93543
93877
  *
93544
93878
  * @remarks
93545
93879
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -93669,7 +94003,7 @@ declare namespace Word {
93669
94003
  */
93670
94004
  creationDate?: Date;
93671
94005
  /**
93672
- * ID
94006
+ * Gets the ID of the comment reply. Read-only.
93673
94007
  *
93674
94008
  * @remarks
93675
94009
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -93691,6 +94025,14 @@ declare namespace Word {
93691
94025
  */
93692
94026
  contentControls?: Word.Interfaces.ContentControlData[];
93693
94027
  /**
94028
+ * Gets the collection of field objects in the contentcontrol. Read-only.
94029
+ *
94030
+ * @remarks
94031
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94032
+ * @beta
94033
+ */
94034
+ fields?: Word.Interfaces.FieldData[];
94035
+ /**
93694
94036
  * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
93695
94037
  *
93696
94038
  * @remarks
@@ -93762,7 +94104,6 @@ declare namespace Word {
93762
94104
  id?: number;
93763
94105
  /**
93764
94106
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
93765
- *
93766
94107
  * **Note**: The set operation for this property is not supported in Word on the web.
93767
94108
  *
93768
94109
  * @remarks
@@ -94130,6 +94471,29 @@ declare namespace Word {
94130
94471
  */
94131
94472
  title?: string;
94132
94473
  }
94474
+ /** An interface describing the data returned by calling `field.toJSON()`. */
94475
+ interface FieldData {
94476
+ /**
94477
+ * Gets the field's code instruction. Read-only.
94478
+ *
94479
+ * @remarks
94480
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94481
+ * @beta
94482
+ */
94483
+ code?: string;
94484
+ /**
94485
+ * Gets the field's result data. Read-only.
94486
+ *
94487
+ * @remarks
94488
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94489
+ * @beta
94490
+ */
94491
+ result?: string;
94492
+ }
94493
+ /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */
94494
+ interface FieldCollectionData {
94495
+ items?: Word.Interfaces.FieldData[];
94496
+ }
94133
94497
  /** An interface describing the data returned by calling `font.toJSON()`. */
94134
94498
  interface FontData {
94135
94499
  /**
@@ -94155,7 +94519,7 @@ declare namespace Word {
94155
94519
  doubleStrikeThrough?: boolean;
94156
94520
  /**
94157
94521
  * 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.
94158
- **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.
94522
+ * **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.
94159
94523
  *
94160
94524
  * @remarks
94161
94525
  * [Api set: WordApi 1.1]
@@ -94360,6 +94724,14 @@ declare namespace Word {
94360
94724
  }
94361
94725
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
94362
94726
  interface ParagraphData {
94727
+ /**
94728
+ * Gets the collection of fields in the paragraph. Read-only.
94729
+ *
94730
+ * @remarks
94731
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94732
+ * @beta
94733
+ */
94734
+ fields?: Word.Interfaces.FieldData[];
94363
94735
  /**
94364
94736
  * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
94365
94737
  *
@@ -94507,6 +94879,14 @@ declare namespace Word {
94507
94879
  }
94508
94880
  /** An interface describing the data returned by calling `range.toJSON()`. */
94509
94881
  interface RangeData {
94882
+ /**
94883
+ * Gets the collection of field objects in the range. Read-only.
94884
+ *
94885
+ * @remarks
94886
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
94887
+ * @beta
94888
+ */
94889
+ fields?: Word.Interfaces.FieldData[];
94510
94890
  /**
94511
94891
  * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
94512
94892
  *
@@ -94652,6 +95032,14 @@ declare namespace Word {
94652
95032
  }
94653
95033
  /** An interface describing the data returned by calling `table.toJSON()`. */
94654
95034
  interface TableData {
95035
+ /**
95036
+ * Gets the collection of field objects in the table. Read-only.
95037
+ *
95038
+ * @remarks
95039
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
95040
+ * @beta
95041
+ */
95042
+ fields?: Word.Interfaces.FieldData[];
94655
95043
  /**
94656
95044
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
94657
95045
  *
@@ -94807,6 +95195,14 @@ declare namespace Word {
94807
95195
  */
94808
95196
  cells?: Word.Interfaces.TableCellData[];
94809
95197
  /**
95198
+ * Gets the collection of field objects in the table row. Read-only.
95199
+ *
95200
+ * @remarks
95201
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
95202
+ * @beta
95203
+ */
95204
+ fields?: Word.Interfaces.FieldData[];
95205
+ /**
94810
95206
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
94811
95207
  *
94812
95208
  * @remarks
@@ -95110,7 +95506,7 @@ declare namespace Word {
95110
95506
  */
95111
95507
  creationDate?: boolean;
95112
95508
  /**
95113
- * ID
95509
+ * Gets the ID of the comment. Read-only.
95114
95510
  *
95115
95511
  * @remarks
95116
95512
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95179,7 +95575,7 @@ declare namespace Word {
95179
95575
  */
95180
95576
  creationDate?: boolean;
95181
95577
  /**
95182
- * For EACH ITEM in the collection: ID
95578
+ * For EACH ITEM in the collection: Gets the ID of the comment. Read-only.
95183
95579
  *
95184
95580
  * @remarks
95185
95581
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95323,7 +95719,7 @@ declare namespace Word {
95323
95719
  */
95324
95720
  creationDate?: boolean;
95325
95721
  /**
95326
- * ID
95722
+ * Gets the ID of the comment reply. Read-only.
95327
95723
  *
95328
95724
  * @remarks
95329
95725
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95392,7 +95788,7 @@ declare namespace Word {
95392
95788
  */
95393
95789
  creationDate?: boolean;
95394
95790
  /**
95395
- * For EACH ITEM in the collection: ID
95791
+ * For EACH ITEM in the collection: Gets the ID of the comment reply. Read-only.
95396
95792
  *
95397
95793
  * @remarks
95398
95794
  * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
@@ -95504,7 +95900,6 @@ declare namespace Word {
95504
95900
  id?: boolean;
95505
95901
  /**
95506
95902
  * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
95507
- *
95508
95903
  * **Note**: The set operation for this property is not supported in Word on the web.
95509
95904
  *
95510
95905
  * @remarks
@@ -95672,7 +96067,6 @@ declare namespace Word {
95672
96067
  id?: boolean;
95673
96068
  /**
95674
96069
  * 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.
95675
- *
95676
96070
  * **Note**: The set operation for this property is not supported in Word on the web.
95677
96071
  *
95678
96072
  * @remarks
@@ -96094,6 +96488,176 @@ declare namespace Word {
96094
96488
  */
96095
96489
  title?: boolean;
96096
96490
  }
96491
+ /**
96492
+ * Represents a field.
96493
+ *
96494
+ * @remarks
96495
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96496
+ * @beta
96497
+ */
96498
+ interface FieldLoadOptions {
96499
+ /**
96500
+ 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`).
96501
+ */
96502
+ $all?: boolean;
96503
+ /**
96504
+ * Gets the parent body of the field.
96505
+ *
96506
+ * @remarks
96507
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96508
+ * @beta
96509
+ */
96510
+ parentBody?: Word.Interfaces.BodyLoadOptions;
96511
+ /**
96512
+ * Gets the content control that contains the field. Throws an error if there isn't a parent content control.
96513
+ *
96514
+ * @remarks
96515
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96516
+ * @beta
96517
+ */
96518
+ parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
96519
+ /**
96520
+ * Gets the content control that contains the field. Returns a null object if there isn't a parent content control.
96521
+ *
96522
+ * @remarks
96523
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96524
+ * @beta
96525
+ */
96526
+ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
96527
+ /**
96528
+ * Gets the table that contains the field. Throws an error if it is not contained in a table.
96529
+ *
96530
+ * @remarks
96531
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96532
+ * @beta
96533
+ */
96534
+ parentTable?: Word.Interfaces.TableLoadOptions;
96535
+ /**
96536
+ * Gets the table cell that contains the field. Throws an error if it is not contained in a table cell.
96537
+ *
96538
+ * @remarks
96539
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96540
+ * @beta
96541
+ */
96542
+ parentTableCell?: Word.Interfaces.TableCellLoadOptions;
96543
+ /**
96544
+ * Gets the table cell that contains the field. Returns a null object if it is not contained in a table cell.
96545
+ *
96546
+ * @remarks
96547
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96548
+ * @beta
96549
+ */
96550
+ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
96551
+ /**
96552
+ * Gets the table that contains the field. Returns a null object if it is not contained in a table.
96553
+ *
96554
+ * @remarks
96555
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96556
+ * @beta
96557
+ */
96558
+ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
96559
+ /**
96560
+ * Gets the field's code instruction. Read-only.
96561
+ *
96562
+ * @remarks
96563
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96564
+ * @beta
96565
+ */
96566
+ code?: boolean;
96567
+ /**
96568
+ * Gets the field's result data. Read-only.
96569
+ *
96570
+ * @remarks
96571
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96572
+ * @beta
96573
+ */
96574
+ result?: boolean;
96575
+ }
96576
+ /**
96577
+ * Contains a collection of {@link Word.Field} objects.
96578
+ *
96579
+ * @remarks
96580
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96581
+ * @beta
96582
+ */
96583
+ interface FieldCollectionLoadOptions {
96584
+ /**
96585
+ 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`).
96586
+ */
96587
+ $all?: boolean;
96588
+ /**
96589
+ * For EACH ITEM in the collection: Gets the parent body of the field.
96590
+ *
96591
+ * @remarks
96592
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96593
+ * @beta
96594
+ */
96595
+ parentBody?: Word.Interfaces.BodyLoadOptions;
96596
+ /**
96597
+ * 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.
96598
+ *
96599
+ * @remarks
96600
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96601
+ * @beta
96602
+ */
96603
+ parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
96604
+ /**
96605
+ * 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.
96606
+ *
96607
+ * @remarks
96608
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96609
+ * @beta
96610
+ */
96611
+ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
96612
+ /**
96613
+ * For EACH ITEM in the collection: Gets the table that contains the field. Throws an error if it is not contained in a table.
96614
+ *
96615
+ * @remarks
96616
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96617
+ * @beta
96618
+ */
96619
+ parentTable?: Word.Interfaces.TableLoadOptions;
96620
+ /**
96621
+ * 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.
96622
+ *
96623
+ * @remarks
96624
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96625
+ * @beta
96626
+ */
96627
+ parentTableCell?: Word.Interfaces.TableCellLoadOptions;
96628
+ /**
96629
+ * 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.
96630
+ *
96631
+ * @remarks
96632
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96633
+ * @beta
96634
+ */
96635
+ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
96636
+ /**
96637
+ * 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.
96638
+ *
96639
+ * @remarks
96640
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96641
+ * @beta
96642
+ */
96643
+ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
96644
+ /**
96645
+ * For EACH ITEM in the collection: Gets the field's code instruction. Read-only.
96646
+ *
96647
+ * @remarks
96648
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96649
+ * @beta
96650
+ */
96651
+ code?: boolean;
96652
+ /**
96653
+ * For EACH ITEM in the collection: Gets the field's result data. Read-only.
96654
+ *
96655
+ * @remarks
96656
+ * [Api set: WordApiOnline BETA (PREVIEW ONLY)]
96657
+ * @beta
96658
+ */
96659
+ result?: boolean;
96660
+ }
96097
96661
  /**
96098
96662
  * Represents a font.
96099
96663
  *
@@ -96128,7 +96692,7 @@ declare namespace Word {
96128
96692
  doubleStrikeThrough?: boolean;
96129
96693
  /**
96130
96694
  * 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.
96131
- **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.
96695
+ * **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.
96132
96696
  *
96133
96697
  * @remarks
96134
96698
  * [Api set: WordApi 1.1]