@types/office-js 1.0.253 → 1.0.256

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +1851 -13
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -537,9 +537,6 @@ declare namespace Office {
537
537
  }
538
538
  /**
539
539
  * Manages actions and keyboard shortcuts.
540
- *
541
- * @remarks
542
- * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
543
540
  */
544
541
  interface Actions {
545
542
  /**
@@ -547,9 +544,6 @@ declare namespace Office {
547
544
  *
548
545
  * @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
549
546
  * @param actionFunction The function that is run when the action is invoked.
550
- *
551
- * @remarks
552
- * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
553
547
  */
554
548
  associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
555
549
  }
@@ -19691,6 +19685,32 @@ declare namespace Excel {
19691
19685
  */
19692
19686
  automatic = "Automatic"
19693
19687
  }
19688
+ /**
19689
+ * Represents a command type of `DataConnection`.
19690
+ *
19691
+ * @remarks
19692
+ * [Api set: ExcelApi 1.15]
19693
+ */
19694
+ enum DataSourceType {
19695
+ /**
19696
+ * The data source type is unknown or unsupported.
19697
+ * @remarks
19698
+ * [Api set: ExcelApi 1.15]
19699
+ */
19700
+ unknown = "Unknown",
19701
+ /**
19702
+ * The data source type is a range in the current workbook.
19703
+ * @remarks
19704
+ * [Api set: ExcelApi 1.15]
19705
+ */
19706
+ localRange = "LocalRange",
19707
+ /**
19708
+ * The data source type is a table in the current workbook.
19709
+ * @remarks
19710
+ * [Api set: ExcelApi 1.15]
19711
+ */
19712
+ localTable = "LocalTable"
19713
+ }
19694
19714
  /**
19695
19715
  * Enum representing all accepted conditions by which a date filter can be applied.
19696
19716
  Used to configure the type of PivotFilter that is applied to the field.
@@ -23996,14 +24016,21 @@ declare namespace Excel {
23996
24016
  */
23997
24017
  getColumnsBefore(count?: number): Excel.Range;
23998
24018
  /**
23999
- * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependents of a cell in the same worksheet or in multiple worksheets.
24000
- *
24019
+ * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
24020
+ *
24021
+ * @remarks
24022
+ * [Api set: ExcelApi 1.15]
24023
+ */
24024
+ getDependents(): Excel.WorkbookRangeAreas;
24025
+ /**
24026
+ * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
24027
+ *
24001
24028
  * @remarks
24002
24029
  * [Api set: ExcelApi 1.13]
24003
24030
  */
24004
24031
  getDirectDependents(): Excel.WorkbookRangeAreas;
24005
24032
  /**
24006
- * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedents of a cell in the same worksheet or in multiple worksheets.
24033
+ * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
24007
24034
  *
24008
24035
  * @remarks
24009
24036
  * [Api set: ExcelApi 1.12]
@@ -24120,7 +24147,7 @@ declare namespace Excel {
24120
24147
  */
24121
24148
  getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
24122
24149
  /**
24123
- * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedents of a cell in the same worksheet or in multiple worksheets.
24150
+ * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
24124
24151
  *
24125
24152
  * @remarks
24126
24153
  * [Api set: ExcelApi 1.14]
@@ -26990,10 +27017,11 @@ declare namespace Excel {
26990
27017
  to point at the index for which it was created.
26991
27018
  *
26992
27019
  * @remarks
26993
- * [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.]
27020
+ * [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; 1.15 for adding `alwaysInsert` parameter.]
26994
27021
  *
26995
27022
  * @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
26996
27023
  * @param values Optional. A 2D array of unformatted values of the table row.
27024
+ * @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
26997
27025
  */
26998
27026
  add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
26999
27027
  /**
@@ -29162,6 +29190,42 @@ declare namespace Excel {
29162
29190
  * [Api set: ExcelApi 1.7]
29163
29191
  */
29164
29192
  delete(): void;
29193
+ /**
29194
+ * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
29195
+ *
29196
+ * @remarks
29197
+ * [Api set: ExcelApi 1.15]
29198
+ *
29199
+ * @param dimension The dimension of the axis where the data is from.
29200
+ */
29201
+ getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
29202
+ /**
29203
+ * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
29204
+ *
29205
+ * @remarks
29206
+ * [Api set: ExcelApi 1.15]
29207
+ *
29208
+ * @param dimension The dimension of the axis where the data is from.
29209
+ */
29210
+ getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;
29211
+ /**
29212
+ * Gets the data source type of the chart series.
29213
+ *
29214
+ * @remarks
29215
+ * [Api set: ExcelApi 1.15]
29216
+ *
29217
+ * @param dimension The dimension of the axis where the data is from.
29218
+ */
29219
+ getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
29220
+ /**
29221
+ * Gets the data source type of the chart series.
29222
+ *
29223
+ * @remarks
29224
+ * [Api set: ExcelApi 1.15]
29225
+ *
29226
+ * @param dimension The dimension of the axis where the data is from.
29227
+ */
29228
+ getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
29165
29229
  /**
29166
29230
  * Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series.
29167
29231
  *
@@ -33690,6 +33754,15 @@ declare namespace Excel {
33690
33754
  * [Api set: ExcelApi 1.12]
33691
33755
  */
33692
33756
  getFirst(): Excel.PivotTable;
33757
+ /**
33758
+ * Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
33759
+ If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
33760
+ For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
33761
+ *
33762
+ * @remarks
33763
+ * [Api set: ExcelApi 1.15]
33764
+ */
33765
+ getFirstOrNullObject(): Excel.PivotTable;
33693
33766
  /**
33694
33767
  * Gets a PivotTable by name.
33695
33768
  *
@@ -33929,6 +34002,21 @@ declare namespace Excel {
33929
34002
  * [Api set: ExcelApi 1.8]
33930
34003
  */
33931
34004
  delete(): void;
34005
+ /**
34006
+ * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
34007
+ Otherwise, it returns an empty string.
34008
+ *
34009
+ * @remarks
34010
+ * [Api set: ExcelApi 1.15]
34011
+ */
34012
+ getDataSourceString(): OfficeExtension.ClientResult<string>;
34013
+ /**
34014
+ * Gets the type of the data source for the PivotTable.
34015
+ *
34016
+ * @remarks
34017
+ * [Api set: ExcelApi 1.15]
34018
+ */
34019
+ getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
33932
34020
  /**
33933
34021
  * Refreshes the PivotTable.
33934
34022
  *
@@ -40108,6 +40196,15 @@ declare namespace Excel {
40108
40196
  * [Api set: ExcelApi 1.9]
40109
40197
  */
40110
40198
  readonly connectionSiteCount: number;
40199
+ /**
40200
+ * Gets the display name of the shape. A newly created shape has a generated name
40201
+ that is localized and may not match its `name`. In this scenario, you can use
40202
+ this API to get the name that is displayed in the UI.
40203
+ *
40204
+ * @remarks
40205
+ * [Api set: ExcelApi 1.15]
40206
+ */
40207
+ readonly displayName: string;
40111
40208
  /**
40112
40209
  * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
40113
40210
  *
@@ -42533,6 +42630,38 @@ declare namespace Excel {
42533
42630
  */
42534
42631
  rows = "Rows"
42535
42632
  }
42633
+ /**
42634
+ * Specifies the data source type of the chart series.
42635
+ *
42636
+ * @remarks
42637
+ * [Api set: ExcelApi 1.15]
42638
+ */
42639
+ enum ChartDataSourceType {
42640
+ /**
42641
+ * The data source type of the chart series is a local range.
42642
+ * @remarks
42643
+ * [Api set: ExcelApi 1.15]
42644
+ */
42645
+ localRange = "LocalRange",
42646
+ /**
42647
+ * The data source type of the chart series is an external range.
42648
+ * @remarks
42649
+ * [Api set: ExcelApi 1.15]
42650
+ */
42651
+ externalRange = "ExternalRange",
42652
+ /**
42653
+ * The data source type of the chart series is a list.
42654
+ * @remarks
42655
+ * [Api set: ExcelApi 1.15]
42656
+ */
42657
+ list = "List",
42658
+ /**
42659
+ * The data source type of the chart series is unknown or unsupported.
42660
+ * @remarks
42661
+ * [Api set: ExcelApi 1.15]
42662
+ */
42663
+ unknown = "Unknown"
42664
+ }
42536
42665
  /**
42537
42666
  * Represents the horizontal alignment for the specified object.
42538
42667
  *
@@ -63170,6 +63299,15 @@ declare namespace Excel {
63170
63299
  * [Api set: ExcelApi 1.9]
63171
63300
  */
63172
63301
  connectionSiteCount?: number;
63302
+ /**
63303
+ * Gets the display name of the shape. A newly created shape has a generated name
63304
+ that is localized and may not match its `name`. In this scenario, you can use
63305
+ this API to get the name that is displayed in the UI.
63306
+ *
63307
+ * @remarks
63308
+ * [Api set: ExcelApi 1.15]
63309
+ */
63310
+ displayName?: string;
63173
63311
  /**
63174
63312
  * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
63175
63313
  *
@@ -73295,6 +73433,15 @@ declare namespace Excel {
73295
73433
  * [Api set: ExcelApi 1.9]
73296
73434
  */
73297
73435
  connectionSiteCount?: boolean;
73436
+ /**
73437
+ * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
73438
+ that is localized and may not match its `name`. In this scenario, you can use
73439
+ this API to get the name that is displayed in the UI.
73440
+ *
73441
+ * @remarks
73442
+ * [Api set: ExcelApi 1.15]
73443
+ */
73444
+ displayName?: boolean;
73298
73445
  /**
73299
73446
  * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
73300
73447
  *
@@ -73487,6 +73634,15 @@ declare namespace Excel {
73487
73634
  * [Api set: ExcelApi 1.9]
73488
73635
  */
73489
73636
  connectionSiteCount?: boolean;
73637
+ /**
73638
+ * Gets the display name of the shape. A newly created shape has a generated name
73639
+ that is localized and may not match its `name`. In this scenario, you can use
73640
+ this API to get the name that is displayed in the UI.
73641
+ *
73642
+ * @remarks
73643
+ * [Api set: ExcelApi 1.15]
73644
+ */
73645
+ displayName?: boolean;
73490
73646
  /**
73491
73647
  * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
73492
73648
  *
@@ -73763,6 +73919,15 @@ declare namespace Excel {
73763
73919
  * [Api set: ExcelApi 1.9]
73764
73920
  */
73765
73921
  connectionSiteCount?: boolean;
73922
+ /**
73923
+ * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
73924
+ that is localized and may not match its `name`. In this scenario, you can use
73925
+ this API to get the name that is displayed in the UI.
73926
+ *
73927
+ * @remarks
73928
+ * [Api set: ExcelApi 1.15]
73929
+ */
73930
+ displayName?: boolean;
73766
73931
  /**
73767
73932
  * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
73768
73933
  *
@@ -74658,6 +74823,13 @@ declare namespace Word {
74658
74823
  * [Api set: WordApi 1.1]
74659
74824
  */
74660
74825
  readonly contentControls: Word.ContentControlCollection;
74826
+ /**
74827
+ * Gets the collection of endnotes in the body. Read-only.
74828
+ *
74829
+ * @remarks
74830
+ * [Api set: WordApiOnline 1.1]
74831
+ */
74832
+ readonly endnotes: Word.NoteItemCollection;
74661
74833
  /**
74662
74834
  * Gets the text format of the body. Use this to get and set font name, size, color and other properties. Read-only.
74663
74835
  *
@@ -74665,6 +74837,13 @@ declare namespace Word {
74665
74837
  * [Api set: WordApi 1.1]
74666
74838
  */
74667
74839
  readonly font: Word.Font;
74840
+ /**
74841
+ * Gets the collection of footnotes in the body. Read-only.
74842
+ *
74843
+ * @remarks
74844
+ * [Api set: WordApiOnline 1.1]
74845
+ */
74846
+ readonly footnotes: Word.NoteItemCollection;
74668
74847
  /**
74669
74848
  * Gets the collection of InlinePicture objects in the body. The collection does not include floating images. Read-only.
74670
74849
  *
@@ -74762,7 +74941,7 @@ declare namespace Word {
74762
74941
  * @remarks
74763
74942
  * [Api set: WordApi 1.3]
74764
74943
  */
74765
- readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
74944
+ readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
74766
74945
  /**
74767
74946
  * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
74768
74947
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -74778,6 +74957,13 @@ declare namespace Word {
74778
74957
  * [Api set: WordApi 1.1]
74779
74958
  */
74780
74959
  clear(): void;
74960
+ /**
74961
+ * Gets comments associated with the body.
74962
+ *
74963
+ * @remarks
74964
+ * [Api set: WordApiOnline 1.1]
74965
+ */
74966
+ getComments(): Word.CommentCollection;
74781
74967
  /**
74782
74968
  * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML.
74783
74969
  *
@@ -74810,6 +74996,24 @@ declare namespace Word {
74810
74996
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
74811
74997
  */
74812
74998
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
74999
+ /**
75000
+ * Gets reviewed text based on ChangeTrackingVersion selection.
75001
+ *
75002
+ * @remarks
75003
+ * [Api set: WordApiOnline 1.1]
75004
+ *
75005
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
75006
+ */
75007
+ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
75008
+ /**
75009
+ * Gets reviewed text based on ChangeTrackingVersion selection.
75010
+ *
75011
+ * @remarks
75012
+ * [Api set: WordApiOnline 1.1]
75013
+ *
75014
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
75015
+ */
75016
+ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
74813
75017
  /**
74814
75018
  * Inserts a break at the specified location in the main document.
74815
75019
  *
@@ -75052,6 +75256,496 @@ declare namespace Word {
75052
75256
  */
75053
75257
  toJSON(): Word.Interfaces.BodyData;
75054
75258
  }
75259
+ /**
75260
+ * Represents a comment in the document.
75261
+ *
75262
+ * @remarks
75263
+ * [Api set: WordApiOnline 1.1]
75264
+ */
75265
+ class Comment extends OfficeExtension.ClientObject {
75266
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
75267
+ context: RequestContext;
75268
+ /**
75269
+ * Gets or sets the comment's content range.
75270
+ *
75271
+ * @remarks
75272
+ * [Api set: WordApiOnline 1.1]
75273
+ */
75274
+ contentRange: Word.CommentContentRange;
75275
+ /**
75276
+ * Gets the collection of reply objects associated with the comment.
75277
+ *
75278
+ * @remarks
75279
+ * [Api set: WordApiOnline 1.1]
75280
+ */
75281
+ readonly replies: Word.CommentReplyCollection;
75282
+ /**
75283
+ * Gets the email of the comment's author.
75284
+ *
75285
+ * @remarks
75286
+ * [Api set: WordApiOnline 1.1]
75287
+ */
75288
+ readonly authorEmail: string;
75289
+ /**
75290
+ * Gets the name of the comment's author.
75291
+ *
75292
+ * @remarks
75293
+ * [Api set: WordApiOnline 1.1]
75294
+ */
75295
+ readonly authorName: string;
75296
+ /**
75297
+ * Gets or sets the comment's content as plain text.
75298
+ *
75299
+ * @remarks
75300
+ * [Api set: WordApiOnline 1.1]
75301
+ */
75302
+ content: string;
75303
+ /**
75304
+ * Gets the creation date of the comment.
75305
+ *
75306
+ * @remarks
75307
+ * [Api set: WordApiOnline 1.1]
75308
+ */
75309
+ readonly creationDate: Date;
75310
+ /**
75311
+ * Gets the Id of the comment. Read-only.
75312
+ *
75313
+ * @remarks
75314
+ * [Api set: WordApiOnline 1.1]
75315
+ */
75316
+ readonly id: string;
75317
+ /**
75318
+ * Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
75319
+ *
75320
+ * @remarks
75321
+ * [Api set: WordApiOnline 1.1]
75322
+ */
75323
+ resolved: boolean;
75324
+ /**
75325
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
75326
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
75327
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
75328
+ */
75329
+ set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
75330
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
75331
+ set(properties: Word.Comment): void;
75332
+ /**
75333
+ * Deletes the comment and its replies.
75334
+ *
75335
+ * @remarks
75336
+ * [Api set: WordApiOnline 1.1]
75337
+ */
75338
+ delete(): void;
75339
+ /**
75340
+ * Gets the range in the main document where the comment is on.
75341
+ *
75342
+ * @remarks
75343
+ * [Api set: WordApiOnline 1.1]
75344
+ */
75345
+ getRange(): Word.Range;
75346
+ /**
75347
+ * Adds a new reply to the end of the comment thread.
75348
+ *
75349
+ * @remarks
75350
+ * [Api set: WordApiOnline 1.1]
75351
+ *
75352
+ * @param replyText Required. Reply text.
75353
+ */
75354
+ reply(replyText: string): Word.CommentReply;
75355
+ /**
75356
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75357
+ *
75358
+ * @param options Provides options for which properties of the object to load.
75359
+ */
75360
+ load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment;
75361
+ /**
75362
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75363
+ *
75364
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
75365
+ */
75366
+ load(propertyNames?: string | string[]): Word.Comment;
75367
+ /**
75368
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75369
+ *
75370
+ * @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.
75371
+ */
75372
+ load(propertyNamesAndPaths?: {
75373
+ select?: string;
75374
+ expand?: string;
75375
+ }): Word.Comment;
75376
+ /**
75377
+ * 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.
75378
+ */
75379
+ track(): Word.Comment;
75380
+ /**
75381
+ * 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.
75382
+ */
75383
+ untrack(): Word.Comment;
75384
+ /**
75385
+ * 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.)
75386
+ * Whereas the original Word.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
75387
+ */
75388
+ toJSON(): Word.Interfaces.CommentData;
75389
+ }
75390
+ /**
75391
+ * Contains a collection of {@link Word.Comment} objects.
75392
+ *
75393
+ * @remarks
75394
+ * [Api set: WordApiOnline 1.1]
75395
+ */
75396
+ class CommentCollection extends OfficeExtension.ClientObject {
75397
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
75398
+ context: RequestContext;
75399
+ /** Gets the loaded child items in this collection. */
75400
+ readonly items: Word.Comment[];
75401
+ /**
75402
+ * Gets the first comment in the collection. Throws an error if this collection is empty.
75403
+ *
75404
+ * @remarks
75405
+ * [Api set: WordApiOnline 1.1]
75406
+ */
75407
+ getFirst(): Word.Comment;
75408
+ /**
75409
+ * Gets the first comment in the collection. If the collection is empty, returns a null object.
75410
+ *
75411
+ * @remarks
75412
+ * [Api set: WordApiOnline 1.1]
75413
+ */
75414
+ getFirstOrNullObject(): Word.Comment;
75415
+ /**
75416
+ * Gets a comment object by its index in the collection.
75417
+ *
75418
+ * @remarks
75419
+ * [Api set: WordApiOnline 1.1]
75420
+ *
75421
+ * @param index A number that identifies the index location of a comment object.
75422
+ */
75423
+ getItem(index: number): Word.Comment;
75424
+ /**
75425
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75426
+ *
75427
+ * @param options Provides options for which properties of the object to load.
75428
+ */
75429
+ load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection;
75430
+ /**
75431
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75432
+ *
75433
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
75434
+ */
75435
+ load(propertyNames?: string | string[]): Word.CommentCollection;
75436
+ /**
75437
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75438
+ *
75439
+ * @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.
75440
+ */
75441
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
75442
+ /**
75443
+ * 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.
75444
+ */
75445
+ track(): Word.CommentCollection;
75446
+ /**
75447
+ * 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.
75448
+ */
75449
+ untrack(): Word.CommentCollection;
75450
+ /**
75451
+ * 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.)
75452
+ * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
75453
+ */
75454
+ toJSON(): Word.Interfaces.CommentCollectionData;
75455
+ }
75456
+ /**
75457
+ * @remarks
75458
+ * [Api set: WordApiOnline 1.1]
75459
+ */
75460
+ class CommentContentRange extends OfficeExtension.ClientObject {
75461
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
75462
+ context: RequestContext;
75463
+ /**
75464
+ * Gets or sets a value that indicates whether the comment text is bold.
75465
+ *
75466
+ * @remarks
75467
+ * [Api set: WordApiOnline 1.1]
75468
+ */
75469
+ bold: boolean;
75470
+ /**
75471
+ * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
75472
+ *
75473
+ * @remarks
75474
+ * [Api set: WordApiOnline 1.1]
75475
+ */
75476
+ hyperlink: string;
75477
+ /**
75478
+ * Checks whether the range length is zero. Read-only.
75479
+ *
75480
+ * @remarks
75481
+ * [Api set: WordApiOnline 1.1]
75482
+ */
75483
+ readonly isEmpty: boolean;
75484
+ /**
75485
+ * Gets or sets a value that indicates whether the comment text is italicized.
75486
+ *
75487
+ * @remarks
75488
+ * [Api set: WordApiOnline 1.1]
75489
+ */
75490
+ italic: boolean;
75491
+ /**
75492
+ * Gets or sets a value that indicates whether the comment text has a strikethrough.
75493
+ *
75494
+ * @remarks
75495
+ * [Api set: WordApiOnline 1.1]
75496
+ */
75497
+ strikeThrough: boolean;
75498
+ /**
75499
+ * Gets the text of the comment range. Read-only.
75500
+ *
75501
+ * @remarks
75502
+ * [Api set: WordApiOnline 1.1]
75503
+ */
75504
+ readonly text: string;
75505
+ /**
75506
+ * Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
75507
+ *
75508
+ * @remarks
75509
+ * [Api set: WordApiOnline 1.1]
75510
+ */
75511
+ underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
75512
+ /**
75513
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
75514
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
75515
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
75516
+ */
75517
+ set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
75518
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
75519
+ set(properties: Word.CommentContentRange): void;
75520
+ /**
75521
+ * Inserts text into at the specified location.
75522
+ *
75523
+ * @remarks
75524
+ * [Api set: WordApiOnline 1.1]
75525
+ *
75526
+ * @param text Required. The text to be inserted in to the CommentContentRange.
75527
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
75528
+ */
75529
+ insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
75530
+ /**
75531
+ * Inserts text into at the specified location.
75532
+ *
75533
+ * @remarks
75534
+ * [Api set: WordApiOnline 1.1]
75535
+ *
75536
+ * @param text Required. The text to be inserted in to the CommentContentRange.
75537
+ * @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
75538
+ */
75539
+ insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.CommentContentRange;
75540
+ /**
75541
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75542
+ *
75543
+ * @param options Provides options for which properties of the object to load.
75544
+ */
75545
+ load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;
75546
+ /**
75547
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75548
+ *
75549
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
75550
+ */
75551
+ load(propertyNames?: string | string[]): Word.CommentContentRange;
75552
+ /**
75553
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75554
+ *
75555
+ * @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.
75556
+ */
75557
+ load(propertyNamesAndPaths?: {
75558
+ select?: string;
75559
+ expand?: string;
75560
+ }): Word.CommentContentRange;
75561
+ /**
75562
+ * 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.
75563
+ */
75564
+ track(): Word.CommentContentRange;
75565
+ /**
75566
+ * 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.
75567
+ */
75568
+ untrack(): Word.CommentContentRange;
75569
+ /**
75570
+ * 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.)
75571
+ * Whereas the original Word.CommentContentRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
75572
+ */
75573
+ toJSON(): Word.Interfaces.CommentContentRangeData;
75574
+ }
75575
+ /**
75576
+ * Represents a comment reply in the document.
75577
+ *
75578
+ * @remarks
75579
+ * [Api set: WordApiOnline 1.1]
75580
+ */
75581
+ class CommentReply extends OfficeExtension.ClientObject {
75582
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
75583
+ context: RequestContext;
75584
+ /**
75585
+ * Gets or sets the commentReply's content range.
75586
+ *
75587
+ * @remarks
75588
+ * [Api set: WordApiOnline 1.1]
75589
+ */
75590
+ contentRange: Word.CommentContentRange;
75591
+ /**
75592
+ * Gets the parent comment of this reply.
75593
+ *
75594
+ * @remarks
75595
+ * [Api set: WordApiOnline 1.1]
75596
+ */
75597
+ readonly parentComment: Word.Comment;
75598
+ /**
75599
+ * Gets the email of the comment reply's author.
75600
+ *
75601
+ * @remarks
75602
+ * [Api set: WordApiOnline 1.1]
75603
+ */
75604
+ readonly authorEmail: string;
75605
+ /**
75606
+ * Gets the name of the comment reply's author.
75607
+ *
75608
+ * @remarks
75609
+ * [Api set: WordApiOnline 1.1]
75610
+ */
75611
+ readonly authorName: string;
75612
+ /**
75613
+ * Gets or sets the comment reply's content. The string is plain text.
75614
+ *
75615
+ * @remarks
75616
+ * [Api set: WordApiOnline 1.1]
75617
+ */
75618
+ content: string;
75619
+ /**
75620
+ * Gets the creation date of the comment reply.
75621
+ *
75622
+ * @remarks
75623
+ * [Api set: WordApiOnline 1.1]
75624
+ */
75625
+ readonly creationDate: Date;
75626
+ /**
75627
+ * Gets the Id of the comment reply. Read-only.
75628
+ *
75629
+ * @remarks
75630
+ * [Api set: WordApiOnline 1.1]
75631
+ */
75632
+ readonly id: string;
75633
+ /**
75634
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
75635
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
75636
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
75637
+ */
75638
+ set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;
75639
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
75640
+ set(properties: Word.CommentReply): void;
75641
+ /**
75642
+ * Deletes the comment reply.
75643
+ *
75644
+ * @remarks
75645
+ * [Api set: WordApiOnline 1.1]
75646
+ */
75647
+ delete(): void;
75648
+ /**
75649
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75650
+ *
75651
+ * @param options Provides options for which properties of the object to load.
75652
+ */
75653
+ load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;
75654
+ /**
75655
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75656
+ *
75657
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
75658
+ */
75659
+ load(propertyNames?: string | string[]): Word.CommentReply;
75660
+ /**
75661
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75662
+ *
75663
+ * @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.
75664
+ */
75665
+ load(propertyNamesAndPaths?: {
75666
+ select?: string;
75667
+ expand?: string;
75668
+ }): Word.CommentReply;
75669
+ /**
75670
+ * 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.
75671
+ */
75672
+ track(): Word.CommentReply;
75673
+ /**
75674
+ * 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.
75675
+ */
75676
+ untrack(): Word.CommentReply;
75677
+ /**
75678
+ * 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.)
75679
+ * Whereas the original Word.CommentReply object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
75680
+ */
75681
+ toJSON(): Word.Interfaces.CommentReplyData;
75682
+ }
75683
+ /**
75684
+ * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
75685
+ *
75686
+ * @remarks
75687
+ * [Api set: WordApiOnline 1.1]
75688
+ */
75689
+ class CommentReplyCollection extends OfficeExtension.ClientObject {
75690
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
75691
+ context: RequestContext;
75692
+ /** Gets the loaded child items in this collection. */
75693
+ readonly items: Word.CommentReply[];
75694
+ /**
75695
+ * Gets the first comment reply in the collection. Throws an error if this collection is empty.
75696
+ *
75697
+ * @remarks
75698
+ * [Api set: WordApiOnline 1.1]
75699
+ */
75700
+ getFirst(): Word.CommentReply;
75701
+ /**
75702
+ * Gets the first comment reply in the collection. If the collection is empty, returns a null object.
75703
+ *
75704
+ * @remarks
75705
+ * [Api set: WordApiOnline 1.1]
75706
+ */
75707
+ getFirstOrNullObject(): Word.CommentReply;
75708
+ /**
75709
+ * Gets a comment reply object by its index in the collection.
75710
+ *
75711
+ * @remarks
75712
+ * [Api set: WordApiOnline 1.1]
75713
+ *
75714
+ * @param index A number that identifies the index location of a comment reply object.
75715
+ */
75716
+ getItem(index: number): Word.CommentReply;
75717
+ /**
75718
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75719
+ *
75720
+ * @param options Provides options for which properties of the object to load.
75721
+ */
75722
+ load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection;
75723
+ /**
75724
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75725
+ *
75726
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
75727
+ */
75728
+ load(propertyNames?: string | string[]): Word.CommentReplyCollection;
75729
+ /**
75730
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75731
+ *
75732
+ * @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.
75733
+ */
75734
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
75735
+ /**
75736
+ * 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.
75737
+ */
75738
+ track(): Word.CommentReplyCollection;
75739
+ /**
75740
+ * 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.
75741
+ */
75742
+ untrack(): Word.CommentReplyCollection;
75743
+ /**
75744
+ * 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.)
75745
+ * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
75746
+ */
75747
+ toJSON(): Word.Interfaces.CommentReplyCollectionData;
75748
+ }
75055
75749
  /**
75056
75750
  * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
75057
75751
  *
@@ -75068,6 +75762,13 @@ declare namespace Word {
75068
75762
  * [Api set: WordApi 1.1]
75069
75763
  */
75070
75764
  readonly contentControls: Word.ContentControlCollection;
75765
+ /**
75766
+ * Gets the collection of endnotes in the contentcontrol. Read-only.
75767
+ *
75768
+ * @remarks
75769
+ * [Api set: WordApiOnline 1.1]
75770
+ */
75771
+ readonly endnotes: Word.NoteItemCollection;
75071
75772
  /**
75072
75773
  * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
75073
75774
  *
@@ -75075,6 +75776,13 @@ declare namespace Word {
75075
75776
  * [Api set: WordApi 1.1]
75076
75777
  */
75077
75778
  readonly font: Word.Font;
75779
+ /**
75780
+ * Gets the collection of footnotes in the contentcontrol. Read-only.
75781
+ *
75782
+ * @remarks
75783
+ * [Api set: WordApiOnline 1.1]
75784
+ */
75785
+ readonly footnotes: Word.NoteItemCollection;
75078
75786
  /**
75079
75787
  * Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only.
75080
75788
  *
@@ -75275,6 +75983,13 @@ declare namespace Word {
75275
75983
  * @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
75276
75984
  */
75277
75985
  delete(keepContent: boolean): void;
75986
+ /**
75987
+ * Gets comments associated with the body.
75988
+ *
75989
+ * @remarks
75990
+ * [Api set: WordApiOnline 1.1]
75991
+ */
75992
+ getComments(): Word.CommentCollection;
75278
75993
  /**
75279
75994
  * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML.
75280
75995
  *
@@ -75307,6 +76022,24 @@ declare namespace Word {
75307
76022
  * @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
75308
76023
  */
75309
76024
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
76025
+ /**
76026
+ * Gets reviewed text based on ChangeTrackingVersion selection.
76027
+ *
76028
+ * @remarks
76029
+ * [Api set: WordApiOnline 1.1]
76030
+ *
76031
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
76032
+ */
76033
+ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
76034
+ /**
76035
+ * Gets reviewed text based on ChangeTrackingVersion selection.
76036
+ *
76037
+ * @remarks
76038
+ * [Api set: WordApiOnline 1.1]
76039
+ *
76040
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
76041
+ */
76042
+ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
75310
76043
  /**
75311
76044
  * Gets the text ranges in the content control by using punctuation marks and/or other ending marks.
75312
76045
  *
@@ -75877,6 +76610,13 @@ declare namespace Word {
75877
76610
  * [Api set: WordApi 1.1]
75878
76611
  */
75879
76612
  readonly sections: Word.SectionCollection;
76613
+ /**
76614
+ * Gets or sets the ChangeTracking mode.
76615
+ *
76616
+ * @remarks
76617
+ * [Api set: WordApiOnline 1.1]
76618
+ */
76619
+ changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
75880
76620
  /**
75881
76621
  * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
75882
76622
  *
@@ -75892,6 +76632,22 @@ declare namespace Word {
75892
76632
  set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;
75893
76633
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
75894
76634
  set(properties: Word.Document): void;
76635
+ /**
76636
+ * Gets the document's endnotes in a single body. Read-only.
76637
+ Not implemented in Word on the web.
76638
+ *
76639
+ * @remarks
76640
+ * [Api set: WordApiOnline 1.1]
76641
+ */
76642
+ getEndnoteBody(): Word.Body;
76643
+ /**
76644
+ * Gets the document's footnotes in a single body. Read-only.
76645
+ Not implemented in Word on the web.
76646
+ *
76647
+ * @remarks
76648
+ * [Api set: WordApiOnline 1.1]
76649
+ */
76650
+ getFootnoteBody(): Word.Body;
75895
76651
  /**
75896
76652
  * Gets the current selection of the document. Multiple selections are not supported.
75897
76653
  *
@@ -75906,6 +76662,21 @@ declare namespace Word {
75906
76662
  * [Api set: WordApi 1.1]
75907
76663
  */
75908
76664
  save(): void;
76665
+ /**
76666
+ * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects.
76667
+ *
76668
+ * @remarks
76669
+ * [Api set: WordApiOnline 1.1]
76670
+ */
76671
+ search(searchText: string, searchOptions?: Word.SearchOptions | {
76672
+ ignorePunct?: boolean;
76673
+ ignoreSpace?: boolean;
76674
+ matchCase?: boolean;
76675
+ matchPrefix?: boolean;
76676
+ matchSuffix?: boolean;
76677
+ matchWholeWord?: boolean;
76678
+ matchWildcards?: boolean;
76679
+ }): Word.RangeCollection;
75909
76680
  /**
75910
76681
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
75911
76682
  *
@@ -77142,6 +77913,157 @@ declare namespace Word {
77142
77913
  */
77143
77914
  toJSON(): Word.Interfaces.ListItemData;
77144
77915
  }
77916
+ /**
77917
+ * Represents a footnote or endnote.
77918
+ *
77919
+ * @remarks
77920
+ * [Api set: WordApiOnline 1.1]
77921
+ */
77922
+ class NoteItem extends OfficeExtension.ClientObject {
77923
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
77924
+ context: RequestContext;
77925
+ /**
77926
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
77927
+ *
77928
+ * @remarks
77929
+ * [Api set: WordApiOnline 1.1]
77930
+ */
77931
+ readonly body: Word.Body;
77932
+ /**
77933
+ * Represents a footnote or endnote reference in the main document.
77934
+ *
77935
+ * @remarks
77936
+ * [Api set: WordApiOnline 1.1]
77937
+ */
77938
+ readonly reference: Word.Range;
77939
+ /**
77940
+ * Represents the note item type: footnote or endnote.
77941
+ *
77942
+ * @remarks
77943
+ * [Api set: WordApiOnline 1.1]
77944
+ */
77945
+ readonly type: Word.NoteItemType | "Footnote" | "Endnote";
77946
+ /**
77947
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
77948
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
77949
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
77950
+ */
77951
+ set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
77952
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
77953
+ set(properties: Word.NoteItem): void;
77954
+ /**
77955
+ * Deletes the note item.
77956
+ *
77957
+ * @remarks
77958
+ * [Api set: WordApiOnline 1.1]
77959
+ */
77960
+ delete(): void;
77961
+ /**
77962
+ * Gets the next note item of the same type. Throws an error if this note item is the last one.
77963
+ *
77964
+ * @remarks
77965
+ * [Api set: WordApiOnline 1.1]
77966
+ */
77967
+ getNext(): Word.NoteItem;
77968
+ /**
77969
+ * Gets the next note item of the same type. Returns a null object if this note item is the last one.
77970
+ *
77971
+ * @remarks
77972
+ * [Api set: WordApiOnline 1.1]
77973
+ */
77974
+ getNextOrNullObject(): Word.NoteItem;
77975
+ /**
77976
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
77977
+ *
77978
+ * @param options Provides options for which properties of the object to load.
77979
+ */
77980
+ load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
77981
+ /**
77982
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
77983
+ *
77984
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
77985
+ */
77986
+ load(propertyNames?: string | string[]): Word.NoteItem;
77987
+ /**
77988
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
77989
+ *
77990
+ * @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.
77991
+ */
77992
+ load(propertyNamesAndPaths?: {
77993
+ select?: string;
77994
+ expand?: string;
77995
+ }): Word.NoteItem;
77996
+ /**
77997
+ * 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.
77998
+ */
77999
+ track(): Word.NoteItem;
78000
+ /**
78001
+ * 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.
78002
+ */
78003
+ untrack(): Word.NoteItem;
78004
+ /**
78005
+ * 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.)
78006
+ * Whereas the original Word.NoteItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
78007
+ */
78008
+ toJSON(): Word.Interfaces.NoteItemData;
78009
+ }
78010
+ /**
78011
+ * Contains a collection of {@link Word.NoteItem} objects.
78012
+ *
78013
+ * @remarks
78014
+ * [Api set: WordApiOnline 1.1]
78015
+ */
78016
+ class NoteItemCollection extends OfficeExtension.ClientObject {
78017
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
78018
+ context: RequestContext;
78019
+ /** Gets the loaded child items in this collection. */
78020
+ readonly items: Word.NoteItem[];
78021
+ /**
78022
+ * Gets the first note item in this collection. Throws an error if this collection is empty.
78023
+ *
78024
+ * @remarks
78025
+ * [Api set: WordApiOnline 1.1]
78026
+ */
78027
+ getFirst(): Word.NoteItem;
78028
+ /**
78029
+ * Gets the first note item in this collection. Returns a null object if this collection is empty.
78030
+ *
78031
+ * @remarks
78032
+ * [Api set: WordApiOnline 1.1]
78033
+ */
78034
+ getFirstOrNullObject(): Word.NoteItem;
78035
+ /**
78036
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
78037
+ *
78038
+ * @param options Provides options for which properties of the object to load.
78039
+ */
78040
+ load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection;
78041
+ /**
78042
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
78043
+ *
78044
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
78045
+ */
78046
+ load(propertyNames?: string | string[]): Word.NoteItemCollection;
78047
+ /**
78048
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
78049
+ *
78050
+ * @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.
78051
+ */
78052
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
78053
+ /**
78054
+ * 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.
78055
+ */
78056
+ track(): Word.NoteItemCollection;
78057
+ /**
78058
+ * 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.
78059
+ */
78060
+ untrack(): Word.NoteItemCollection;
78061
+ /**
78062
+ * 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.)
78063
+ * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
78064
+ */
78065
+ toJSON(): Word.Interfaces.NoteItemCollectionData;
78066
+ }
77145
78067
  /**
77146
78068
  * Represents a single paragraph in a selection, range, content control, or document body.
77147
78069
  *
@@ -77158,6 +78080,13 @@ declare namespace Word {
77158
78080
  * [Api set: WordApi 1.1]
77159
78081
  */
77160
78082
  readonly contentControls: Word.ContentControlCollection;
78083
+ /**
78084
+ * Gets the collection of endnotes in the paragraph. Read-only.
78085
+ *
78086
+ * @remarks
78087
+ * [Api set: WordApiOnline 1.1]
78088
+ */
78089
+ readonly endnotes: Word.NoteItemCollection;
77161
78090
  /**
77162
78091
  * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
77163
78092
  *
@@ -77165,6 +78094,13 @@ declare namespace Word {
77165
78094
  * [Api set: WordApi 1.1]
77166
78095
  */
77167
78096
  readonly font: Word.Font;
78097
+ /**
78098
+ * Gets the collection of footnotes in the paragraph. Read-only.
78099
+ *
78100
+ * @remarks
78101
+ * [Api set: WordApiOnline 1.1]
78102
+ */
78103
+ readonly footnotes: Word.NoteItemCollection;
77168
78104
  /**
77169
78105
  * Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images. Read-only.
77170
78106
  *
@@ -77400,6 +78336,13 @@ declare namespace Word {
77400
78336
  * [Api set: WordApi 1.3]
77401
78337
  */
77402
78338
  detachFromList(): void;
78339
+ /**
78340
+ * Gets comments associated with the paragraph.
78341
+ *
78342
+ * @remarks
78343
+ * [Api set: WordApiOnline 1.1]
78344
+ */
78345
+ getComments(): Word.CommentCollection;
77403
78346
  /**
77404
78347
  * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML.
77405
78348
  *
@@ -77460,6 +78403,24 @@ declare namespace Word {
77460
78403
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
77461
78404
  */
77462
78405
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
78406
+ /**
78407
+ * Gets reviewed text based on ChangeTrackingVersion selection.
78408
+ *
78409
+ * @remarks
78410
+ * [Api set: WordApiOnline 1.1]
78411
+ *
78412
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
78413
+ */
78414
+ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
78415
+ /**
78416
+ * Gets reviewed text based on ChangeTrackingVersion selection.
78417
+ *
78418
+ * @remarks
78419
+ * [Api set: WordApiOnline 1.1]
78420
+ *
78421
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
78422
+ */
78423
+ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
77463
78424
  /**
77464
78425
  * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
77465
78426
  *
@@ -77817,6 +78778,13 @@ declare namespace Word {
77817
78778
  * [Api set: WordApi 1.1]
77818
78779
  */
77819
78780
  readonly contentControls: Word.ContentControlCollection;
78781
+ /**
78782
+ * Gets the collection of endnotes in the range. Read-only.
78783
+ *
78784
+ * @remarks
78785
+ * [Api set: WordApiOnline 1.1]
78786
+ */
78787
+ readonly endnotes: Word.NoteItemCollection;
77820
78788
  /**
77821
78789
  * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
77822
78790
  *
@@ -77824,6 +78792,13 @@ declare namespace Word {
77824
78792
  * [Api set: WordApi 1.1]
77825
78793
  */
77826
78794
  readonly font: Word.Font;
78795
+ /**
78796
+ * Gets the collection of footnotes in the range. Read-only.
78797
+ *
78798
+ * @remarks
78799
+ * [Api set: WordApiOnline 1.1]
78800
+ */
78801
+ readonly footnotes: Word.NoteItemCollection;
77827
78802
  /**
77828
78803
  * Gets the collection of inline picture objects in the range. Read-only.
77829
78804
  *
@@ -77985,6 +78960,14 @@ declare namespace Word {
77985
78960
  * @param range Required. Another range.
77986
78961
  */
77987
78962
  expandToOrNullObject(range: Word.Range): Word.Range;
78963
+ /**
78964
+ * Gets comments associated with the range.
78965
+ *
78966
+ * @remarks
78967
+ * [Api set: WordApiOnline 1.1]
78968
+ * @returns
78969
+ */
78970
+ getComments(): Word.CommentCollection;
77988
78971
  /**
77989
78972
  * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method does not return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML.
77990
78973
  *
@@ -78044,6 +79027,24 @@ declare namespace Word {
78044
79027
  * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
78045
79028
  */
78046
79029
  getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
79030
+ /**
79031
+ * Gets reviewed text based on ChangeTrackingVersion selection.
79032
+ *
79033
+ * @remarks
79034
+ * [Api set: WordApiOnline 1.1]
79035
+ *
79036
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
79037
+ */
79038
+ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
79039
+ /**
79040
+ * Gets reviewed text based on ChangeTrackingVersion selection.
79041
+ *
79042
+ * @remarks
79043
+ * [Api set: WordApiOnline 1.1]
79044
+ *
79045
+ * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
79046
+ */
79047
+ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
78047
79048
  /**
78048
79049
  * Gets the text child ranges in the range by using punctuation marks and/or other ending marks.
78049
79050
  *
@@ -78074,6 +79075,16 @@ declare namespace Word {
78074
79075
  * @param insertLocation Required. The value must be 'Before' or 'After'.
78075
79076
  */
78076
79077
  insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
79078
+ /**
79079
+ * Insert a comment on the range.
79080
+ *
79081
+ * @remarks
79082
+ * [Api set: WordApiOnline 1.1]
79083
+ *
79084
+ * @param commentText Required. The comment text to be inserted.
79085
+ * @returns comment object
79086
+ */
79087
+ insertComment(commentText: string): Word.Comment;
78077
79088
  /**
78078
79089
  * Wraps the range object with a rich text content control.
78079
79090
  *
@@ -78081,6 +79092,15 @@ declare namespace Word {
78081
79092
  * [Api set: WordApi 1.1]
78082
79093
  */
78083
79094
  insertContentControl(): Word.ContentControl;
79095
+ /**
79096
+ * Inserts an endnote. The endnote reference is placed after the range.
79097
+ *
79098
+ * @remarks
79099
+ * [Api set: WordApiOnline 1.1]
79100
+ *
79101
+ * @param insertText Optional. Text to be inserted into the endnote body. The default is "".
79102
+ */
79103
+ insertEndnote(insertText?: string): Word.NoteItem;
78084
79104
  /**
78085
79105
  * Inserts a document at the specified location.
78086
79106
  *
@@ -78101,6 +79121,15 @@ declare namespace Word {
78101
79121
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
78102
79122
  */
78103
79123
  insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
79124
+ /**
79125
+ * Inserts a footnote. The footnote reference is placed after the range.
79126
+ *
79127
+ * @remarks
79128
+ * [Api set: WordApiOnline 1.1]
79129
+ *
79130
+ * @param insertText Optional. Text to be inserted into the footnote body. The default is "".
79131
+ */
79132
+ insertFootnote(insertText?: string): Word.NoteItem;
78104
79133
  /**
78105
79134
  * Inserts HTML at the specified location.
78106
79135
  *
@@ -78657,6 +79686,13 @@ declare namespace Word {
78657
79686
  class Table extends OfficeExtension.ClientObject {
78658
79687
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
78659
79688
  context: RequestContext;
79689
+ /**
79690
+ * Gets the collection of endnotes in the table. Read-only.
79691
+ *
79692
+ * @remarks
79693
+ * [Api set: WordApiOnline 1.1]
79694
+ */
79695
+ readonly endnotes: Word.NoteItemCollection;
78660
79696
  /**
78661
79697
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
78662
79698
  *
@@ -78664,6 +79700,13 @@ declare namespace Word {
78664
79700
  * [Api set: WordApi 1.3]
78665
79701
  */
78666
79702
  readonly font: Word.Font;
79703
+ /**
79704
+ * Gets the collection of footnotes in the table. Read-only.
79705
+ *
79706
+ * @remarks
79707
+ * [Api set: WordApiOnline 1.1]
79708
+ */
79709
+ readonly footnotes: Word.NoteItemCollection;
78667
79710
  /**
78668
79711
  * Gets the parent body of the table. Read-only.
78669
79712
  *
@@ -79277,6 +80320,13 @@ declare namespace Word {
79277
80320
  * [Api set: WordApi 1.3]
79278
80321
  */
79279
80322
  readonly cells: Word.TableCellCollection;
80323
+ /**
80324
+ * Gets the collection of endnotes in the table row. Read-only.
80325
+ *
80326
+ * @remarks
80327
+ * [Api set: WordApiOnline 1.1]
80328
+ */
80329
+ readonly endnotes: Word.NoteItemCollection;
79280
80330
  /**
79281
80331
  * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only.
79282
80332
  *
@@ -79284,6 +80334,13 @@ declare namespace Word {
79284
80334
  * [Api set: WordApi 1.3]
79285
80335
  */
79286
80336
  readonly font: Word.Font;
80337
+ /**
80338
+ * Gets the collection of footnotes in the table row. Read-only.
80339
+ *
80340
+ * @remarks
80341
+ * [Api set: WordApiOnline 1.1]
80342
+ */
80343
+ readonly footnotes: Word.NoteItemCollection;
79287
80344
  /**
79288
80345
  * Gets parent table. Read-only.
79289
80346
  *
@@ -79976,6 +81033,68 @@ declare namespace Word {
79976
81033
  */
79977
81034
  toJSON(): Word.Interfaces.TableBorderData;
79978
81035
  }
81036
+ /**
81037
+ * ChangeTracking mode.
81038
+ *
81039
+ * @remarks
81040
+ * [Api set: WordApiOnline 1.1]
81041
+ */
81042
+ enum ChangeTrackingMode {
81043
+ /**
81044
+ * ChangeTracking is turned off.
81045
+ * @remarks
81046
+ * [Api set: WordApiOnline 1.1]
81047
+ */
81048
+ off = "Off",
81049
+ /**
81050
+ * ChangeTracking is turned on for everyone.
81051
+ * @remarks
81052
+ * [Api set: WordApiOnline 1.1]
81053
+ */
81054
+ trackAll = "TrackAll",
81055
+ /**
81056
+ * Tracking is turned on for my changes only.
81057
+ * @remarks
81058
+ * [Api set: WordApiOnline 1.1]
81059
+ */
81060
+ trackMineOnly = "TrackMineOnly",
81061
+ }
81062
+ /**
81063
+ * Specify the current version or the original version of the text.
81064
+ *
81065
+ * @remarks
81066
+ * [Api set: WordApiOnline 1.1]
81067
+ */
81068
+ enum ChangeTrackingVersion {
81069
+ /**
81070
+ * @remarks
81071
+ * [Api set: WordApiOnline 1.1]
81072
+ */
81073
+ original = "Original",
81074
+ /**
81075
+ * @remarks
81076
+ * [Api set: WordApiOnline 1.1]
81077
+ */
81078
+ current = "Current",
81079
+ }
81080
+ /**
81081
+ * Note item type
81082
+ *
81083
+ * @remarks
81084
+ * [Api set: WordApiOnline 1.1]
81085
+ */
81086
+ enum NoteItemType {
81087
+ /**
81088
+ * @remarks
81089
+ * [Api set: WordApiOnline 1.1]
81090
+ */
81091
+ footnote = "Footnote",
81092
+ /**
81093
+ * @remarks
81094
+ * [Api set: WordApiOnline 1.1]
81095
+ */
81096
+ endnote = "Endnote",
81097
+ }
79979
81098
  /**
79980
81099
  * Provides information about the type of a raised event. For each object type, please keep the order of: deleted, selection changed, data changed, added.
79981
81100
  *
@@ -80474,6 +81593,21 @@ declare namespace Word {
80474
81593
  * [Api set: WordApi 1.3]
80475
81594
  */
80476
81595
  tableCell = "TableCell",
81596
+ /**
81597
+ * @remarks
81598
+ * [Api set: WordApiOnline 1.1]
81599
+ */
81600
+ footnote = "Footnote",
81601
+ /**
81602
+ * @remarks
81603
+ * [Api set: WordApiOnline 1.1]
81604
+ */
81605
+ endnote = "Endnote",
81606
+ /**
81607
+ * @remarks
81608
+ * [Api set: WordApiOnline 1.1]
81609
+ */
81610
+ noteItem = "NoteItem",
80477
81611
  }
80478
81612
  /**
80479
81613
  * This enum sets where the cursor (insertion point) in the document is after a selection.
@@ -81791,6 +82925,100 @@ declare namespace Word {
81791
82925
  */
81792
82926
  styleBuiltIn?: Word.Style | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
81793
82927
  }
82928
+ /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
82929
+ interface CommentUpdateData {
82930
+ /**
82931
+ * Gets or sets the comment's content range.
82932
+ *
82933
+ * @remarks
82934
+ * [Api set: WordApiOnline 1.1]
82935
+ */
82936
+ contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
82937
+ /**
82938
+ * Gets or sets the comment's content as plain text.
82939
+ *
82940
+ * @remarks
82941
+ * [Api set: WordApiOnline 1.1]
82942
+ */
82943
+ content?: string;
82944
+ /**
82945
+ * Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
82946
+ *
82947
+ * @remarks
82948
+ * [Api set: WordApiOnline 1.1]
82949
+ */
82950
+ resolved?: boolean;
82951
+ }
82952
+ /** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
82953
+ interface CommentCollectionUpdateData {
82954
+ items?: Word.Interfaces.CommentData[];
82955
+ }
82956
+ /** An interface for updating data on the CommentContentRange object, for use in `commentContentRange.set({ ... })`. */
82957
+ interface CommentContentRangeUpdateData {
82958
+ /**
82959
+ * Gets or sets a value that indicates whether the comment text is bold.
82960
+ *
82961
+ * @remarks
82962
+ * [Api set: WordApiOnline 1.1]
82963
+ */
82964
+ bold?: boolean;
82965
+ /**
82966
+ * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
82967
+ *
82968
+ * @remarks
82969
+ * [Api set: WordApiOnline 1.1]
82970
+ */
82971
+ hyperlink?: string;
82972
+ /**
82973
+ * Gets or sets a value that indicates whether the comment text is italicized.
82974
+ *
82975
+ * @remarks
82976
+ * [Api set: WordApiOnline 1.1]
82977
+ */
82978
+ italic?: boolean;
82979
+ /**
82980
+ * Gets or sets a value that indicates whether the comment text has a strikethrough.
82981
+ *
82982
+ * @remarks
82983
+ * [Api set: WordApiOnline 1.1]
82984
+ */
82985
+ strikeThrough?: boolean;
82986
+ /**
82987
+ * Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
82988
+ *
82989
+ * @remarks
82990
+ * [Api set: WordApiOnline 1.1]
82991
+ */
82992
+ underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
82993
+ }
82994
+ /** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */
82995
+ interface CommentReplyUpdateData {
82996
+ /**
82997
+ * Gets or sets the commentReply's content range.
82998
+ *
82999
+ * @remarks
83000
+ * [Api set: WordApiOnline 1.1]
83001
+ */
83002
+ contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
83003
+ /**
83004
+ * Gets the parent comment of this reply.
83005
+ *
83006
+ * @remarks
83007
+ * [Api set: WordApiOnline 1.1]
83008
+ */
83009
+ parentComment?: Word.Interfaces.CommentUpdateData;
83010
+ /**
83011
+ * Gets or sets the comment reply's content. The string is plain text.
83012
+ *
83013
+ * @remarks
83014
+ * [Api set: WordApiOnline 1.1]
83015
+ */
83016
+ content?: string;
83017
+ }
83018
+ /** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */
83019
+ interface CommentReplyCollectionUpdateData {
83020
+ items?: Word.Interfaces.CommentReplyData[];
83021
+ }
81794
83022
  /** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
81795
83023
  interface ContentControlUpdateData {
81796
83024
  /**
@@ -81906,6 +83134,13 @@ declare namespace Word {
81906
83134
  * [Api set: WordApi 1.3]
81907
83135
  */
81908
83136
  properties?: Word.Interfaces.DocumentPropertiesUpdateData;
83137
+ /**
83138
+ * Gets or sets the ChangeTracking mode.
83139
+ *
83140
+ * @remarks
83141
+ * [Api set: WordApiOnline 1.1]
83142
+ */
83143
+ changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
81909
83144
  }
81910
83145
  /** An interface for updating data on the DocumentCreated object, for use in `documentCreated.set({ ... })`. */
81911
83146
  interface DocumentCreatedUpdateData {
@@ -82134,6 +83369,27 @@ declare namespace Word {
82134
83369
  */
82135
83370
  level?: number;
82136
83371
  }
83372
+ /** An interface for updating data on the NoteItem object, for use in `noteItem.set({ ... })`. */
83373
+ interface NoteItemUpdateData {
83374
+ /**
83375
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
83376
+ *
83377
+ * @remarks
83378
+ * [Api set: WordApiOnline 1.1]
83379
+ */
83380
+ body?: Word.Interfaces.BodyUpdateData;
83381
+ /**
83382
+ * Represents a footnote or endnote reference in the main document.
83383
+ *
83384
+ * @remarks
83385
+ * [Api set: WordApiOnline 1.1]
83386
+ */
83387
+ reference?: Word.Interfaces.RangeUpdateData;
83388
+ }
83389
+ /** An interface for updating data on the NoteItemCollection object, for use in `noteItemCollection.set({ ... })`. */
83390
+ interface NoteItemCollectionUpdateData {
83391
+ items?: Word.Interfaces.NoteItemData[];
83392
+ }
82137
83393
  /** An interface for updating data on the Paragraph object, for use in `paragraph.set({ ... })`. */
82138
83394
  interface ParagraphUpdateData {
82139
83395
  /**
@@ -82652,7 +83908,178 @@ declare namespace Word {
82652
83908
  * @remarks
82653
83909
  * [Api set: WordApi 1.3]
82654
83910
  */
82655
- type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell";
83911
+ type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
83912
+ }
83913
+ /** An interface describing the data returned by calling `comment.toJSON()`. */
83914
+ interface CommentData {
83915
+ /**
83916
+ * Gets or sets the comment's content range.
83917
+ *
83918
+ * @remarks
83919
+ * [Api set: WordApiOnline 1.1]
83920
+ */
83921
+ contentRange?: Word.Interfaces.CommentContentRangeData;
83922
+ /**
83923
+ * Gets the collection of reply objects associated with the comment.
83924
+ *
83925
+ * @remarks
83926
+ * [Api set: WordApiOnline 1.1]
83927
+ */
83928
+ replies?: Word.Interfaces.CommentReplyData[];
83929
+ /**
83930
+ * Gets the email of the comment's author.
83931
+ *
83932
+ * @remarks
83933
+ * [Api set: WordApiOnline 1.1]
83934
+ */
83935
+ authorEmail?: string;
83936
+ /**
83937
+ * Gets the name of the comment's author.
83938
+ *
83939
+ * @remarks
83940
+ * [Api set: WordApiOnline 1.1]
83941
+ */
83942
+ authorName?: string;
83943
+ /**
83944
+ * Gets or sets the comment's content as plain text.
83945
+ *
83946
+ * @remarks
83947
+ * [Api set: WordApiOnline 1.1]
83948
+ */
83949
+ content?: string;
83950
+ /**
83951
+ * Gets the creation date of the comment.
83952
+ *
83953
+ * @remarks
83954
+ * [Api set: WordApiOnline 1.1]
83955
+ */
83956
+ creationDate?: Date;
83957
+ /**
83958
+ * Gets the Id of the comment. Read-only.
83959
+ *
83960
+ * @remarks
83961
+ * [Api set: WordApiOnline 1.1]
83962
+ */
83963
+ id?: string;
83964
+ /**
83965
+ * Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
83966
+ *
83967
+ * @remarks
83968
+ * [Api set: WordApiOnline 1.1]
83969
+ */
83970
+ resolved?: boolean;
83971
+ }
83972
+ /** An interface describing the data returned by calling `commentCollection.toJSON()`. */
83973
+ interface CommentCollectionData {
83974
+ items?: Word.Interfaces.CommentData[];
83975
+ }
83976
+ /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */
83977
+ interface CommentContentRangeData {
83978
+ /**
83979
+ * Gets or sets a value that indicates whether the comment text is bold.
83980
+ *
83981
+ * @remarks
83982
+ * [Api set: WordApiOnline 1.1]
83983
+ */
83984
+ bold?: boolean;
83985
+ /**
83986
+ * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
83987
+ *
83988
+ * @remarks
83989
+ * [Api set: WordApiOnline 1.1]
83990
+ */
83991
+ hyperlink?: string;
83992
+ /**
83993
+ * Checks whether the range length is zero. Read-only.
83994
+ *
83995
+ * @remarks
83996
+ * [Api set: WordApiOnline 1.1]
83997
+ */
83998
+ isEmpty?: boolean;
83999
+ /**
84000
+ * Gets or sets a value that indicates whether the comment text is italicized.
84001
+ *
84002
+ * @remarks
84003
+ * [Api set: WordApiOnline 1.1]
84004
+ */
84005
+ italic?: boolean;
84006
+ /**
84007
+ * Gets or sets a value that indicates whether the comment text has a strikethrough.
84008
+ *
84009
+ * @remarks
84010
+ * [Api set: WordApiOnline 1.1]
84011
+ */
84012
+ strikeThrough?: boolean;
84013
+ /**
84014
+ * Gets the text of the comment range. Read-only.
84015
+ *
84016
+ * @remarks
84017
+ * [Api set: WordApiOnline 1.1]
84018
+ */
84019
+ text?: string;
84020
+ /**
84021
+ * Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
84022
+ *
84023
+ * @remarks
84024
+ * [Api set: WordApiOnline 1.1]
84025
+ */
84026
+ underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
84027
+ }
84028
+ /** An interface describing the data returned by calling `commentReply.toJSON()`. */
84029
+ interface CommentReplyData {
84030
+ /**
84031
+ * Gets or sets the commentReply's content range.
84032
+ *
84033
+ * @remarks
84034
+ * [Api set: WordApiOnline 1.1]
84035
+ */
84036
+ contentRange?: Word.Interfaces.CommentContentRangeData;
84037
+ /**
84038
+ * Gets the parent comment of this reply.
84039
+ *
84040
+ * @remarks
84041
+ * [Api set: WordApiOnline 1.1]
84042
+ */
84043
+ parentComment?: Word.Interfaces.CommentData;
84044
+ /**
84045
+ * Gets the email of the comment reply's author.
84046
+ *
84047
+ * @remarks
84048
+ * [Api set: WordApiOnline 1.1]
84049
+ */
84050
+ authorEmail?: string;
84051
+ /**
84052
+ * Gets the name of the comment reply's author.
84053
+ *
84054
+ * @remarks
84055
+ * [Api set: WordApiOnline 1.1]
84056
+ */
84057
+ authorName?: string;
84058
+ /**
84059
+ * Gets or sets the comment reply's content. The string is plain text.
84060
+ *
84061
+ * @remarks
84062
+ * [Api set: WordApiOnline 1.1]
84063
+ */
84064
+ content?: string;
84065
+ /**
84066
+ * Gets the creation date of the comment reply.
84067
+ *
84068
+ * @remarks
84069
+ * [Api set: WordApiOnline 1.1]
84070
+ */
84071
+ creationDate?: Date;
84072
+ /**
84073
+ * Gets the Id of the comment reply. Read-only.
84074
+ *
84075
+ * @remarks
84076
+ * [Api set: WordApiOnline 1.1]
84077
+ */
84078
+ id?: string;
84079
+ }
84080
+ /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */
84081
+ interface CommentReplyCollectionData {
84082
+ items?: Word.Interfaces.CommentReplyData[];
82656
84083
  }
82657
84084
  /** An interface describing the data returned by calling `contentControl.toJSON()`. */
82658
84085
  interface ContentControlData {
@@ -82860,6 +84287,13 @@ declare namespace Word {
82860
84287
  * [Api set: WordApi 1.1]
82861
84288
  */
82862
84289
  sections?: Word.Interfaces.SectionData[];
84290
+ /**
84291
+ * Gets or sets the ChangeTracking mode.
84292
+ *
84293
+ * @remarks
84294
+ * [Api set: WordApiOnline 1.1]
84295
+ */
84296
+ changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";
82863
84297
  /**
82864
84298
  * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
82865
84299
  *
@@ -83224,6 +84658,34 @@ declare namespace Word {
83224
84658
  */
83225
84659
  siblingIndex?: number;
83226
84660
  }
84661
+ /** An interface describing the data returned by calling `noteItem.toJSON()`. */
84662
+ interface NoteItemData {
84663
+ /**
84664
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
84665
+ *
84666
+ * @remarks
84667
+ * [Api set: WordApiOnline 1.1]
84668
+ */
84669
+ body?: Word.Interfaces.BodyData;
84670
+ /**
84671
+ * Represents a footnote or endnote reference in the main document.
84672
+ *
84673
+ * @remarks
84674
+ * [Api set: WordApiOnline 1.1]
84675
+ */
84676
+ reference?: Word.Interfaces.RangeData;
84677
+ /**
84678
+ * Represents the note item type: footnote or endnote.
84679
+ *
84680
+ * @remarks
84681
+ * [Api set: WordApiOnline 1.1]
84682
+ */
84683
+ type?: Word.NoteItemType | "Footnote" | "Endnote";
84684
+ }
84685
+ /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */
84686
+ interface NoteItemCollectionData {
84687
+ items?: Word.Interfaces.NoteItemData[];
84688
+ }
83227
84689
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
83228
84690
  interface ParagraphData {
83229
84691
  /**
@@ -83900,6 +85362,309 @@ declare namespace Word {
83900
85362
  */
83901
85363
  type?: boolean;
83902
85364
  }
85365
+ /**
85366
+ * Represents a comment in the document.
85367
+ *
85368
+ * @remarks
85369
+ * [Api set: WordApiOnline 1.1]
85370
+ */
85371
+ interface CommentLoadOptions {
85372
+ /**
85373
+ 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`).
85374
+ */
85375
+ $all?: boolean;
85376
+ /**
85377
+ * Gets or sets the comment's content range.
85378
+ *
85379
+ * @remarks
85380
+ * [Api set: WordApiOnline 1.1]
85381
+ */
85382
+ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
85383
+ /**
85384
+ * Gets the email of the comment's author.
85385
+ *
85386
+ * @remarks
85387
+ * [Api set: WordApiOnline 1.1]
85388
+ */
85389
+ authorEmail?: boolean;
85390
+ /**
85391
+ * Gets the name of the comment's author.
85392
+ *
85393
+ * @remarks
85394
+ * [Api set: WordApiOnline 1.1]
85395
+ */
85396
+ authorName?: boolean;
85397
+ /**
85398
+ * Gets or sets the comment's content as plain text.
85399
+ *
85400
+ * @remarks
85401
+ * [Api set: WordApiOnline 1.1]
85402
+ */
85403
+ content?: boolean;
85404
+ /**
85405
+ * Gets the creation date of the comment.
85406
+ *
85407
+ * @remarks
85408
+ * [Api set: WordApiOnline 1.1]
85409
+ */
85410
+ creationDate?: boolean;
85411
+ /**
85412
+ * Gets the Id of the comment. Read-only.
85413
+ *
85414
+ * @remarks
85415
+ * [Api set: WordApiOnline 1.1]
85416
+ */
85417
+ id?: boolean;
85418
+ /**
85419
+ * Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
85420
+ *
85421
+ * @remarks
85422
+ * [Api set: WordApiOnline 1.1]
85423
+ */
85424
+ resolved?: boolean;
85425
+ }
85426
+ /**
85427
+ * Contains a collection of {@link Word.Comment} objects.
85428
+ *
85429
+ * @remarks
85430
+ * [Api set: WordApiOnline 1.1]
85431
+ */
85432
+ interface CommentCollectionLoadOptions {
85433
+ /**
85434
+ 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`).
85435
+ */
85436
+ $all?: boolean;
85437
+ /**
85438
+ * For EACH ITEM in the collection: Gets or sets the comment's content range.
85439
+ *
85440
+ * @remarks
85441
+ * [Api set: WordApiOnline 1.1]
85442
+ */
85443
+ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
85444
+ /**
85445
+ * For EACH ITEM in the collection: Gets the email of the comment's author.
85446
+ *
85447
+ * @remarks
85448
+ * [Api set: WordApiOnline 1.1]
85449
+ */
85450
+ authorEmail?: boolean;
85451
+ /**
85452
+ * For EACH ITEM in the collection: Gets the name of the comment's author.
85453
+ *
85454
+ * @remarks
85455
+ * [Api set: WordApiOnline 1.1]
85456
+ */
85457
+ authorName?: boolean;
85458
+ /**
85459
+ * For EACH ITEM in the collection: Gets or sets the comment's content as plain text.
85460
+ *
85461
+ * @remarks
85462
+ * [Api set: WordApiOnline 1.1]
85463
+ */
85464
+ content?: boolean;
85465
+ /**
85466
+ * For EACH ITEM in the collection: Gets the creation date of the comment.
85467
+ *
85468
+ * @remarks
85469
+ * [Api set: WordApiOnline 1.1]
85470
+ */
85471
+ creationDate?: boolean;
85472
+ /**
85473
+ * For EACH ITEM in the collection: Gets the Id of the comment. Read-only.
85474
+ *
85475
+ * @remarks
85476
+ * [Api set: WordApiOnline 1.1]
85477
+ */
85478
+ id?: boolean;
85479
+ /**
85480
+ * For EACH ITEM in the collection: Gets or sets the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
85481
+ *
85482
+ * @remarks
85483
+ * [Api set: WordApiOnline 1.1]
85484
+ */
85485
+ resolved?: boolean;
85486
+ }
85487
+ /**
85488
+ * @remarks
85489
+ * [Api set: WordApiOnline 1.1]
85490
+ */
85491
+ interface CommentContentRangeLoadOptions {
85492
+ /**
85493
+ 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`).
85494
+ */
85495
+ $all?: boolean;
85496
+ /**
85497
+ * Gets or sets a value that indicates whether the comment text is bold.
85498
+ *
85499
+ * @remarks
85500
+ * [Api set: WordApiOnline 1.1]
85501
+ */
85502
+ bold?: boolean;
85503
+ /**
85504
+ * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range.
85505
+ *
85506
+ * @remarks
85507
+ * [Api set: WordApiOnline 1.1]
85508
+ */
85509
+ hyperlink?: boolean;
85510
+ /**
85511
+ * Checks whether the range length is zero. Read-only.
85512
+ *
85513
+ * @remarks
85514
+ * [Api set: WordApiOnline 1.1]
85515
+ */
85516
+ isEmpty?: boolean;
85517
+ /**
85518
+ * Gets or sets a value that indicates whether the comment text is italicized.
85519
+ *
85520
+ * @remarks
85521
+ * [Api set: WordApiOnline 1.1]
85522
+ */
85523
+ italic?: boolean;
85524
+ /**
85525
+ * Gets or sets a value that indicates whether the comment text has a strikethrough.
85526
+ *
85527
+ * @remarks
85528
+ * [Api set: WordApiOnline 1.1]
85529
+ */
85530
+ strikeThrough?: boolean;
85531
+ /**
85532
+ * Gets the text of the comment range. Read-only.
85533
+ *
85534
+ * @remarks
85535
+ * [Api set: WordApiOnline 1.1]
85536
+ */
85537
+ text?: boolean;
85538
+ /**
85539
+ * Gets or sets a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
85540
+ *
85541
+ * @remarks
85542
+ * [Api set: WordApiOnline 1.1]
85543
+ */
85544
+ underline?: boolean;
85545
+ }
85546
+ /**
85547
+ * Represents a comment reply in the document.
85548
+ *
85549
+ * @remarks
85550
+ * [Api set: WordApiOnline 1.1]
85551
+ */
85552
+ interface CommentReplyLoadOptions {
85553
+ /**
85554
+ 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`).
85555
+ */
85556
+ $all?: boolean;
85557
+ /**
85558
+ * Gets or sets the commentReply's content range.
85559
+ *
85560
+ * @remarks
85561
+ * [Api set: WordApiOnline 1.1]
85562
+ */
85563
+ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
85564
+ /**
85565
+ * Gets the parent comment of this reply.
85566
+ *
85567
+ * @remarks
85568
+ * [Api set: WordApiOnline 1.1]
85569
+ */
85570
+ parentComment?: Word.Interfaces.CommentLoadOptions;
85571
+ /**
85572
+ * Gets the email of the comment reply's author.
85573
+ *
85574
+ * @remarks
85575
+ * [Api set: WordApiOnline 1.1]
85576
+ */
85577
+ authorEmail?: boolean;
85578
+ /**
85579
+ * Gets the name of the comment reply's author.
85580
+ *
85581
+ * @remarks
85582
+ * [Api set: WordApiOnline 1.1]
85583
+ */
85584
+ authorName?: boolean;
85585
+ /**
85586
+ * Gets or sets the comment reply's content. The string is plain text.
85587
+ *
85588
+ * @remarks
85589
+ * [Api set: WordApiOnline 1.1]
85590
+ */
85591
+ content?: boolean;
85592
+ /**
85593
+ * Gets the creation date of the comment reply.
85594
+ *
85595
+ * @remarks
85596
+ * [Api set: WordApiOnline 1.1]
85597
+ */
85598
+ creationDate?: boolean;
85599
+ /**
85600
+ * Gets the Id of the comment reply. Read-only.
85601
+ *
85602
+ * @remarks
85603
+ * [Api set: WordApiOnline 1.1]
85604
+ */
85605
+ id?: boolean;
85606
+ }
85607
+ /**
85608
+ * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread.
85609
+ *
85610
+ * @remarks
85611
+ * [Api set: WordApiOnline 1.1]
85612
+ */
85613
+ interface CommentReplyCollectionLoadOptions {
85614
+ /**
85615
+ 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`).
85616
+ */
85617
+ $all?: boolean;
85618
+ /**
85619
+ * For EACH ITEM in the collection: Gets or sets the commentReply's content range.
85620
+ *
85621
+ * @remarks
85622
+ * [Api set: WordApiOnline 1.1]
85623
+ */
85624
+ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
85625
+ /**
85626
+ * For EACH ITEM in the collection: Gets the parent comment of this reply.
85627
+ *
85628
+ * @remarks
85629
+ * [Api set: WordApiOnline 1.1]
85630
+ */
85631
+ parentComment?: Word.Interfaces.CommentLoadOptions;
85632
+ /**
85633
+ * For EACH ITEM in the collection: Gets the email of the comment reply's author.
85634
+ *
85635
+ * @remarks
85636
+ * [Api set: WordApiOnline 1.1]
85637
+ */
85638
+ authorEmail?: boolean;
85639
+ /**
85640
+ * For EACH ITEM in the collection: Gets the name of the comment reply's author.
85641
+ *
85642
+ * @remarks
85643
+ * [Api set: WordApiOnline 1.1]
85644
+ */
85645
+ authorName?: boolean;
85646
+ /**
85647
+ * For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text.
85648
+ *
85649
+ * @remarks
85650
+ * [Api set: WordApiOnline 1.1]
85651
+ */
85652
+ content?: boolean;
85653
+ /**
85654
+ * For EACH ITEM in the collection: Gets the creation date of the comment reply.
85655
+ *
85656
+ * @remarks
85657
+ * [Api set: WordApiOnline 1.1]
85658
+ */
85659
+ creationDate?: boolean;
85660
+ /**
85661
+ * For EACH ITEM in the collection: Gets the Id of the comment reply. Read-only.
85662
+ *
85663
+ * @remarks
85664
+ * [Api set: WordApiOnline 1.1]
85665
+ */
85666
+ id?: boolean;
85667
+ }
83903
85668
  /**
83904
85669
  * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
83905
85670
  *
@@ -84325,6 +86090,13 @@ declare namespace Word {
84325
86090
  * [Api set: WordApi 1.3]
84326
86091
  */
84327
86092
  properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
86093
+ /**
86094
+ * Gets or sets the ChangeTracking mode.
86095
+ *
86096
+ * @remarks
86097
+ * [Api set: WordApiOnline 1.1]
86098
+ */
86099
+ changeTrackingMode?: boolean;
84328
86100
  /**
84329
86101
  * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
84330
86102
  *
@@ -84892,6 +86664,72 @@ declare namespace Word {
84892
86664
  */
84893
86665
  siblingIndex?: boolean;
84894
86666
  }
86667
+ /**
86668
+ * Represents a footnote or endnote.
86669
+ *
86670
+ * @remarks
86671
+ * [Api set: WordApiOnline 1.1]
86672
+ */
86673
+ interface NoteItemLoadOptions {
86674
+ /**
86675
+ 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`).
86676
+ */
86677
+ $all?: boolean;
86678
+ /**
86679
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
86680
+ *
86681
+ * @remarks
86682
+ * [Api set: WordApiOnline 1.1]
86683
+ */
86684
+ body?: Word.Interfaces.BodyLoadOptions;
86685
+ /**
86686
+ * Represents a footnote or endnote reference in the main document.
86687
+ *
86688
+ * @remarks
86689
+ * [Api set: WordApiOnline 1.1]
86690
+ */
86691
+ reference?: Word.Interfaces.RangeLoadOptions;
86692
+ /**
86693
+ * Represents the note item type: footnote or endnote.
86694
+ *
86695
+ * @remarks
86696
+ * [Api set: WordApiOnline 1.1]
86697
+ */
86698
+ type?: boolean;
86699
+ }
86700
+ /**
86701
+ * Contains a collection of {@link Word.NoteItem} objects.
86702
+ *
86703
+ * @remarks
86704
+ * [Api set: WordApiOnline 1.1]
86705
+ */
86706
+ interface NoteItemCollectionLoadOptions {
86707
+ /**
86708
+ 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`).
86709
+ */
86710
+ $all?: boolean;
86711
+ /**
86712
+ * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
86713
+ *
86714
+ * @remarks
86715
+ * [Api set: WordApiOnline 1.1]
86716
+ */
86717
+ body?: Word.Interfaces.BodyLoadOptions;
86718
+ /**
86719
+ * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
86720
+ *
86721
+ * @remarks
86722
+ * [Api set: WordApiOnline 1.1]
86723
+ */
86724
+ reference?: Word.Interfaces.RangeLoadOptions;
86725
+ /**
86726
+ * For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
86727
+ *
86728
+ * @remarks
86729
+ * [Api set: WordApiOnline 1.1]
86730
+ */
86731
+ type?: boolean;
86732
+ }
84895
86733
  /**
84896
86734
  * Represents a single paragraph in a selection, range, content control, or document body.
84897
86735
  *