@types/office-js 1.0.414 → 1.0.415

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 +2638 -453
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -85851,9 +85851,9 @@ declare namespace Word {
85851
85851
  */
85852
85852
  untrack(): Word.AnnotationCollection;
85853
85853
  /**
85854
- * 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.)
85855
- * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
85856
- */
85854
+ * 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.)
85855
+ * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
85856
+ */
85857
85857
  toJSON(): Word.Interfaces.AnnotationCollectionData;
85858
85858
  }
85859
85859
  /**
@@ -86304,6 +86304,208 @@ declare namespace Word {
86304
86304
  */
86305
86305
  toJSON(): Word.Interfaces.BodyData;
86306
86306
  }
86307
+ /**
86308
+ * Represents the Border object for text, a paragraph, or a table.
86309
+ *
86310
+ * @remarks
86311
+ * [Api set: WordApiDesktop 1.1]
86312
+ */
86313
+ class Border extends OfficeExtension.ClientObject {
86314
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86315
+ context: RequestContext;
86316
+ /**
86317
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
86318
+ *
86319
+ * @remarks
86320
+ * [Api set: WordApiDesktop 1.1]
86321
+ */
86322
+ color: string;
86323
+ /**
86324
+ * Gets the location of the border.
86325
+ *
86326
+ * @remarks
86327
+ * [Api set: WordApiDesktop 1.1]
86328
+ */
86329
+ readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
86330
+ /**
86331
+ * Specifies the border type for the border.
86332
+ *
86333
+ * @remarks
86334
+ * [Api set: WordApiDesktop 1.1]
86335
+ */
86336
+ type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
86337
+ /**
86338
+ * Specifies whether the border is visible.
86339
+ *
86340
+ * @remarks
86341
+ * [Api set: WordApiDesktop 1.1]
86342
+ */
86343
+ visible: boolean;
86344
+ /**
86345
+ * Specifies the width for the border.
86346
+ *
86347
+ * @remarks
86348
+ * [Api set: WordApiDesktop 1.1]
86349
+ */
86350
+ width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86351
+ /**
86352
+ * 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.
86353
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
86354
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
86355
+ */
86356
+ set(properties: Interfaces.BorderUpdateData, options?: OfficeExtension.UpdateOptions): void;
86357
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
86358
+ set(properties: Word.Border): void;
86359
+ /**
86360
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86361
+ *
86362
+ * @param options Provides options for which properties of the object to load.
86363
+ */
86364
+ load(options?: Word.Interfaces.BorderLoadOptions): Word.Border;
86365
+ /**
86366
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86367
+ *
86368
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86369
+ */
86370
+ load(propertyNames?: string | string[]): Word.Border;
86371
+ /**
86372
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86373
+ *
86374
+ * @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.
86375
+ */
86376
+ load(propertyNamesAndPaths?: {
86377
+ select?: string;
86378
+ expand?: string;
86379
+ }): Word.Border;
86380
+ /**
86381
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
86382
+ */
86383
+ track(): Word.Border;
86384
+ /**
86385
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
86386
+ */
86387
+ untrack(): Word.Border;
86388
+ /**
86389
+ * 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.)
86390
+ * Whereas the original `Word.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
86391
+ */
86392
+ toJSON(): Word.Interfaces.BorderData;
86393
+ }
86394
+ /**
86395
+ * Represents the collection of border styles.
86396
+ *
86397
+ * @remarks
86398
+ * [Api set: WordApiDesktop 1.1]
86399
+ */
86400
+ class BorderCollection extends OfficeExtension.ClientObject {
86401
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86402
+ context: RequestContext;
86403
+ /** Gets the loaded child items in this collection. */
86404
+ readonly items: Word.Border[];
86405
+ /**
86406
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
86407
+ *
86408
+ * @remarks
86409
+ * [Api set: WordApiDesktop 1.1]
86410
+ */
86411
+ insideBorderColor: string;
86412
+ /**
86413
+ * Specifies the border type of the inside borders.
86414
+ *
86415
+ * @remarks
86416
+ * [Api set: WordApiDesktop 1.1]
86417
+ */
86418
+ insideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
86419
+ /**
86420
+ * Specifies the width of the inside borders.
86421
+ *
86422
+ * @remarks
86423
+ * [Api set: WordApiDesktop 1.1]
86424
+ */
86425
+ insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86426
+ /**
86427
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
86428
+ *
86429
+ * @remarks
86430
+ * [Api set: WordApiDesktop 1.1]
86431
+ */
86432
+ outsideBorderColor: string;
86433
+ /**
86434
+ * Specifies the border type of the outside borders.
86435
+ *
86436
+ * @remarks
86437
+ * [Api set: WordApiDesktop 1.1]
86438
+ */
86439
+ outsideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
86440
+ /**
86441
+ * Specifies the width of the outside borders.
86442
+ *
86443
+ * @remarks
86444
+ * [Api set: WordApiDesktop 1.1]
86445
+ */
86446
+ outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86447
+ /**
86448
+ * Gets the border that has the specified location.
86449
+ *
86450
+ * @remarks
86451
+ * [Api set: WordApiDesktop 1.1]
86452
+ */
86453
+ getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;
86454
+ /**
86455
+ * Gets the first border in this collection. Throws an `ItemNotFound` error if this collection is empty.
86456
+ *
86457
+ * @remarks
86458
+ * [Api set: WordApiDesktop 1.1]
86459
+ */
86460
+ getFirst(): Word.Border;
86461
+ /**
86462
+ * Gets the first border in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
86463
+ *
86464
+ * @remarks
86465
+ * [Api set: WordApiDesktop 1.1]
86466
+ */
86467
+ getFirstOrNullObject(): Word.Border;
86468
+ /**
86469
+ * Gets a Border object by its index in the collection.
86470
+ *
86471
+ * @remarks
86472
+ * [Api set: WordApiDesktop 1.1]
86473
+ *
86474
+ * @param index A number that identifies the index location of a Border object.
86475
+ */
86476
+ getItem(index: number): Word.Border;
86477
+ /**
86478
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86479
+ *
86480
+ * @param options Provides options for which properties of the object to load.
86481
+ */
86482
+ load(options?: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;
86483
+ /**
86484
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86485
+ *
86486
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86487
+ */
86488
+ load(propertyNames?: string | string[]): Word.BorderCollection;
86489
+ /**
86490
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86491
+ *
86492
+ * @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.
86493
+ */
86494
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;
86495
+ /**
86496
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
86497
+ */
86498
+ track(): Word.BorderCollection;
86499
+ /**
86500
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
86501
+ */
86502
+ untrack(): Word.BorderCollection;
86503
+ /**
86504
+ * 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.)
86505
+ * Whereas the original `Word.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86506
+ */
86507
+ toJSON(): Word.Interfaces.BorderCollectionData;
86508
+ }
86307
86509
  /**
86308
86510
  * The data specific to content controls of type CheckBox.
86309
86511
  *
@@ -86546,9 +86748,9 @@ declare namespace Word {
86546
86748
  */
86547
86749
  untrack(): Word.CommentCollection;
86548
86750
  /**
86549
- * 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.)
86550
- * 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.
86551
- */
86751
+ * 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.)
86752
+ * 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.
86753
+ */
86552
86754
  toJSON(): Word.Interfaces.CommentCollectionData;
86553
86755
  }
86554
86756
  /**
@@ -86820,9 +87022,9 @@ declare namespace Word {
86820
87022
  */
86821
87023
  untrack(): Word.CommentReplyCollection;
86822
87024
  /**
86823
- * 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.)
86824
- * 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.
86825
- */
87025
+ * 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.)
87026
+ * 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.
87027
+ */
86826
87028
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
86827
87029
  }
86828
87030
  /**
@@ -87484,9 +87686,9 @@ declare namespace Word {
87484
87686
  */
87485
87687
  untrack(): Word.ContentControlCollection;
87486
87688
  /**
87487
- * 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.)
87488
- * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87489
- */
87689
+ * 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.)
87690
+ * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87691
+ */
87490
87692
  toJSON(): Word.Interfaces.ContentControlCollectionData;
87491
87693
  }
87492
87694
  /**
@@ -87666,9 +87868,9 @@ declare namespace Word {
87666
87868
  */
87667
87869
  untrack(): Word.CustomPropertyCollection;
87668
87870
  /**
87669
- * 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.)
87670
- * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87671
- */
87871
+ * 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.)
87872
+ * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87873
+ */
87672
87874
  toJSON(): Word.Interfaces.CustomPropertyCollectionData;
87673
87875
  }
87674
87876
  /**
@@ -88031,9 +88233,9 @@ declare namespace Word {
88031
88233
  */
88032
88234
  untrack(): Word.CustomXmlPartCollection;
88033
88235
  /**
88034
- * 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.)
88035
- * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88036
- */
88236
+ * 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.)
88237
+ * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88238
+ */
88037
88239
  toJSON(): Word.Interfaces.CustomXmlPartCollectionData;
88038
88240
  }
88039
88241
  /**
@@ -88113,9 +88315,9 @@ declare namespace Word {
88113
88315
  */
88114
88316
  untrack(): Word.CustomXmlPartScopedCollection;
88115
88317
  /**
88116
- * 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.)
88117
- * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88118
- */
88318
+ * 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.)
88319
+ * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88320
+ */
88119
88321
  toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData;
88120
88322
  }
88121
88323
  /**
@@ -88233,6 +88435,16 @@ declare namespace Word {
88233
88435
  * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'.
88234
88436
  */
88235
88437
  close(closeBehavior?: "Save" | "SkipSave"): void;
88438
+ /**
88439
+ * Displays revision marks that indicate where the specified document differs from another document.
88440
+ *
88441
+ * @remarks
88442
+ * [Api set: WordApiDesktop 1.1]
88443
+ *
88444
+ * @param filePath Required. The path of the document with which the specified document is compared.
88445
+ * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document.
88446
+ */
88447
+ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
88236
88448
  /**
88237
88449
  * Deletes a bookmark, if it exists, from the document.
88238
88450
  *
@@ -88989,6 +89201,13 @@ declare namespace Word {
88989
89201
  * [Api set: WordApi 1.5]
88990
89202
  */
88991
89203
  locked: boolean;
89204
+ /**
89205
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
89206
+ *
89207
+ * @remarks
89208
+ * [Api set: WordApiDesktop 1.1]
89209
+ */
89210
+ showCodes: boolean;
88992
89211
  /**
88993
89212
  * Gets the field's type.
88994
89213
  *
@@ -89152,9 +89371,9 @@ declare namespace Word {
89152
89371
  */
89153
89372
  untrack(): Word.FieldCollection;
89154
89373
  /**
89155
- * 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.)
89156
- * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89157
- */
89374
+ * 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.)
89375
+ * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89376
+ */
89158
89377
  toJSON(): Word.Interfaces.FieldCollectionData;
89159
89378
  }
89160
89379
  /**
@@ -89372,6 +89591,13 @@ declare namespace Word {
89372
89591
  * [Api set: WordApi 1.1]
89373
89592
  */
89374
89593
  hyperlink: string;
89594
+ /**
89595
+ * Gets the format of the inline image.
89596
+ *
89597
+ * @remarks
89598
+ * [Api set: WordApiDesktop 1.1]
89599
+ */
89600
+ readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";
89375
89601
  /**
89376
89602
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
89377
89603
  *
@@ -89615,9 +89841,9 @@ declare namespace Word {
89615
89841
  */
89616
89842
  untrack(): Word.InlinePictureCollection;
89617
89843
  /**
89618
- * 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.)
89619
- * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89620
- */
89844
+ * 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.)
89845
+ * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89846
+ */
89621
89847
  toJSON(): Word.Interfaces.InlinePictureCollectionData;
89622
89848
  }
89623
89849
  /**
@@ -89657,6 +89883,15 @@ declare namespace Word {
89657
89883
  * [Api set: WordApi 1.3]
89658
89884
  */
89659
89885
  readonly levelTypes: Word.ListLevelType[];
89886
+ /**
89887
+ * Gets the font of the bullet, number, or picture at the specified level in the list.
89888
+ *
89889
+ * @remarks
89890
+ * [Api set: WordApiDesktop 1.1]
89891
+ *
89892
+ * @param level Required. The level in the list.
89893
+ */
89894
+ getLevelFont(level: number): Word.Font;
89660
89895
  /**
89661
89896
  * Gets the paragraphs that occur at the specified level in the list.
89662
89897
  *
@@ -89666,6 +89901,15 @@ declare namespace Word {
89666
89901
  * @param level Required. The level in the list.
89667
89902
  */
89668
89903
  getLevelParagraphs(level: number): Word.ParagraphCollection;
89904
+ /**
89905
+ * Gets the Base64-encoded string representation of the picture at the specified level in the list.
89906
+ *
89907
+ * @remarks
89908
+ * [Api set: WordApiDesktop 1.1]
89909
+ *
89910
+ * @param level Required. The level in the list.
89911
+ */
89912
+ getLevelPicture(level: number): OfficeExtension.ClientResult<string>;
89669
89913
  /**
89670
89914
  * Gets the bullet, number, or picture at the specified level as a string.
89671
89915
  *
@@ -89762,6 +90006,16 @@ declare namespace Word {
89762
90006
  * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number.
89763
90007
  */
89764
90008
  setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;
90009
+ /**
90010
+ * Sets the picture at the specified level in the list.
90011
+ *
90012
+ * @remarks
90013
+ * [Api set: WordApiDesktop 1.1]
90014
+ *
90015
+ * @param level Required. The level in the list.
90016
+ * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set.
90017
+ */
90018
+ setLevelPicture(level: number, base64EncodedImage?: string): void;
89765
90019
  /**
89766
90020
  * Sets the starting number at the specified level in the list. Default value is 1.
89767
90021
  *
@@ -89886,9 +90140,9 @@ declare namespace Word {
89886
90140
  */
89887
90141
  untrack(): Word.ListCollection;
89888
90142
  /**
89889
- * 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.)
89890
- * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89891
- */
90143
+ * 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.)
90144
+ * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90145
+ */
89892
90146
  toJSON(): Word.Interfaces.ListCollectionData;
89893
90147
  }
89894
90148
  /**
@@ -89992,88 +90246,340 @@ declare namespace Word {
89992
90246
  toJSON(): Word.Interfaces.ListItemData;
89993
90247
  }
89994
90248
  /**
89995
- * Represents a footnote or endnote.
90249
+ * Represents a list level.
89996
90250
  *
89997
90251
  * @remarks
89998
- * [Api set: WordApi 1.5]
90252
+ * [Api set: WordApiDesktop 1.1]
89999
90253
  */
90000
- class NoteItem extends OfficeExtension.ClientObject {
90254
+ class ListLevel extends OfficeExtension.ClientObject {
90001
90255
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90002
90256
  context: RequestContext;
90003
90257
  /**
90004
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
90258
+ * Gets a Font object that represents the character formatting of the specified object.
90005
90259
  *
90006
90260
  * @remarks
90007
- * [Api set: WordApi 1.5]
90261
+ * [Api set: WordApiDesktop 1.1]
90008
90262
  */
90009
- readonly body: Word.Body;
90263
+ readonly font: Word.Font;
90010
90264
  /**
90011
- * Represents a footnote or endnote reference in the main document.
90265
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
90012
90266
  *
90013
90267
  * @remarks
90014
- * [Api set: WordApi 1.5]
90268
+ * [Api set: WordApiDesktop 1.1]
90015
90269
  */
90016
- readonly reference: Word.Range;
90270
+ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
90017
90271
  /**
90018
- * Represents the note item type: footnote or endnote.
90272
+ * Specifies the name of the style that's linked to the specified list level object.
90019
90273
  *
90020
90274
  * @remarks
90021
- * [Api set: WordApi 1.5]
90275
+ * [Api set: WordApiDesktop 1.1]
90022
90276
  */
90023
- readonly type: Word.NoteItemType | "Footnote" | "Endnote";
90277
+ linkedStyle: string;
90024
90278
  /**
90025
- * 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.
90026
- * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90027
- * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90279
+ * Specifies the number format for the specified list level.
90280
+ *
90281
+ * @remarks
90282
+ * [Api set: WordApiDesktop 1.1]
90028
90283
  */
90029
- set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
90030
- /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90031
- set(properties: Word.NoteItem): void;
90284
+ numberFormat: string;
90032
90285
  /**
90033
- * Deletes the note item.
90286
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
90034
90287
  *
90035
90288
  * @remarks
90036
- * [Api set: WordApi 1.5]
90289
+ * [Api set: WordApiDesktop 1.1]
90037
90290
  */
90038
- delete(): void;
90291
+ numberPosition: number;
90039
90292
  /**
90040
- * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one.
90293
+ * Specifies the number style for the list level object.
90041
90294
  *
90042
90295
  * @remarks
90043
- * [Api set: WordApi 1.5]
90296
+ * [Api set: WordApiDesktop 1.1]
90044
90297
  */
90045
- getNext(): Word.NoteItem;
90298
+ numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
90046
90299
  /**
90047
- * Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
90300
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
90048
90301
  *
90049
90302
  * @remarks
90050
- * [Api set: WordApi 1.5]
90303
+ * [Api set: WordApiDesktop 1.1]
90051
90304
  */
90052
- getNextOrNullObject(): Word.NoteItem;
90305
+ resetOnHigher: number;
90053
90306
  /**
90054
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90307
+ * Specifies the starting number for the specified list level object.
90055
90308
  *
90056
- * @param options Provides options for which properties of the object to load.
90309
+ * @remarks
90310
+ * [Api set: WordApiDesktop 1.1]
90057
90311
  */
90058
- load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
90312
+ startAt: number;
90059
90313
  /**
90060
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90314
+ * Specifies the tab position for the specified list level object.
90061
90315
  *
90062
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90316
+ * @remarks
90317
+ * [Api set: WordApiDesktop 1.1]
90063
90318
  */
90064
- load(propertyNames?: string | string[]): Word.NoteItem;
90319
+ tabPosition: number;
90065
90320
  /**
90066
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90321
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
90067
90322
  *
90068
- * @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.
90323
+ * @remarks
90324
+ * [Api set: WordApiDesktop 1.1]
90069
90325
  */
90070
- load(propertyNamesAndPaths?: {
90071
- select?: string;
90072
- expand?: string;
90073
- }): Word.NoteItem;
90326
+ textPosition: number;
90074
90327
  /**
90075
- * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90076
- */
90328
+ * Specifies the character inserted after the number for the specified list level.
90329
+ *
90330
+ * @remarks
90331
+ * [Api set: WordApiDesktop 1.1]
90332
+ */
90333
+ trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
90334
+ /**
90335
+ * 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.
90336
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90337
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90338
+ */
90339
+ set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void;
90340
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90341
+ set(properties: Word.ListLevel): void;
90342
+ /**
90343
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90344
+ *
90345
+ * @param options Provides options for which properties of the object to load.
90346
+ */
90347
+ load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel;
90348
+ /**
90349
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90350
+ *
90351
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90352
+ */
90353
+ load(propertyNames?: string | string[]): Word.ListLevel;
90354
+ /**
90355
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90356
+ *
90357
+ * @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.
90358
+ */
90359
+ load(propertyNamesAndPaths?: {
90360
+ select?: string;
90361
+ expand?: string;
90362
+ }): Word.ListLevel;
90363
+ /**
90364
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90365
+ */
90366
+ track(): Word.ListLevel;
90367
+ /**
90368
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90369
+ */
90370
+ untrack(): Word.ListLevel;
90371
+ /**
90372
+ * 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.)
90373
+ * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object.
90374
+ */
90375
+ toJSON(): Word.Interfaces.ListLevelData;
90376
+ }
90377
+ /**
90378
+ * Contains a collection of {@link Word.ListLevel} objects.
90379
+ *
90380
+ * @remarks
90381
+ * [Api set: WordApiDesktop 1.1]
90382
+ */
90383
+ class ListLevelCollection extends OfficeExtension.ClientObject {
90384
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90385
+ context: RequestContext;
90386
+ /** Gets the loaded child items in this collection. */
90387
+ readonly items: Word.ListLevel[];
90388
+ /**
90389
+ * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty.
90390
+ *
90391
+ * @remarks
90392
+ * [Api set: WordApiDesktop 1.1]
90393
+ */
90394
+ getFirst(): Word.ListLevel;
90395
+ /**
90396
+ * Gets the first list level in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
90397
+ *
90398
+ * @remarks
90399
+ * [Api set: WordApiDesktop 1.1]
90400
+ */
90401
+ getFirstOrNullObject(): Word.ListLevel;
90402
+ /**
90403
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90404
+ *
90405
+ * @param options Provides options for which properties of the object to load.
90406
+ */
90407
+ load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection;
90408
+ /**
90409
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90410
+ *
90411
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90412
+ */
90413
+ load(propertyNames?: string | string[]): Word.ListLevelCollection;
90414
+ /**
90415
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90416
+ *
90417
+ * @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.
90418
+ */
90419
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection;
90420
+ /**
90421
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90422
+ */
90423
+ track(): Word.ListLevelCollection;
90424
+ /**
90425
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90426
+ */
90427
+ untrack(): Word.ListLevelCollection;
90428
+ /**
90429
+ * 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.)
90430
+ * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90431
+ */
90432
+ toJSON(): Word.Interfaces.ListLevelCollectionData;
90433
+ }
90434
+ /**
90435
+ * Represents a ListTemplate.
90436
+ *
90437
+ * @remarks
90438
+ * [Api set: WordApiDesktop 1.1]
90439
+ */
90440
+ class ListTemplate extends OfficeExtension.ClientObject {
90441
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90442
+ context: RequestContext;
90443
+ /**
90444
+ * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
90445
+ *
90446
+ * @remarks
90447
+ * [Api set: WordApiDesktop 1.1]
90448
+ */
90449
+ readonly listLevels: Word.ListLevelCollection;
90450
+ /**
90451
+ * Specifies whether the specified ListTemplate object is outline numbered.
90452
+ *
90453
+ * @remarks
90454
+ * [Api set: WordApiDesktop 1.1]
90455
+ */
90456
+ outlineNumbered: boolean;
90457
+ /**
90458
+ * 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.
90459
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90460
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90461
+ */
90462
+ set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void;
90463
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90464
+ set(properties: Word.ListTemplate): void;
90465
+ /**
90466
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90467
+ *
90468
+ * @param options Provides options for which properties of the object to load.
90469
+ */
90470
+ load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate;
90471
+ /**
90472
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90473
+ *
90474
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90475
+ */
90476
+ load(propertyNames?: string | string[]): Word.ListTemplate;
90477
+ /**
90478
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90479
+ *
90480
+ * @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.
90481
+ */
90482
+ load(propertyNamesAndPaths?: {
90483
+ select?: string;
90484
+ expand?: string;
90485
+ }): Word.ListTemplate;
90486
+ /**
90487
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90488
+ */
90489
+ track(): Word.ListTemplate;
90490
+ /**
90491
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90492
+ */
90493
+ untrack(): Word.ListTemplate;
90494
+ /**
90495
+ * 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.)
90496
+ * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object.
90497
+ */
90498
+ toJSON(): Word.Interfaces.ListTemplateData;
90499
+ }
90500
+ /**
90501
+ * Represents a footnote or endnote.
90502
+ *
90503
+ * @remarks
90504
+ * [Api set: WordApi 1.5]
90505
+ */
90506
+ class NoteItem extends OfficeExtension.ClientObject {
90507
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90508
+ context: RequestContext;
90509
+ /**
90510
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
90511
+ *
90512
+ * @remarks
90513
+ * [Api set: WordApi 1.5]
90514
+ */
90515
+ readonly body: Word.Body;
90516
+ /**
90517
+ * Represents a footnote or endnote reference in the main document.
90518
+ *
90519
+ * @remarks
90520
+ * [Api set: WordApi 1.5]
90521
+ */
90522
+ readonly reference: Word.Range;
90523
+ /**
90524
+ * Represents the note item type: footnote or endnote.
90525
+ *
90526
+ * @remarks
90527
+ * [Api set: WordApi 1.5]
90528
+ */
90529
+ readonly type: Word.NoteItemType | "Footnote" | "Endnote";
90530
+ /**
90531
+ * 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.
90532
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90533
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90534
+ */
90535
+ set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;
90536
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90537
+ set(properties: Word.NoteItem): void;
90538
+ /**
90539
+ * Deletes the note item.
90540
+ *
90541
+ * @remarks
90542
+ * [Api set: WordApi 1.5]
90543
+ */
90544
+ delete(): void;
90545
+ /**
90546
+ * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one.
90547
+ *
90548
+ * @remarks
90549
+ * [Api set: WordApi 1.5]
90550
+ */
90551
+ getNext(): Word.NoteItem;
90552
+ /**
90553
+ * Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
90554
+ *
90555
+ * @remarks
90556
+ * [Api set: WordApi 1.5]
90557
+ */
90558
+ getNextOrNullObject(): Word.NoteItem;
90559
+ /**
90560
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90561
+ *
90562
+ * @param options Provides options for which properties of the object to load.
90563
+ */
90564
+ load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;
90565
+ /**
90566
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90567
+ *
90568
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90569
+ */
90570
+ load(propertyNames?: string | string[]): Word.NoteItem;
90571
+ /**
90572
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90573
+ *
90574
+ * @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.
90575
+ */
90576
+ load(propertyNamesAndPaths?: {
90577
+ select?: string;
90578
+ expand?: string;
90579
+ }): Word.NoteItem;
90580
+ /**
90581
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90582
+ */
90077
90583
  track(): Word.NoteItem;
90078
90584
  /**
90079
90585
  * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
@@ -90137,9 +90643,9 @@ declare namespace Word {
90137
90643
  */
90138
90644
  untrack(): Word.NoteItemCollection;
90139
90645
  /**
90140
- * 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.)
90141
- * 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.
90142
- */
90646
+ * 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.)
90647
+ * 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.
90648
+ */
90143
90649
  toJSON(): Word.Interfaces.NoteItemCollectionData;
90144
90650
  }
90145
90651
  /**
@@ -90814,9 +91320,9 @@ declare namespace Word {
90814
91320
  */
90815
91321
  untrack(): Word.ParagraphCollection;
90816
91322
  /**
90817
- * 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.)
90818
- * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90819
- */
91323
+ * 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.)
91324
+ * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
91325
+ */
90820
91326
  toJSON(): Word.Interfaces.ParagraphCollectionData;
90821
91327
  }
90822
91328
  /**
@@ -91646,9 +92152,9 @@ declare namespace Word {
91646
92152
  */
91647
92153
  untrack(): Word.RangeCollection;
91648
92154
  /**
91649
- * 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.)
91650
- * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
91651
- */
92155
+ * 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.)
92156
+ * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92157
+ */
91652
92158
  toJSON(): Word.Interfaces.RangeCollectionData;
91653
92159
  }
91654
92160
  /**
@@ -91835,6 +92341,64 @@ declare namespace Word {
91835
92341
  */
91836
92342
  includeTextMarkedAsDeleted?: boolean;
91837
92343
  }
92344
+ /**
92345
+ * Specifies the options to be included in a compare document operation.
92346
+ *
92347
+ * @remarks
92348
+ * [Api set: WordApiDesktop 1.1]
92349
+ */
92350
+ interface DocumentCompareOptions {
92351
+ /**
92352
+ * True adds the document to the list of recently used files on the File menu. The default value is True.
92353
+ *
92354
+ * @remarks
92355
+ * [Api set: WordApiDesktop 1.1]
92356
+ */
92357
+ addToRecentFiles?: boolean;
92358
+ /**
92359
+ * The reviewer name associated with the differences generated by the comparison.
92360
+ If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present.
92361
+ *
92362
+ * @remarks
92363
+ * [Api set: WordApiDesktop 1.1]
92364
+ */
92365
+ authorName?: string;
92366
+ /**
92367
+ * The target document for the comparison. Default value is 'CompareTargetCurrent'.
92368
+ *
92369
+ * @remarks
92370
+ * [Api set: WordApiDesktop 1.1]
92371
+ */
92372
+ compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";
92373
+ /**
92374
+ * True (default) for the comparison to include detection of format changes.
92375
+ *
92376
+ * @remarks
92377
+ * [Api set: WordApiDesktop 1.1]
92378
+ */
92379
+ detectFormatChanges?: boolean;
92380
+ /**
92381
+ * True compares the documents without notifying a user of problems. The default value is False.
92382
+ *
92383
+ * @remarks
92384
+ * [Api set: WordApiDesktop 1.1]
92385
+ */
92386
+ ignoreAllComparisonWarnings?: boolean;
92387
+ /**
92388
+ * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False.
92389
+ *
92390
+ * @remarks
92391
+ * [Api set: WordApiDesktop 1.1]
92392
+ */
92393
+ removeDateAndTime?: boolean;
92394
+ /**
92395
+ * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False.
92396
+ *
92397
+ * @remarks
92398
+ * [Api set: WordApiDesktop 1.1]
92399
+ */
92400
+ removePersonalInformation?: boolean;
92401
+ }
91838
92402
  /**
91839
92403
  * Represents a section in a Word document.
91840
92404
  *
@@ -91996,10 +92560,10 @@ declare namespace Word {
91996
92560
  */
91997
92561
  untrack(): Word.SectionCollection;
91998
92562
  /**
91999
- * 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.)
92000
- * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92001
- */
92002
- toJSON(): Word.Interfaces.SectionCollectionData;
92563
+ * 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.)
92564
+ * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92565
+ */
92566
+ toJSON(): Word.Interfaces.SectionCollectionData;
92003
92567
  }
92004
92568
  /**
92005
92569
  * Represents a setting of the add-in.
@@ -92154,9 +92718,9 @@ declare namespace Word {
92154
92718
  */
92155
92719
  untrack(): Word.SettingCollection;
92156
92720
  /**
92157
- * 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.)
92158
- * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92159
- */
92721
+ * 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.)
92722
+ * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92723
+ */
92160
92724
  toJSON(): Word.Interfaces.SettingCollectionData;
92161
92725
  }
92162
92726
  /**
@@ -92231,9 +92795,9 @@ declare namespace Word {
92231
92795
  */
92232
92796
  untrack(): Word.StyleCollection;
92233
92797
  /**
92234
- * 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.)
92235
- * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92236
- */
92798
+ * 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.)
92799
+ * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92800
+ */
92237
92801
  toJSON(): Word.Interfaces.StyleCollectionData;
92238
92802
  }
92239
92803
  /**
@@ -92245,6 +92809,13 @@ declare namespace Word {
92245
92809
  class Style extends OfficeExtension.ClientObject {
92246
92810
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
92247
92811
  context: RequestContext;
92812
+ /**
92813
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
92814
+ *
92815
+ * @remarks
92816
+ * [Api set: WordApiDesktop 1.1]
92817
+ */
92818
+ readonly borders: Word.BorderCollection;
92248
92819
  /**
92249
92820
  * Gets a font object that represents the character formatting of the specified style.
92250
92821
  *
@@ -92252,6 +92823,13 @@ declare namespace Word {
92252
92823
  * [Api set: WordApi 1.5]
92253
92824
  */
92254
92825
  readonly font: Word.Font;
92826
+ /**
92827
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
92828
+ *
92829
+ * @remarks
92830
+ * [Api set: WordApiDesktop 1.1]
92831
+ */
92832
+ readonly listTemplate: Word.ListTemplate;
92255
92833
  /**
92256
92834
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
92257
92835
  *
@@ -92420,6 +92998,20 @@ declare namespace Word {
92420
92998
  * [Api set: WordApi 1.6]
92421
92999
  */
92422
93000
  backgroundPatternColor: string;
93001
+ /**
93002
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
93003
+ *
93004
+ * @remarks
93005
+ * [Api set: WordApiDesktop 1.1]
93006
+ */
93007
+ foregroundPatternColor: string;
93008
+ /**
93009
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
93010
+ *
93011
+ * @remarks
93012
+ * [Api set: WordApiDesktop 1.1]
93013
+ */
93014
+ texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
92423
93015
  /**
92424
93016
  * 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.
92425
93017
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -93008,6 +93600,20 @@ declare namespace Word {
93008
93600
  class TableStyle extends OfficeExtension.ClientObject {
93009
93601
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93010
93602
  context: RequestContext;
93603
+ /**
93604
+ * Specifies the table's alignment against the page margin.
93605
+ *
93606
+ * @remarks
93607
+ * [Api set: WordApiDesktop 1.1]
93608
+ */
93609
+ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
93610
+ /**
93611
+ * Specifies whether lines in tables formatted with a specified style break across pages.
93612
+ *
93613
+ * @remarks
93614
+ * [Api set: WordApiDesktop 1.1]
93615
+ */
93616
+ allowBreakAcrossPage: boolean;
93011
93617
  /**
93012
93618
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
93013
93619
  *
@@ -93138,9 +93744,9 @@ declare namespace Word {
93138
93744
  */
93139
93745
  untrack(): Word.TableCollection;
93140
93746
  /**
93141
- * 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.)
93142
- * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93143
- */
93747
+ * 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.)
93748
+ * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93749
+ */
93144
93750
  toJSON(): Word.Interfaces.TableCollectionData;
93145
93751
  }
93146
93752
  /**
@@ -93322,6 +93928,13 @@ declare namespace Word {
93322
93928
  * [Api set: WordApi 1.3]
93323
93929
  */
93324
93930
  getNextOrNullObject(): Word.TableRow;
93931
+ /**
93932
+ * Inserts a content control on the row.
93933
+ *
93934
+ * @remarks
93935
+ * [Api set: WordApiDesktop 1.1]
93936
+ */
93937
+ insertContentControl(): Word.ContentControl;
93325
93938
  /**
93326
93939
  * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
93327
93940
  *
@@ -93483,9 +94096,9 @@ declare namespace Word {
93483
94096
  */
93484
94097
  untrack(): Word.TableRowCollection;
93485
94098
  /**
93486
- * 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.)
93487
- * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93488
- */
94099
+ * 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.)
94100
+ * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94101
+ */
93489
94102
  toJSON(): Word.Interfaces.TableRowCollectionData;
93490
94103
  }
93491
94104
  /**
@@ -93785,9 +94398,9 @@ declare namespace Word {
93785
94398
  */
93786
94399
  untrack(): Word.TableCellCollection;
93787
94400
  /**
93788
- * 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.)
93789
- * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93790
- */
94401
+ * 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.)
94402
+ * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94403
+ */
93791
94404
  toJSON(): Word.Interfaces.TableCellCollectionData;
93792
94405
  }
93793
94406
  /**
@@ -94036,9 +94649,9 @@ declare namespace Word {
94036
94649
  */
94037
94650
  untrack(): Word.TrackedChangeCollection;
94038
94651
  /**
94039
- * 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.)
94040
- * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94041
- */
94652
+ * 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.)
94653
+ * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94654
+ */
94042
94655
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
94043
94656
  }
94044
94657
  /**
@@ -95021,6 +95634,82 @@ declare namespace Word {
95021
95634
  */
95022
95635
  end = "End",
95023
95636
  }
95637
+ /**
95638
+ * @remarks
95639
+ * [Api set: WordApiDesktop 1.1]
95640
+ */
95641
+ enum ImageFormat {
95642
+ /**
95643
+ * @remarks
95644
+ * [Api set: WordApiDesktop 1.1]
95645
+ */
95646
+ unsupported = "Unsupported",
95647
+ /**
95648
+ * @remarks
95649
+ * [Api set: WordApiDesktop 1.1]
95650
+ */
95651
+ undefined = "Undefined",
95652
+ /**
95653
+ * @remarks
95654
+ * [Api set: WordApiDesktop 1.1]
95655
+ */
95656
+ bmp = "Bmp",
95657
+ /**
95658
+ * @remarks
95659
+ * [Api set: WordApiDesktop 1.1]
95660
+ */
95661
+ jpeg = "Jpeg",
95662
+ /**
95663
+ * @remarks
95664
+ * [Api set: WordApiDesktop 1.1]
95665
+ */
95666
+ gif = "Gif",
95667
+ /**
95668
+ * @remarks
95669
+ * [Api set: WordApiDesktop 1.1]
95670
+ */
95671
+ tiff = "Tiff",
95672
+ /**
95673
+ * @remarks
95674
+ * [Api set: WordApiDesktop 1.1]
95675
+ */
95676
+ png = "Png",
95677
+ /**
95678
+ * @remarks
95679
+ * [Api set: WordApiDesktop 1.1]
95680
+ */
95681
+ icon = "Icon",
95682
+ /**
95683
+ * @remarks
95684
+ * [Api set: WordApiDesktop 1.1]
95685
+ */
95686
+ exif = "Exif",
95687
+ /**
95688
+ * @remarks
95689
+ * [Api set: WordApiDesktop 1.1]
95690
+ */
95691
+ wmf = "Wmf",
95692
+ /**
95693
+ * @remarks
95694
+ * [Api set: WordApiDesktop 1.1]
95695
+ */
95696
+ emf = "Emf",
95697
+ /**
95698
+ * @remarks
95699
+ * [Api set: WordApiDesktop 1.1]
95700
+ */
95701
+ pict = "Pict",
95702
+ /**
95703
+ * @remarks
95704
+ * [Api set: WordApiDesktop 1.1]
95705
+ */
95706
+ pdf = "Pdf",
95707
+ /**
95708
+ * @remarks
95709
+ * [Api set: WordApiDesktop 1.1]
95710
+ */
95711
+ svg = "Svg",
95712
+ }
95024
95713
  /**
95025
95714
  * @remarks
95026
95715
  * [Api set: WordApi 1.3]
@@ -95230,6 +95919,80 @@ declare namespace Word {
95230
95919
  */
95231
95920
  right = "Right",
95232
95921
  }
95922
+ /**
95923
+ * Represents the width of a style's border.
95924
+ *
95925
+ * @remarks
95926
+ * [Api set: WordApiDesktop 1.1]
95927
+ */
95928
+ enum BorderWidth {
95929
+ /**
95930
+ * None width.
95931
+ * @remarks
95932
+ * [Api set: WordApiDesktop 1.1]
95933
+ */
95934
+ none = "None",
95935
+ /**
95936
+ * 0.25 point.
95937
+ * @remarks
95938
+ * [Api set: WordApiDesktop 1.1]
95939
+ */
95940
+ pt025 = "Pt025",
95941
+ /**
95942
+ * 0.50 point.
95943
+ * @remarks
95944
+ * [Api set: WordApiDesktop 1.1]
95945
+ */
95946
+ pt050 = "Pt050",
95947
+ /**
95948
+ * 0.75 point.
95949
+ * @remarks
95950
+ * [Api set: WordApiDesktop 1.1]
95951
+ */
95952
+ pt075 = "Pt075",
95953
+ /**
95954
+ * 1.00 point. This is the default.
95955
+ * @remarks
95956
+ * [Api set: WordApiDesktop 1.1]
95957
+ */
95958
+ pt100 = "Pt100",
95959
+ /**
95960
+ * 1.50 points.
95961
+ * @remarks
95962
+ * [Api set: WordApiDesktop 1.1]
95963
+ */
95964
+ pt150 = "Pt150",
95965
+ /**
95966
+ * 2.25 points.
95967
+ * @remarks
95968
+ * [Api set: WordApiDesktop 1.1]
95969
+ */
95970
+ pt225 = "Pt225",
95971
+ /**
95972
+ * 3.00 points.
95973
+ * @remarks
95974
+ * [Api set: WordApiDesktop 1.1]
95975
+ */
95976
+ pt300 = "Pt300",
95977
+ /**
95978
+ * 4.50 points.
95979
+ * @remarks
95980
+ * [Api set: WordApiDesktop 1.1]
95981
+ */
95982
+ pt450 = "Pt450",
95983
+ /**
95984
+ * 6.00 points.
95985
+ * @remarks
95986
+ * [Api set: WordApiDesktop 1.1]
95987
+ */
95988
+ pt600 = "Pt600",
95989
+ /**
95990
+ * Mixed width.
95991
+ * @remarks
95992
+ * [Api set: WordApiDesktop 1.1]
95993
+ */
95994
+ mixed = "Mixed",
95995
+ }
95233
95996
  /**
95234
95997
  * @remarks
95235
95998
  * [Api set: WordApi 1.3]
@@ -96990,102 +97753,807 @@ declare namespace Word {
96990
97753
  */
96991
97754
  cold = "Cold",
96992
97755
  }
96993
- enum ErrorCodes {
96994
- accessDenied = "AccessDenied",
96995
- generalException = "GeneralException",
96996
- invalidArgument = "InvalidArgument",
96997
- itemNotFound = "ItemNotFound",
96998
- notAllowed = "NotAllowed",
96999
- notImplemented = "NotImplemented",
97000
- searchDialogIsOpen = "SearchDialogIsOpen",
97001
- searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong",
97756
+ /**
97757
+ * Represents the character inserted after the list item mark.
97758
+ *
97759
+ * @remarks
97760
+ * [Api set: WordApiDesktop 1.1]
97761
+ */
97762
+ enum TrailingCharacter {
97763
+ /**
97764
+ * A tab is inserted.
97765
+ * @remarks
97766
+ * [Api set: WordApiDesktop 1.1]
97767
+ */
97768
+ trailingTab = "TrailingTab",
97769
+ /**
97770
+ * A space is inserted. Default.
97771
+ * @remarks
97772
+ * [Api set: WordApiDesktop 1.1]
97773
+ */
97774
+ trailingSpace = "TrailingSpace",
97775
+ /**
97776
+ * No character is inserted.
97777
+ * @remarks
97778
+ * [Api set: WordApiDesktop 1.1]
97779
+ */
97780
+ trailingNone = "TrailingNone",
97002
97781
  }
97003
- namespace Interfaces {
97782
+ /**
97783
+ * @remarks
97784
+ * [Api set: WordApiDesktop 1.1]
97785
+ */
97786
+ enum ListBuiltInNumberStyle {
97004
97787
  /**
97005
- * Provides ways to load properties of only a subset of members of a collection.
97788
+ * @remarks
97789
+ * [Api set: WordApiDesktop 1.1]
97006
97790
  */
97007
- interface CollectionLoadOptions {
97008
- /**
97009
- * Specify the number of items in the queried collection to be included in the result.
97010
- */
97011
- $top?: number;
97012
- /**
97013
- * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items.
97014
- */
97015
- $skip?: number;
97016
- }
97017
- /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */
97018
- interface AnnotationCollectionUpdateData {
97019
- items?: Word.Interfaces.AnnotationData[];
97020
- }
97021
- /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */
97022
- interface BodyUpdateData {
97023
- /**
97024
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
97025
- *
97026
- * @remarks
97027
- * [Api set: WordApi 1.1]
97028
- */
97029
- font?: Word.Interfaces.FontUpdateData;
97030
- /**
97031
- * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
97032
- *
97033
- * @remarks
97034
- * [Api set: WordApi 1.1]
97035
- */
97036
- style?: string;
97037
- /**
97038
- * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
97039
- *
97040
- * @remarks
97041
- * [Api set: WordApi 1.3]
97042
- */
97043
- styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
97044
- }
97045
- /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */
97046
- interface CheckboxContentControlUpdateData {
97047
- /**
97048
- * Specifies the current state of the checkbox.
97049
- *
97050
- * @remarks
97051
- * [Api set: WordApi 1.7]
97052
- */
97053
- isChecked?: boolean;
97054
- }
97055
- /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */
97056
- interface CommentUpdateData {
97057
- /**
97058
- * Specifies the comment's content range.
97059
- *
97060
- * @remarks
97061
- * [Api set: WordApi 1.4]
97062
- */
97063
- contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
97064
- /**
97065
- * Specifies the comment's content as plain text.
97066
- *
97067
- * @remarks
97068
- * [Api set: WordApi 1.4]
97069
- */
97070
- content?: string;
97071
- /**
97072
- * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
97073
- *
97074
- * @remarks
97075
- * [Api set: WordApi 1.4]
97076
- */
97077
- resolved?: boolean;
97078
- }
97079
- /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */
97080
- interface CommentCollectionUpdateData {
97081
- items?: Word.Interfaces.CommentData[];
97082
- }
97083
- /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */
97084
- interface CommentContentRangeUpdateData {
97085
- /**
97086
- * Specifies a value that indicates whether the comment text is bold.
97087
- *
97088
- * @remarks
97791
+ none = "None",
97792
+ /**
97793
+ * @remarks
97794
+ * [Api set: WordApiDesktop 1.1]
97795
+ */
97796
+ arabic = "Arabic",
97797
+ /**
97798
+ * @remarks
97799
+ * [Api set: WordApiDesktop 1.1]
97800
+ */
97801
+ upperRoman = "UpperRoman",
97802
+ /**
97803
+ * @remarks
97804
+ * [Api set: WordApiDesktop 1.1]
97805
+ */
97806
+ lowerRoman = "LowerRoman",
97807
+ /**
97808
+ * @remarks
97809
+ * [Api set: WordApiDesktop 1.1]
97810
+ */
97811
+ upperLetter = "UpperLetter",
97812
+ /**
97813
+ * @remarks
97814
+ * [Api set: WordApiDesktop 1.1]
97815
+ */
97816
+ lowerLetter = "LowerLetter",
97817
+ /**
97818
+ * @remarks
97819
+ * [Api set: WordApiDesktop 1.1]
97820
+ */
97821
+ ordinal = "Ordinal",
97822
+ /**
97823
+ * @remarks
97824
+ * [Api set: WordApiDesktop 1.1]
97825
+ */
97826
+ cardinalText = "CardinalText",
97827
+ /**
97828
+ * @remarks
97829
+ * [Api set: WordApiDesktop 1.1]
97830
+ */
97831
+ ordinalText = "OrdinalText",
97832
+ /**
97833
+ * @remarks
97834
+ * [Api set: WordApiDesktop 1.1]
97835
+ */
97836
+ kanji = "Kanji",
97837
+ /**
97838
+ * @remarks
97839
+ * [Api set: WordApiDesktop 1.1]
97840
+ */
97841
+ kanjiDigit = "KanjiDigit",
97842
+ /**
97843
+ * @remarks
97844
+ * [Api set: WordApiDesktop 1.1]
97845
+ */
97846
+ aiueoHalfWidth = "AiueoHalfWidth",
97847
+ /**
97848
+ * @remarks
97849
+ * [Api set: WordApiDesktop 1.1]
97850
+ */
97851
+ irohaHalfWidth = "IrohaHalfWidth",
97852
+ /**
97853
+ * @remarks
97854
+ * [Api set: WordApiDesktop 1.1]
97855
+ */
97856
+ arabicFullWidth = "ArabicFullWidth",
97857
+ /**
97858
+ * @remarks
97859
+ * [Api set: WordApiDesktop 1.1]
97860
+ */
97861
+ kanjiTraditional = "KanjiTraditional",
97862
+ /**
97863
+ * @remarks
97864
+ * [Api set: WordApiDesktop 1.1]
97865
+ */
97866
+ kanjiTraditional2 = "KanjiTraditional2",
97867
+ /**
97868
+ * @remarks
97869
+ * [Api set: WordApiDesktop 1.1]
97870
+ */
97871
+ numberInCircle = "NumberInCircle",
97872
+ /**
97873
+ * @remarks
97874
+ * [Api set: WordApiDesktop 1.1]
97875
+ */
97876
+ aiueo = "Aiueo",
97877
+ /**
97878
+ * @remarks
97879
+ * [Api set: WordApiDesktop 1.1]
97880
+ */
97881
+ iroha = "Iroha",
97882
+ /**
97883
+ * @remarks
97884
+ * [Api set: WordApiDesktop 1.1]
97885
+ */
97886
+ arabicLZ = "ArabicLZ",
97887
+ /**
97888
+ * @remarks
97889
+ * [Api set: WordApiDesktop 1.1]
97890
+ */
97891
+ bullet = "Bullet",
97892
+ /**
97893
+ * @remarks
97894
+ * [Api set: WordApiDesktop 1.1]
97895
+ */
97896
+ ganada = "Ganada",
97897
+ /**
97898
+ * @remarks
97899
+ * [Api set: WordApiDesktop 1.1]
97900
+ */
97901
+ chosung = "Chosung",
97902
+ /**
97903
+ * @remarks
97904
+ * [Api set: WordApiDesktop 1.1]
97905
+ */
97906
+ gbnum1 = "GBNum1",
97907
+ /**
97908
+ * @remarks
97909
+ * [Api set: WordApiDesktop 1.1]
97910
+ */
97911
+ gbnum2 = "GBNum2",
97912
+ /**
97913
+ * @remarks
97914
+ * [Api set: WordApiDesktop 1.1]
97915
+ */
97916
+ gbnum3 = "GBNum3",
97917
+ /**
97918
+ * @remarks
97919
+ * [Api set: WordApiDesktop 1.1]
97920
+ */
97921
+ gbnum4 = "GBNum4",
97922
+ /**
97923
+ * @remarks
97924
+ * [Api set: WordApiDesktop 1.1]
97925
+ */
97926
+ zodiac1 = "Zodiac1",
97927
+ /**
97928
+ * @remarks
97929
+ * [Api set: WordApiDesktop 1.1]
97930
+ */
97931
+ zodiac2 = "Zodiac2",
97932
+ /**
97933
+ * @remarks
97934
+ * [Api set: WordApiDesktop 1.1]
97935
+ */
97936
+ zodiac3 = "Zodiac3",
97937
+ /**
97938
+ * @remarks
97939
+ * [Api set: WordApiDesktop 1.1]
97940
+ */
97941
+ tradChinNum1 = "TradChinNum1",
97942
+ /**
97943
+ * @remarks
97944
+ * [Api set: WordApiDesktop 1.1]
97945
+ */
97946
+ tradChinNum2 = "TradChinNum2",
97947
+ /**
97948
+ * @remarks
97949
+ * [Api set: WordApiDesktop 1.1]
97950
+ */
97951
+ tradChinNum3 = "TradChinNum3",
97952
+ /**
97953
+ * @remarks
97954
+ * [Api set: WordApiDesktop 1.1]
97955
+ */
97956
+ tradChinNum4 = "TradChinNum4",
97957
+ /**
97958
+ * @remarks
97959
+ * [Api set: WordApiDesktop 1.1]
97960
+ */
97961
+ simpChinNum1 = "SimpChinNum1",
97962
+ /**
97963
+ * @remarks
97964
+ * [Api set: WordApiDesktop 1.1]
97965
+ */
97966
+ simpChinNum2 = "SimpChinNum2",
97967
+ /**
97968
+ * @remarks
97969
+ * [Api set: WordApiDesktop 1.1]
97970
+ */
97971
+ simpChinNum3 = "SimpChinNum3",
97972
+ /**
97973
+ * @remarks
97974
+ * [Api set: WordApiDesktop 1.1]
97975
+ */
97976
+ simpChinNum4 = "SimpChinNum4",
97977
+ /**
97978
+ * @remarks
97979
+ * [Api set: WordApiDesktop 1.1]
97980
+ */
97981
+ hanjaRead = "HanjaRead",
97982
+ /**
97983
+ * @remarks
97984
+ * [Api set: WordApiDesktop 1.1]
97985
+ */
97986
+ hanjaReadDigit = "HanjaReadDigit",
97987
+ /**
97988
+ * @remarks
97989
+ * [Api set: WordApiDesktop 1.1]
97990
+ */
97991
+ hangul = "Hangul",
97992
+ /**
97993
+ * @remarks
97994
+ * [Api set: WordApiDesktop 1.1]
97995
+ */
97996
+ hanja = "Hanja",
97997
+ /**
97998
+ * @remarks
97999
+ * [Api set: WordApiDesktop 1.1]
98000
+ */
98001
+ hebrew1 = "Hebrew1",
98002
+ /**
98003
+ * @remarks
98004
+ * [Api set: WordApiDesktop 1.1]
98005
+ */
98006
+ arabic1 = "Arabic1",
98007
+ /**
98008
+ * @remarks
98009
+ * [Api set: WordApiDesktop 1.1]
98010
+ */
98011
+ hebrew2 = "Hebrew2",
98012
+ /**
98013
+ * @remarks
98014
+ * [Api set: WordApiDesktop 1.1]
98015
+ */
98016
+ arabic2 = "Arabic2",
98017
+ /**
98018
+ * @remarks
98019
+ * [Api set: WordApiDesktop 1.1]
98020
+ */
98021
+ hindiLetter1 = "HindiLetter1",
98022
+ /**
98023
+ * @remarks
98024
+ * [Api set: WordApiDesktop 1.1]
98025
+ */
98026
+ hindiLetter2 = "HindiLetter2",
98027
+ /**
98028
+ * @remarks
98029
+ * [Api set: WordApiDesktop 1.1]
98030
+ */
98031
+ hindiArabic = "HindiArabic",
98032
+ /**
98033
+ * @remarks
98034
+ * [Api set: WordApiDesktop 1.1]
98035
+ */
98036
+ hindiCardinalText = "HindiCardinalText",
98037
+ /**
98038
+ * @remarks
98039
+ * [Api set: WordApiDesktop 1.1]
98040
+ */
98041
+ thaiLetter = "ThaiLetter",
98042
+ /**
98043
+ * @remarks
98044
+ * [Api set: WordApiDesktop 1.1]
98045
+ */
98046
+ thaiArabic = "ThaiArabic",
98047
+ /**
98048
+ * @remarks
98049
+ * [Api set: WordApiDesktop 1.1]
98050
+ */
98051
+ thaiCardinalText = "ThaiCardinalText",
98052
+ /**
98053
+ * @remarks
98054
+ * [Api set: WordApiDesktop 1.1]
98055
+ */
98056
+ vietCardinalText = "VietCardinalText",
98057
+ /**
98058
+ * @remarks
98059
+ * [Api set: WordApiDesktop 1.1]
98060
+ */
98061
+ lowercaseRussian = "LowercaseRussian",
98062
+ /**
98063
+ * @remarks
98064
+ * [Api set: WordApiDesktop 1.1]
98065
+ */
98066
+ uppercaseRussian = "UppercaseRussian",
98067
+ /**
98068
+ * @remarks
98069
+ * [Api set: WordApiDesktop 1.1]
98070
+ */
98071
+ lowercaseGreek = "LowercaseGreek",
98072
+ /**
98073
+ * @remarks
98074
+ * [Api set: WordApiDesktop 1.1]
98075
+ */
98076
+ uppercaseGreek = "UppercaseGreek",
98077
+ /**
98078
+ * @remarks
98079
+ * [Api set: WordApiDesktop 1.1]
98080
+ */
98081
+ arabicLZ2 = "ArabicLZ2",
98082
+ /**
98083
+ * @remarks
98084
+ * [Api set: WordApiDesktop 1.1]
98085
+ */
98086
+ arabicLZ3 = "ArabicLZ3",
98087
+ /**
98088
+ * @remarks
98089
+ * [Api set: WordApiDesktop 1.1]
98090
+ */
98091
+ arabicLZ4 = "ArabicLZ4",
98092
+ /**
98093
+ * @remarks
98094
+ * [Api set: WordApiDesktop 1.1]
98095
+ */
98096
+ lowercaseTurkish = "LowercaseTurkish",
98097
+ /**
98098
+ * @remarks
98099
+ * [Api set: WordApiDesktop 1.1]
98100
+ */
98101
+ uppercaseTurkish = "UppercaseTurkish",
98102
+ /**
98103
+ * @remarks
98104
+ * [Api set: WordApiDesktop 1.1]
98105
+ */
98106
+ lowercaseBulgarian = "LowercaseBulgarian",
98107
+ /**
98108
+ * @remarks
98109
+ * [Api set: WordApiDesktop 1.1]
98110
+ */
98111
+ uppercaseBulgarian = "UppercaseBulgarian",
98112
+ /**
98113
+ * @remarks
98114
+ * [Api set: WordApiDesktop 1.1]
98115
+ */
98116
+ pictureBullet = "PictureBullet",
98117
+ /**
98118
+ * @remarks
98119
+ * [Api set: WordApiDesktop 1.1]
98120
+ */
98121
+ legal = "Legal",
98122
+ /**
98123
+ * @remarks
98124
+ * [Api set: WordApiDesktop 1.1]
98125
+ */
98126
+ legalLZ = "LegalLZ",
98127
+ }
98128
+ /**
98129
+ * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
98130
+ *
98131
+ * @remarks
98132
+ * [Api set: WordApiDesktop 1.1]
98133
+ */
98134
+ enum ShadingTextureType {
98135
+ /**
98136
+ * Represents dark diagonal-down texture.
98137
+ * @remarks
98138
+ * [Api set: WordApiDesktop 1.1]
98139
+ */
98140
+ darkDiagonalDown = "DarkDiagonalDown",
98141
+ /**
98142
+ * Represents dark diagonal-up texture.
98143
+ * @remarks
98144
+ * [Api set: WordApiDesktop 1.1]
98145
+ */
98146
+ darkDiagonalUp = "DarkDiagonalUp",
98147
+ /**
98148
+ * Represents dark horizontal-cross texture.
98149
+ * @remarks
98150
+ * [Api set: WordApiDesktop 1.1]
98151
+ */
98152
+ darkGrid = "DarkGrid",
98153
+ /**
98154
+ * Represents dark horizontal texture.
98155
+ * @remarks
98156
+ * [Api set: WordApiDesktop 1.1]
98157
+ */
98158
+ darkHorizontal = "DarkHorizontal",
98159
+ /**
98160
+ * Represents dark diagonal-cross texture.
98161
+ * @remarks
98162
+ * [Api set: WordApiDesktop 1.1]
98163
+ */
98164
+ darkTrellis = "DarkTrellis",
98165
+ /**
98166
+ * Represents dark vertical texture.
98167
+ * @remarks
98168
+ * [Api set: WordApiDesktop 1.1]
98169
+ */
98170
+ darkVertical = "DarkVertical",
98171
+ /**
98172
+ * Represents light diagonal-down texture.
98173
+ * @remarks
98174
+ * [Api set: WordApiDesktop 1.1]
98175
+ */
98176
+ lightDiagonalDown = "LightDiagonalDown",
98177
+ /**
98178
+ * Represents light diagonal-up texture.
98179
+ * @remarks
98180
+ * [Api set: WordApiDesktop 1.1]
98181
+ */
98182
+ lightDiagonalUp = "LightDiagonalUp",
98183
+ /**
98184
+ * Represents light horizontal-cross texture.
98185
+ * @remarks
98186
+ * [Api set: WordApiDesktop 1.1]
98187
+ */
98188
+ lightGrid = "LightGrid",
98189
+ /**
98190
+ * Represents light horizontal texture.
98191
+ * @remarks
98192
+ * [Api set: WordApiDesktop 1.1]
98193
+ */
98194
+ lightHorizontal = "LightHorizontal",
98195
+ /**
98196
+ * Represents light diagonal-cross texture.
98197
+ * @remarks
98198
+ * [Api set: WordApiDesktop 1.1]
98199
+ */
98200
+ lightTrellis = "LightTrellis",
98201
+ /**
98202
+ * Represents light vertical texture.
98203
+ * @remarks
98204
+ * [Api set: WordApiDesktop 1.1]
98205
+ */
98206
+ lightVertical = "LightVertical",
98207
+ /**
98208
+ * Represents that there's no texture.
98209
+ * @remarks
98210
+ * [Api set: WordApiDesktop 1.1]
98211
+ */
98212
+ none = "None",
98213
+ /**
98214
+ * Represents 10 percent texture.
98215
+ * @remarks
98216
+ * [Api set: WordApiDesktop 1.1]
98217
+ */
98218
+ percent10 = "Percent10",
98219
+ /**
98220
+ * Represents 12.5 percent texture.
98221
+ * @remarks
98222
+ * [Api set: WordApiDesktop 1.1]
98223
+ */
98224
+ percent12Pt5 = "Percent12Pt5",
98225
+ /**
98226
+ * Represents 15 percent texture.
98227
+ * @remarks
98228
+ * [Api set: WordApiDesktop 1.1]
98229
+ */
98230
+ percent15 = "Percent15",
98231
+ /**
98232
+ * Represents 20 percent texture.
98233
+ * @remarks
98234
+ * [Api set: WordApiDesktop 1.1]
98235
+ */
98236
+ percent20 = "Percent20",
98237
+ /**
98238
+ * Represents 25 percent texture.
98239
+ * @remarks
98240
+ * [Api set: WordApiDesktop 1.1]
98241
+ */
98242
+ percent25 = "Percent25",
98243
+ /**
98244
+ * Represents 30 percent texture.
98245
+ * @remarks
98246
+ * [Api set: WordApiDesktop 1.1]
98247
+ */
98248
+ percent30 = "Percent30",
98249
+ /**
98250
+ * Represents 35 percent texture.
98251
+ * @remarks
98252
+ * [Api set: WordApiDesktop 1.1]
98253
+ */
98254
+ percent35 = "Percent35",
98255
+ /**
98256
+ * Represents 37.5 percent texture.
98257
+ * @remarks
98258
+ * [Api set: WordApiDesktop 1.1]
98259
+ */
98260
+ percent37Pt5 = "Percent37Pt5",
98261
+ /**
98262
+ * Represents 40 percent texture.
98263
+ * @remarks
98264
+ * [Api set: WordApiDesktop 1.1]
98265
+ */
98266
+ percent40 = "Percent40",
98267
+ /**
98268
+ * Represents 45 percent texture.
98269
+ * @remarks
98270
+ * [Api set: WordApiDesktop 1.1]
98271
+ */
98272
+ percent45 = "Percent45",
98273
+ /**
98274
+ * Represents 5 percent texture.
98275
+ * @remarks
98276
+ * [Api set: WordApiDesktop 1.1]
98277
+ */
98278
+ percent5 = "Percent5",
98279
+ /**
98280
+ * Represents 50 percent texture.
98281
+ * @remarks
98282
+ * [Api set: WordApiDesktop 1.1]
98283
+ */
98284
+ percent50 = "Percent50",
98285
+ /**
98286
+ * Represents 55 percent texture.
98287
+ * @remarks
98288
+ * [Api set: WordApiDesktop 1.1]
98289
+ */
98290
+ percent55 = "Percent55",
98291
+ /**
98292
+ * Represents 60 percent texture.
98293
+ * @remarks
98294
+ * [Api set: WordApiDesktop 1.1]
98295
+ */
98296
+ percent60 = "Percent60",
98297
+ /**
98298
+ * Represents 62.5 percent texture.
98299
+ * @remarks
98300
+ * [Api set: WordApiDesktop 1.1]
98301
+ */
98302
+ percent62Pt5 = "Percent62Pt5",
98303
+ /**
98304
+ * Represents 65 percent texture.
98305
+ * @remarks
98306
+ * [Api set: WordApiDesktop 1.1]
98307
+ */
98308
+ percent65 = "Percent65",
98309
+ /**
98310
+ * Represents 70 percent texture.
98311
+ * @remarks
98312
+ * [Api set: WordApiDesktop 1.1]
98313
+ */
98314
+ percent70 = "Percent70",
98315
+ /**
98316
+ * Represents 75 percent texture.
98317
+ * @remarks
98318
+ * [Api set: WordApiDesktop 1.1]
98319
+ */
98320
+ percent75 = "Percent75",
98321
+ /**
98322
+ * Represents 80 percent texture.
98323
+ * @remarks
98324
+ * [Api set: WordApiDesktop 1.1]
98325
+ */
98326
+ percent80 = "Percent80",
98327
+ /**
98328
+ * Represents 85 percent texture.
98329
+ * @remarks
98330
+ * [Api set: WordApiDesktop 1.1]
98331
+ */
98332
+ percent85 = "Percent85",
98333
+ /**
98334
+ * Represents 87.5 percent texture.
98335
+ * @remarks
98336
+ * [Api set: WordApiDesktop 1.1]
98337
+ */
98338
+ percent87Pt5 = "Percent87Pt5",
98339
+ /**
98340
+ * Represents 90 percent texture.
98341
+ * @remarks
98342
+ * [Api set: WordApiDesktop 1.1]
98343
+ */
98344
+ percent90 = "Percent90",
98345
+ /**
98346
+ * Represents 95 percent texture.
98347
+ * @remarks
98348
+ * [Api set: WordApiDesktop 1.1]
98349
+ */
98350
+ percent95 = "Percent95",
98351
+ /**
98352
+ * Represents solid texture.
98353
+ * @remarks
98354
+ * [Api set: WordApiDesktop 1.1]
98355
+ */
98356
+ solid = "Solid",
98357
+ }
98358
+ /**
98359
+ * Specifies the target document for displaying document comparison differences.
98360
+ *
98361
+ * @remarks
98362
+ * [Api set: WordApiDesktop 1.1]
98363
+ */
98364
+ enum CompareTarget {
98365
+ /**
98366
+ * Places comparison differences in the current document.
98367
+ * @remarks
98368
+ * [Api set: WordApiDesktop 1.1]
98369
+ */
98370
+ compareTargetCurrent = "CompareTargetCurrent",
98371
+ /**
98372
+ * Places comparison differences in the target document.
98373
+ * @remarks
98374
+ * [Api set: WordApiDesktop 1.1]
98375
+ */
98376
+ compareTargetSelected = "CompareTargetSelected",
98377
+ /**
98378
+ * Places comparison differences in a new document.
98379
+ * @remarks
98380
+ * [Api set: WordApiDesktop 1.1]
98381
+ */
98382
+ compareTargetNew = "CompareTargetNew",
98383
+ }
98384
+ enum ErrorCodes {
98385
+ accessDenied = "AccessDenied",
98386
+ generalException = "GeneralException",
98387
+ invalidArgument = "InvalidArgument",
98388
+ itemNotFound = "ItemNotFound",
98389
+ notAllowed = "NotAllowed",
98390
+ notImplemented = "NotImplemented",
98391
+ searchDialogIsOpen = "SearchDialogIsOpen",
98392
+ searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong",
98393
+ }
98394
+ namespace Interfaces {
98395
+ /**
98396
+ * Provides ways to load properties of only a subset of members of a collection.
98397
+ */
98398
+ interface CollectionLoadOptions {
98399
+ /**
98400
+ * Specify the number of items in the queried collection to be included in the result.
98401
+ */
98402
+ $top?: number;
98403
+ /**
98404
+ * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items.
98405
+ */
98406
+ $skip?: number;
98407
+ }
98408
+ /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */
98409
+ interface AnnotationCollectionUpdateData {
98410
+ items?: Word.Interfaces.AnnotationData[];
98411
+ }
98412
+ /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */
98413
+ interface BodyUpdateData {
98414
+ /**
98415
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
98416
+ *
98417
+ * @remarks
98418
+ * [Api set: WordApi 1.1]
98419
+ */
98420
+ font?: Word.Interfaces.FontUpdateData;
98421
+ /**
98422
+ * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
98423
+ *
98424
+ * @remarks
98425
+ * [Api set: WordApi 1.1]
98426
+ */
98427
+ style?: string;
98428
+ /**
98429
+ * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
98430
+ *
98431
+ * @remarks
98432
+ * [Api set: WordApi 1.3]
98433
+ */
98434
+ styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
98435
+ }
98436
+ /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */
98437
+ interface BorderUpdateData {
98438
+ /**
98439
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
98440
+ *
98441
+ * @remarks
98442
+ * [Api set: WordApiDesktop 1.1]
98443
+ */
98444
+ color?: string;
98445
+ /**
98446
+ * Specifies the border type for the border.
98447
+ *
98448
+ * @remarks
98449
+ * [Api set: WordApiDesktop 1.1]
98450
+ */
98451
+ type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
98452
+ /**
98453
+ * Specifies whether the border is visible.
98454
+ *
98455
+ * @remarks
98456
+ * [Api set: WordApiDesktop 1.1]
98457
+ */
98458
+ visible?: boolean;
98459
+ /**
98460
+ * Specifies the width for the border.
98461
+ *
98462
+ * @remarks
98463
+ * [Api set: WordApiDesktop 1.1]
98464
+ */
98465
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98466
+ }
98467
+ /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */
98468
+ interface BorderCollectionUpdateData {
98469
+ /**
98470
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
98471
+ *
98472
+ * @remarks
98473
+ * [Api set: WordApiDesktop 1.1]
98474
+ */
98475
+ insideBorderColor?: string;
98476
+ /**
98477
+ * Specifies the border type of the inside borders.
98478
+ *
98479
+ * @remarks
98480
+ * [Api set: WordApiDesktop 1.1]
98481
+ */
98482
+ insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
98483
+ /**
98484
+ * Specifies the width of the inside borders.
98485
+ *
98486
+ * @remarks
98487
+ * [Api set: WordApiDesktop 1.1]
98488
+ */
98489
+ insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98490
+ /**
98491
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
98492
+ *
98493
+ * @remarks
98494
+ * [Api set: WordApiDesktop 1.1]
98495
+ */
98496
+ outsideBorderColor?: string;
98497
+ /**
98498
+ * Specifies the border type of the outside borders.
98499
+ *
98500
+ * @remarks
98501
+ * [Api set: WordApiDesktop 1.1]
98502
+ */
98503
+ outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
98504
+ /**
98505
+ * Specifies the width of the outside borders.
98506
+ *
98507
+ * @remarks
98508
+ * [Api set: WordApiDesktop 1.1]
98509
+ */
98510
+ outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98511
+ items?: Word.Interfaces.BorderData[];
98512
+ }
98513
+ /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */
98514
+ interface CheckboxContentControlUpdateData {
98515
+ /**
98516
+ * Specifies the current state of the checkbox.
98517
+ *
98518
+ * @remarks
98519
+ * [Api set: WordApi 1.7]
98520
+ */
98521
+ isChecked?: boolean;
98522
+ }
98523
+ /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */
98524
+ interface CommentUpdateData {
98525
+ /**
98526
+ * Specifies the comment's content range.
98527
+ *
98528
+ * @remarks
98529
+ * [Api set: WordApi 1.4]
98530
+ */
98531
+ contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
98532
+ /**
98533
+ * Specifies the comment's content as plain text.
98534
+ *
98535
+ * @remarks
98536
+ * [Api set: WordApi 1.4]
98537
+ */
98538
+ content?: string;
98539
+ /**
98540
+ * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.
98541
+ *
98542
+ * @remarks
98543
+ * [Api set: WordApi 1.4]
98544
+ */
98545
+ resolved?: boolean;
98546
+ }
98547
+ /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */
98548
+ interface CommentCollectionUpdateData {
98549
+ items?: Word.Interfaces.CommentData[];
98550
+ }
98551
+ /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */
98552
+ interface CommentContentRangeUpdateData {
98553
+ /**
98554
+ * Specifies a value that indicates whether the comment text is bold.
98555
+ *
98556
+ * @remarks
97089
98557
  * [Api set: WordApi 1.4]
97090
98558
  */
97091
98559
  bold?: boolean;
@@ -97400,6 +98868,13 @@ declare namespace Word {
97400
98868
  * [Api set: WordApi 1.5]
97401
98869
  */
97402
98870
  locked?: boolean;
98871
+ /**
98872
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
98873
+ *
98874
+ * @remarks
98875
+ * [Api set: WordApiDesktop 1.1]
98876
+ */
98877
+ showCodes?: boolean;
97403
98878
  }
97404
98879
  /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */
97405
98880
  interface FieldCollectionUpdateData {
@@ -97453,100 +98928,194 @@ declare namespace Word {
97453
98928
  * Specifies a value that represents the font size in points.
97454
98929
  *
97455
98930
  * @remarks
97456
- * [Api set: WordApi 1.1]
98931
+ * [Api set: WordApi 1.1]
98932
+ */
98933
+ size?: number;
98934
+ /**
98935
+ * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false.
98936
+ *
98937
+ * @remarks
98938
+ * [Api set: WordApi 1.1]
98939
+ */
98940
+ strikeThrough?: boolean;
98941
+ /**
98942
+ * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.
98943
+ *
98944
+ * @remarks
98945
+ * [Api set: WordApi 1.1]
98946
+ */
98947
+ subscript?: boolean;
98948
+ /**
98949
+ * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.
98950
+ *
98951
+ * @remarks
98952
+ * [Api set: WordApi 1.1]
98953
+ */
98954
+ superscript?: boolean;
98955
+ /**
98956
+ * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
98957
+ *
98958
+ * @remarks
98959
+ * [Api set: WordApi 1.1]
98960
+ */
98961
+ underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
98962
+ }
98963
+ /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */
98964
+ interface InlinePictureUpdateData {
98965
+ /**
98966
+ * Specifies a string that represents the alternative text associated with the inline image.
98967
+ *
98968
+ * @remarks
98969
+ * [Api set: WordApi 1.1]
98970
+ */
98971
+ altTextDescription?: string;
98972
+ /**
98973
+ * Specifies a string that contains the title for the inline image.
98974
+ *
98975
+ * @remarks
98976
+ * [Api set: WordApi 1.1]
98977
+ */
98978
+ altTextTitle?: string;
98979
+ /**
98980
+ * Specifies a number that describes the height of the inline image.
98981
+ *
98982
+ * @remarks
98983
+ * [Api set: WordApi 1.1]
98984
+ */
98985
+ height?: number;
98986
+ /**
98987
+ * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part.
98988
+ *
98989
+ * @remarks
98990
+ * [Api set: WordApi 1.1]
98991
+ */
98992
+ hyperlink?: string;
98993
+ /**
98994
+ * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
98995
+ *
98996
+ * @remarks
98997
+ * [Api set: WordApi 1.1]
98998
+ */
98999
+ lockAspectRatio?: boolean;
99000
+ /**
99001
+ * Specifies a number that describes the width of the inline image.
99002
+ *
99003
+ * @remarks
99004
+ * [Api set: WordApi 1.1]
99005
+ */
99006
+ width?: number;
99007
+ }
99008
+ /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */
99009
+ interface InlinePictureCollectionUpdateData {
99010
+ items?: Word.Interfaces.InlinePictureData[];
99011
+ }
99012
+ /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */
99013
+ interface ListCollectionUpdateData {
99014
+ items?: Word.Interfaces.ListData[];
99015
+ }
99016
+ /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */
99017
+ interface ListItemUpdateData {
99018
+ /**
99019
+ * Specifies the level of the item in the list.
99020
+ *
99021
+ * @remarks
99022
+ * [Api set: WordApi 1.3]
99023
+ */
99024
+ level?: number;
99025
+ }
99026
+ /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */
99027
+ interface ListLevelUpdateData {
99028
+ /**
99029
+ * Gets a Font object that represents the character formatting of the specified object.
99030
+ *
99031
+ * @remarks
99032
+ * [Api set: WordApiDesktop 1.1]
97457
99033
  */
97458
- size?: number;
99034
+ font?: Word.Interfaces.FontUpdateData;
97459
99035
  /**
97460
- * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false.
99036
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
97461
99037
  *
97462
99038
  * @remarks
97463
- * [Api set: WordApi 1.1]
99039
+ * [Api set: WordApiDesktop 1.1]
97464
99040
  */
97465
- strikeThrough?: boolean;
99041
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
97466
99042
  /**
97467
- * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.
99043
+ * Specifies the name of the style that's linked to the specified list level object.
97468
99044
  *
97469
99045
  * @remarks
97470
- * [Api set: WordApi 1.1]
99046
+ * [Api set: WordApiDesktop 1.1]
97471
99047
  */
97472
- subscript?: boolean;
99048
+ linkedStyle?: string;
97473
99049
  /**
97474
- * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.
99050
+ * Specifies the number format for the specified list level.
97475
99051
  *
97476
99052
  * @remarks
97477
- * [Api set: WordApi 1.1]
99053
+ * [Api set: WordApiDesktop 1.1]
97478
99054
  */
97479
- superscript?: boolean;
99055
+ numberFormat?: string;
97480
99056
  /**
97481
- * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
99057
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
97482
99058
  *
97483
99059
  * @remarks
97484
- * [Api set: WordApi 1.1]
99060
+ * [Api set: WordApiDesktop 1.1]
97485
99061
  */
97486
- underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";
97487
- }
97488
- /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */
97489
- interface InlinePictureUpdateData {
99062
+ numberPosition?: number;
97490
99063
  /**
97491
- * Specifies a string that represents the alternative text associated with the inline image.
99064
+ * Specifies the number style for the list level object.
97492
99065
  *
97493
99066
  * @remarks
97494
- * [Api set: WordApi 1.1]
99067
+ * [Api set: WordApiDesktop 1.1]
97495
99068
  */
97496
- altTextDescription?: string;
99069
+ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
97497
99070
  /**
97498
- * Specifies a string that contains the title for the inline image.
99071
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
97499
99072
  *
97500
99073
  * @remarks
97501
- * [Api set: WordApi 1.1]
99074
+ * [Api set: WordApiDesktop 1.1]
97502
99075
  */
97503
- altTextTitle?: string;
99076
+ resetOnHigher?: number;
97504
99077
  /**
97505
- * Specifies a number that describes the height of the inline image.
99078
+ * Specifies the starting number for the specified list level object.
97506
99079
  *
97507
99080
  * @remarks
97508
- * [Api set: WordApi 1.1]
99081
+ * [Api set: WordApiDesktop 1.1]
97509
99082
  */
97510
- height?: number;
99083
+ startAt?: number;
97511
99084
  /**
97512
- * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part.
99085
+ * Specifies the tab position for the specified list level object.
97513
99086
  *
97514
99087
  * @remarks
97515
- * [Api set: WordApi 1.1]
99088
+ * [Api set: WordApiDesktop 1.1]
97516
99089
  */
97517
- hyperlink?: string;
99090
+ tabPosition?: number;
97518
99091
  /**
97519
- * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
99092
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
97520
99093
  *
97521
99094
  * @remarks
97522
- * [Api set: WordApi 1.1]
99095
+ * [Api set: WordApiDesktop 1.1]
97523
99096
  */
97524
- lockAspectRatio?: boolean;
99097
+ textPosition?: number;
97525
99098
  /**
97526
- * Specifies a number that describes the width of the inline image.
99099
+ * Specifies the character inserted after the number for the specified list level.
97527
99100
  *
97528
99101
  * @remarks
97529
- * [Api set: WordApi 1.1]
99102
+ * [Api set: WordApiDesktop 1.1]
97530
99103
  */
97531
- width?: number;
97532
- }
97533
- /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */
97534
- interface InlinePictureCollectionUpdateData {
97535
- items?: Word.Interfaces.InlinePictureData[];
99104
+ trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
97536
99105
  }
97537
- /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */
97538
- interface ListCollectionUpdateData {
97539
- items?: Word.Interfaces.ListData[];
99106
+ /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */
99107
+ interface ListLevelCollectionUpdateData {
99108
+ items?: Word.Interfaces.ListLevelData[];
97540
99109
  }
97541
- /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */
97542
- interface ListItemUpdateData {
99110
+ /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */
99111
+ interface ListTemplateUpdateData {
97543
99112
  /**
97544
- * Specifies the level of the item in the list.
99113
+ * Specifies whether the specified ListTemplate object is outline numbered.
97545
99114
  *
97546
99115
  * @remarks
97547
- * [Api set: WordApi 1.3]
99116
+ * [Api set: WordApiDesktop 1.1]
97548
99117
  */
97549
- level?: number;
99118
+ outlineNumbered?: boolean;
97550
99119
  }
97551
99120
  /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */
97552
99121
  interface NoteItemUpdateData {
@@ -97903,6 +99472,13 @@ declare namespace Word {
97903
99472
  }
97904
99473
  /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */
97905
99474
  interface StyleUpdateData {
99475
+ /**
99476
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
99477
+ *
99478
+ * @remarks
99479
+ * [Api set: WordApiDesktop 1.1]
99480
+ */
99481
+ borders?: Word.Interfaces.BorderCollectionUpdateData;
97906
99482
  /**
97907
99483
  * Gets a font object that represents the character formatting of the specified style.
97908
99484
  *
@@ -97910,6 +99486,13 @@ declare namespace Word {
97910
99486
  * [Api set: WordApi 1.5]
97911
99487
  */
97912
99488
  font?: Word.Interfaces.FontUpdateData;
99489
+ /**
99490
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
99491
+ *
99492
+ * @remarks
99493
+ * [Api set: WordApiDesktop 1.1]
99494
+ */
99495
+ listTemplate?: Word.Interfaces.ListTemplateUpdateData;
97913
99496
  /**
97914
99497
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
97915
99498
  *
@@ -97987,15 +99570,29 @@ declare namespace Word {
97987
99570
  * [Api set: WordApi 1.6]
97988
99571
  */
97989
99572
  backgroundPatternColor?: string;
99573
+ /**
99574
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
99575
+ *
99576
+ * @remarks
99577
+ * [Api set: WordApiDesktop 1.1]
99578
+ */
99579
+ foregroundPatternColor?: string;
99580
+ /**
99581
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
99582
+ *
99583
+ * @remarks
99584
+ * [Api set: WordApiDesktop 1.1]
99585
+ */
99586
+ texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
97990
99587
  }
97991
99588
  /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
97992
99589
  interface TableUpdateData {
97993
99590
  /**
97994
- * Gets the font. Use this to get and set font name, size, color, and other properties.
97995
- *
97996
- * @remarks
97997
- * [Api set: WordApi 1.3]
97998
- */
99591
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
99592
+ *
99593
+ * @remarks
99594
+ * [Api set: WordApi 1.3]
99595
+ */
97999
99596
  font?: Word.Interfaces.FontUpdateData;
98000
99597
  /**
98001
99598
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -98098,6 +99695,20 @@ declare namespace Word {
98098
99695
  }
98099
99696
  /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */
98100
99697
  interface TableStyleUpdateData {
99698
+ /**
99699
+ * Specifies the table's alignment against the page margin.
99700
+ *
99701
+ * @remarks
99702
+ * [Api set: WordApiDesktop 1.1]
99703
+ */
99704
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
99705
+ /**
99706
+ * Specifies whether lines in tables formatted with a specified style break across pages.
99707
+ *
99708
+ * @remarks
99709
+ * [Api set: WordApiDesktop 1.1]
99710
+ */
99711
+ allowBreakAcrossPage?: boolean;
98101
99712
  /**
98102
99713
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
98103
99714
  *
@@ -98298,55 +99909,55 @@ declare namespace Word {
98298
99909
  /** An interface describing the data returned by calling `body.toJSON()`. */
98299
99910
  interface BodyData {
98300
99911
  /**
98301
- * Gets the collection of rich text content control objects in the body.
98302
- *
98303
- * @remarks
98304
- * [Api set: WordApi 1.1]
98305
- */
99912
+ * Gets the collection of rich text content control objects in the body.
99913
+ *
99914
+ * @remarks
99915
+ * [Api set: WordApi 1.1]
99916
+ */
98306
99917
  contentControls?: Word.Interfaces.ContentControlData[];
98307
99918
  /**
98308
- * Gets the collection of field objects in the body.
98309
- *
98310
- * @remarks
98311
- * [Api set: WordApi 1.4]
98312
- */
99919
+ * Gets the collection of field objects in the body.
99920
+ *
99921
+ * @remarks
99922
+ * [Api set: WordApi 1.4]
99923
+ */
98313
99924
  fields?: Word.Interfaces.FieldData[];
98314
99925
  /**
98315
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
98316
- *
98317
- * @remarks
98318
- * [Api set: WordApi 1.1]
98319
- */
99926
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
99927
+ *
99928
+ * @remarks
99929
+ * [Api set: WordApi 1.1]
99930
+ */
98320
99931
  font?: Word.Interfaces.FontData;
98321
99932
  /**
98322
- * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
98323
- *
98324
- * @remarks
98325
- * [Api set: WordApi 1.1]
98326
- */
99933
+ * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
99934
+ *
99935
+ * @remarks
99936
+ * [Api set: WordApi 1.1]
99937
+ */
98327
99938
  inlinePictures?: Word.Interfaces.InlinePictureData[];
98328
99939
  /**
98329
- * Gets the collection of list objects in the body.
98330
- *
98331
- * @remarks
98332
- * [Api set: WordApi 1.3]
98333
- */
99940
+ * Gets the collection of list objects in the body.
99941
+ *
99942
+ * @remarks
99943
+ * [Api set: WordApi 1.3]
99944
+ */
98334
99945
  lists?: Word.Interfaces.ListData[];
98335
99946
  /**
98336
- * Gets the collection of paragraph objects in the body.
98337
- *
98338
- * @remarks
98339
- * [Api set: WordApi 1.1]
98340
- *
98341
- * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
98342
- */
99947
+ * Gets the collection of paragraph objects in the body.
99948
+ *
99949
+ * @remarks
99950
+ * [Api set: WordApi 1.1]
99951
+ *
99952
+ * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
99953
+ */
98343
99954
  paragraphs?: Word.Interfaces.ParagraphData[];
98344
99955
  /**
98345
- * Gets the collection of table objects in the body.
98346
- *
98347
- * @remarks
98348
- * [Api set: WordApi 1.3]
98349
- */
99956
+ * Gets the collection of table objects in the body.
99957
+ *
99958
+ * @remarks
99959
+ * [Api set: WordApi 1.3]
99960
+ */
98350
99961
  tables?: Word.Interfaces.TableData[];
98351
99962
  /**
98352
99963
  * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
@@ -98377,6 +99988,48 @@ declare namespace Word {
98377
99988
  */
98378
99989
  type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
98379
99990
  }
99991
+ /** An interface describing the data returned by calling `border.toJSON()`. */
99992
+ interface BorderData {
99993
+ /**
99994
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
99995
+ *
99996
+ * @remarks
99997
+ * [Api set: WordApiDesktop 1.1]
99998
+ */
99999
+ color?: string;
100000
+ /**
100001
+ * Gets the location of the border.
100002
+ *
100003
+ * @remarks
100004
+ * [Api set: WordApiDesktop 1.1]
100005
+ */
100006
+ location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
100007
+ /**
100008
+ * Specifies the border type for the border.
100009
+ *
100010
+ * @remarks
100011
+ * [Api set: WordApiDesktop 1.1]
100012
+ */
100013
+ type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
100014
+ /**
100015
+ * Specifies whether the border is visible.
100016
+ *
100017
+ * @remarks
100018
+ * [Api set: WordApiDesktop 1.1]
100019
+ */
100020
+ visible?: boolean;
100021
+ /**
100022
+ * Specifies the width for the border.
100023
+ *
100024
+ * @remarks
100025
+ * [Api set: WordApiDesktop 1.1]
100026
+ */
100027
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
100028
+ }
100029
+ /** An interface describing the data returned by calling `borderCollection.toJSON()`. */
100030
+ interface BorderCollectionData {
100031
+ items?: Word.Interfaces.BorderData[];
100032
+ }
98380
100033
  /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */
98381
100034
  interface CheckboxContentControlData {
98382
100035
  /**
@@ -99055,6 +100708,13 @@ declare namespace Word {
99055
100708
  * [Api set: WordApi 1.5]
99056
100709
  */
99057
100710
  locked?: boolean;
100711
+ /**
100712
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
100713
+ *
100714
+ * @remarks
100715
+ * [Api set: WordApiDesktop 1.1]
100716
+ */
100717
+ showCodes?: boolean;
99058
100718
  /**
99059
100719
  * Gets the field's type.
99060
100720
  *
@@ -99177,6 +100837,13 @@ declare namespace Word {
99177
100837
  * [Api set: WordApi 1.1]
99178
100838
  */
99179
100839
  hyperlink?: string;
100840
+ /**
100841
+ * Gets the format of the inline image.
100842
+ *
100843
+ * @remarks
100844
+ * [Api set: WordApiDesktop 1.1]
100845
+ */
100846
+ imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";
99180
100847
  /**
99181
100848
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
99182
100849
  *
@@ -99255,21 +100922,122 @@ declare namespace Word {
99255
100922
  */
99256
100923
  siblingIndex?: number;
99257
100924
  }
100925
+ /** An interface describing the data returned by calling `listLevel.toJSON()`. */
100926
+ interface ListLevelData {
100927
+ /**
100928
+ * Gets a Font object that represents the character formatting of the specified object.
100929
+ *
100930
+ * @remarks
100931
+ * [Api set: WordApiDesktop 1.1]
100932
+ */
100933
+ font?: Word.Interfaces.FontData;
100934
+ /**
100935
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
100936
+ *
100937
+ * @remarks
100938
+ * [Api set: WordApiDesktop 1.1]
100939
+ */
100940
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
100941
+ /**
100942
+ * Specifies the name of the style that's linked to the specified list level object.
100943
+ *
100944
+ * @remarks
100945
+ * [Api set: WordApiDesktop 1.1]
100946
+ */
100947
+ linkedStyle?: string;
100948
+ /**
100949
+ * Specifies the number format for the specified list level.
100950
+ *
100951
+ * @remarks
100952
+ * [Api set: WordApiDesktop 1.1]
100953
+ */
100954
+ numberFormat?: string;
100955
+ /**
100956
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
100957
+ *
100958
+ * @remarks
100959
+ * [Api set: WordApiDesktop 1.1]
100960
+ */
100961
+ numberPosition?: number;
100962
+ /**
100963
+ * Specifies the number style for the list level object.
100964
+ *
100965
+ * @remarks
100966
+ * [Api set: WordApiDesktop 1.1]
100967
+ */
100968
+ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
100969
+ /**
100970
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
100971
+ *
100972
+ * @remarks
100973
+ * [Api set: WordApiDesktop 1.1]
100974
+ */
100975
+ resetOnHigher?: number;
100976
+ /**
100977
+ * Specifies the starting number for the specified list level object.
100978
+ *
100979
+ * @remarks
100980
+ * [Api set: WordApiDesktop 1.1]
100981
+ */
100982
+ startAt?: number;
100983
+ /**
100984
+ * Specifies the tab position for the specified list level object.
100985
+ *
100986
+ * @remarks
100987
+ * [Api set: WordApiDesktop 1.1]
100988
+ */
100989
+ tabPosition?: number;
100990
+ /**
100991
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
100992
+ *
100993
+ * @remarks
100994
+ * [Api set: WordApiDesktop 1.1]
100995
+ */
100996
+ textPosition?: number;
100997
+ /**
100998
+ * Specifies the character inserted after the number for the specified list level.
100999
+ *
101000
+ * @remarks
101001
+ * [Api set: WordApiDesktop 1.1]
101002
+ */
101003
+ trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
101004
+ }
101005
+ /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */
101006
+ interface ListLevelCollectionData {
101007
+ items?: Word.Interfaces.ListLevelData[];
101008
+ }
101009
+ /** An interface describing the data returned by calling `listTemplate.toJSON()`. */
101010
+ interface ListTemplateData {
101011
+ /**
101012
+ * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
101013
+ *
101014
+ * @remarks
101015
+ * [Api set: WordApiDesktop 1.1]
101016
+ */
101017
+ listLevels?: Word.Interfaces.ListLevelData[];
101018
+ /**
101019
+ * Specifies whether the specified ListTemplate object is outline numbered.
101020
+ *
101021
+ * @remarks
101022
+ * [Api set: WordApiDesktop 1.1]
101023
+ */
101024
+ outlineNumbered?: boolean;
101025
+ }
99258
101026
  /** An interface describing the data returned by calling `noteItem.toJSON()`. */
99259
101027
  interface NoteItemData {
99260
101028
  /**
99261
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
99262
- *
99263
- * @remarks
99264
- * [Api set: WordApi 1.5]
99265
- */
101029
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
101030
+ *
101031
+ * @remarks
101032
+ * [Api set: WordApi 1.5]
101033
+ */
99266
101034
  body?: Word.Interfaces.BodyData;
99267
101035
  /**
99268
- * Represents a footnote or endnote reference in the main document.
99269
- *
99270
- * @remarks
99271
- * [Api set: WordApi 1.5]
99272
- */
101036
+ * Represents a footnote or endnote reference in the main document.
101037
+ *
101038
+ * @remarks
101039
+ * [Api set: WordApi 1.5]
101040
+ */
99273
101041
  reference?: Word.Interfaces.RangeData;
99274
101042
  /**
99275
101043
  * Represents the note item type: footnote or endnote.
@@ -99285,40 +101053,40 @@ declare namespace Word {
99285
101053
  }
99286
101054
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
99287
101055
  interface ParagraphData {
99288
- /**
99289
- * Gets the collection of fields in the paragraph.
99290
- *
99291
- * @remarks
99292
- * [Api set: WordApi 1.4]
99293
- */
101056
+ /**
101057
+ * Gets the collection of fields in the paragraph.
101058
+ *
101059
+ * @remarks
101060
+ * [Api set: WordApi 1.4]
101061
+ */
99294
101062
  fields?: Word.Interfaces.FieldData[];
99295
101063
  /**
99296
- * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
99297
- *
99298
- * @remarks
99299
- * [Api set: WordApi 1.1]
99300
- */
101064
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
101065
+ *
101066
+ * @remarks
101067
+ * [Api set: WordApi 1.1]
101068
+ */
99301
101069
  font?: Word.Interfaces.FontData;
99302
101070
  /**
99303
- * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
99304
- *
99305
- * @remarks
99306
- * [Api set: WordApi 1.1]
99307
- */
101071
+ * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
101072
+ *
101073
+ * @remarks
101074
+ * [Api set: WordApi 1.1]
101075
+ */
99308
101076
  inlinePictures?: Word.Interfaces.InlinePictureData[];
99309
101077
  /**
99310
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
99311
- *
99312
- * @remarks
99313
- * [Api set: WordApi 1.3]
99314
- */
101078
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
101079
+ *
101080
+ * @remarks
101081
+ * [Api set: WordApi 1.3]
101082
+ */
99315
101083
  listItem?: Word.Interfaces.ListItemData;
99316
101084
  /**
99317
- * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
99318
- *
99319
- * @remarks
99320
- * [Api set: WordApi 1.3]
99321
- */
101085
+ * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
101086
+ *
101087
+ * @remarks
101088
+ * [Api set: WordApi 1.3]
101089
+ */
99322
101090
  listItemOrNullObject?: Word.Interfaces.ListItemData;
99323
101091
  /**
99324
101092
  * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -99548,25 +101316,25 @@ declare namespace Word {
99548
101316
  /** An interface describing the data returned by calling `range.toJSON()`. */
99549
101317
  interface RangeData {
99550
101318
  /**
99551
- * Gets the collection of field objects in the range.
99552
- *
99553
- * @remarks
99554
- * [Api set: WordApi 1.4]
99555
- */
101319
+ * Gets the collection of field objects in the range.
101320
+ *
101321
+ * @remarks
101322
+ * [Api set: WordApi 1.4]
101323
+ */
99556
101324
  fields?: Word.Interfaces.FieldData[];
99557
101325
  /**
99558
- * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
99559
- *
99560
- * @remarks
99561
- * [Api set: WordApi 1.1]
99562
- */
101326
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
101327
+ *
101328
+ * @remarks
101329
+ * [Api set: WordApi 1.1]
101330
+ */
99563
101331
  font?: Word.Interfaces.FontData;
99564
101332
  /**
99565
- * Gets the collection of inline picture objects in the range.
99566
- *
99567
- * @remarks
99568
- * [Api set: WordApi 1.2]
99569
- */
101333
+ * Gets the collection of inline picture objects in the range.
101334
+ *
101335
+ * @remarks
101336
+ * [Api set: WordApi 1.2]
101337
+ */
99570
101338
  inlinePictures?: Word.Interfaces.InlinePictureData[];
99571
101339
  /**
99572
101340
  * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
@@ -99663,11 +101431,11 @@ declare namespace Word {
99663
101431
  /** An interface describing the data returned by calling `section.toJSON()`. */
99664
101432
  interface SectionData {
99665
101433
  /**
99666
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
99667
- *
99668
- * @remarks
99669
- * [Api set: WordApi 1.1]
99670
- */
101434
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
101435
+ *
101436
+ * @remarks
101437
+ * [Api set: WordApi 1.1]
101438
+ */
99671
101439
  body?: Word.Interfaces.BodyData;
99672
101440
  }
99673
101441
  /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */
@@ -99702,32 +101470,46 @@ declare namespace Word {
99702
101470
  /** An interface describing the data returned by calling `style.toJSON()`. */
99703
101471
  interface StyleData {
99704
101472
  /**
99705
- * Gets a font object that represents the character formatting of the specified style.
99706
- *
99707
- * @remarks
99708
- * [Api set: WordApi 1.5]
99709
- */
101473
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
101474
+ *
101475
+ * @remarks
101476
+ * [Api set: WordApiDesktop 1.1]
101477
+ */
101478
+ borders?: Word.Interfaces.BorderData[];
101479
+ /**
101480
+ * Gets a font object that represents the character formatting of the specified style.
101481
+ *
101482
+ * @remarks
101483
+ * [Api set: WordApi 1.5]
101484
+ */
99710
101485
  font?: Word.Interfaces.FontData;
99711
101486
  /**
99712
- * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
99713
- *
99714
- * @remarks
99715
- * [Api set: WordApi 1.5]
99716
- */
101487
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
101488
+ *
101489
+ * @remarks
101490
+ * [Api set: WordApiDesktop 1.1]
101491
+ */
101492
+ listTemplate?: Word.Interfaces.ListTemplateData;
101493
+ /**
101494
+ * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
101495
+ *
101496
+ * @remarks
101497
+ * [Api set: WordApi 1.5]
101498
+ */
99717
101499
  paragraphFormat?: Word.Interfaces.ParagraphFormatData;
99718
101500
  /**
99719
- * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
99720
- *
99721
- * @remarks
99722
- * [Api set: WordApi 1.6]
99723
- */
101501
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
101502
+ *
101503
+ * @remarks
101504
+ * [Api set: WordApi 1.6]
101505
+ */
99724
101506
  shading?: Word.Interfaces.ShadingData;
99725
101507
  /**
99726
- * Gets a TableStyle object representing Style properties that can be applied to a table.
99727
- *
99728
- * @remarks
99729
- * [Api set: WordApi 1.6]
99730
- */
101508
+ * Gets a TableStyle object representing Style properties that can be applied to a table.
101509
+ *
101510
+ * @remarks
101511
+ * [Api set: WordApi 1.6]
101512
+ */
99731
101513
  tableStyle?: Word.Interfaces.TableStyleData;
99732
101514
  /**
99733
101515
  * Specifies the name of an existing style to use as the base formatting of another style.
@@ -99820,36 +101602,50 @@ declare namespace Word {
99820
101602
  * [Api set: WordApi 1.6]
99821
101603
  */
99822
101604
  backgroundPatternColor?: string;
101605
+ /**
101606
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
101607
+ *
101608
+ * @remarks
101609
+ * [Api set: WordApiDesktop 1.1]
101610
+ */
101611
+ foregroundPatternColor?: string;
101612
+ /**
101613
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
101614
+ *
101615
+ * @remarks
101616
+ * [Api set: WordApiDesktop 1.1]
101617
+ */
101618
+ texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
99823
101619
  }
99824
101620
  /** An interface describing the data returned by calling `table.toJSON()`. */
99825
101621
  interface TableData {
99826
101622
  /**
99827
- * Gets the collection of field objects in the table.
99828
- *
99829
- * @remarks
99830
- * [Api set: WordApi 1.4]
99831
- */
101623
+ * Gets the collection of field objects in the table.
101624
+ *
101625
+ * @remarks
101626
+ * [Api set: WordApi 1.4]
101627
+ */
99832
101628
  fields?: Word.Interfaces.FieldData[];
99833
101629
  /**
99834
- * Gets the font. Use this to get and set font name, size, color, and other properties.
99835
- *
99836
- * @remarks
99837
- * [Api set: WordApi 1.3]
99838
- */
101630
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
101631
+ *
101632
+ * @remarks
101633
+ * [Api set: WordApi 1.3]
101634
+ */
99839
101635
  font?: Word.Interfaces.FontData;
99840
101636
  /**
99841
- * Gets all of the table rows.
99842
- *
99843
- * @remarks
99844
- * [Api set: WordApi 1.3]
99845
- */
101637
+ * Gets all of the table rows.
101638
+ *
101639
+ * @remarks
101640
+ * [Api set: WordApi 1.3]
101641
+ */
99846
101642
  rows?: Word.Interfaces.TableRowData[];
99847
101643
  /**
99848
- * Gets the child tables nested one level deeper.
99849
- *
99850
- * @remarks
99851
- * [Api set: WordApi 1.3]
99852
- */
101644
+ * Gets the child tables nested one level deeper.
101645
+ *
101646
+ * @remarks
101647
+ * [Api set: WordApi 1.3]
101648
+ */
99853
101649
  tables?: Word.Interfaces.TableData[];
99854
101650
  /**
99855
101651
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -99973,6 +101769,20 @@ declare namespace Word {
99973
101769
  }
99974
101770
  /** An interface describing the data returned by calling `tableStyle.toJSON()`. */
99975
101771
  interface TableStyleData {
101772
+ /**
101773
+ * Specifies the table's alignment against the page margin.
101774
+ *
101775
+ * @remarks
101776
+ * [Api set: WordApiDesktop 1.1]
101777
+ */
101778
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
101779
+ /**
101780
+ * Specifies whether lines in tables formatted with a specified style break across pages.
101781
+ *
101782
+ * @remarks
101783
+ * [Api set: WordApiDesktop 1.1]
101784
+ */
101785
+ allowBreakAcrossPage?: boolean;
99976
101786
  /**
99977
101787
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
99978
101788
  *
@@ -100100,11 +101910,11 @@ declare namespace Word {
100100
101910
  /** An interface describing the data returned by calling `tableCell.toJSON()`. */
100101
101911
  interface TableCellData {
100102
101912
  /**
100103
- * Gets the body object of the cell.
100104
- *
100105
- * @remarks
100106
- * [Api set: WordApi 1.3]
100107
- */
101913
+ * Gets the body object of the cell.
101914
+ *
101915
+ * @remarks
101916
+ * [Api set: WordApi 1.3]
101917
+ */
100108
101918
  body?: Word.Interfaces.BodyData;
100109
101919
  /**
100110
101920
  * Gets the index of the cell in its row.
@@ -100194,28 +102004,28 @@ declare namespace Word {
100194
102004
  /** An interface describing the data returned by calling `trackedChange.toJSON()`. */
100195
102005
  interface TrackedChangeData {
100196
102006
  /**
100197
- * Specifies the author of the tracked change.
102007
+ * Gets the author of the tracked change.
100198
102008
  *
100199
102009
  * @remarks
100200
102010
  * [Api set: WordApi 1.6]
100201
102011
  */
100202
102012
  author?: string;
100203
102013
  /**
100204
- * Specifies the date of the tracked change.
102014
+ * Gets the date of the tracked change.
100205
102015
  *
100206
102016
  * @remarks
100207
102017
  * [Api set: WordApi 1.6]
100208
102018
  */
100209
102019
  date?: Date;
100210
102020
  /**
100211
- * Specifies the text of the tracked change.
102021
+ * Gets the text of the tracked change.
100212
102022
  *
100213
102023
  * @remarks
100214
102024
  * [Api set: WordApi 1.6]
100215
102025
  */
100216
102026
  text?: string;
100217
102027
  /**
100218
- * Specifies the type of the tracked change.
102028
+ * Gets the type of the tracked change.
100219
102029
  *
100220
102030
  * @remarks
100221
102031
  * [Api set: WordApi 1.6]
@@ -100238,11 +102048,11 @@ declare namespace Word {
100238
102048
  */
100239
102049
  $all?: boolean;
100240
102050
  /**
100241
- * Gets the range of text that is annotated.
100242
- *
100243
- * @remarks
100244
- * [Api set: WordApi 1.7]
100245
- */
102051
+ * Gets the range of text that is annotated.
102052
+ *
102053
+ * @remarks
102054
+ * [Api set: WordApi 1.7]
102055
+ */
100246
102056
  range?: Word.Interfaces.RangeLoadOptions;
100247
102057
  /**
100248
102058
  * Gets the critique that was passed when the annotation was inserted.
@@ -100370,42 +102180,136 @@ declare namespace Word {
100370
102180
  * @remarks
100371
102181
  * [Api set: WordApi 1.3]
100372
102182
  */
100373
- parentSection?: Word.Interfaces.SectionLoadOptions;
102183
+ parentSection?: Word.Interfaces.SectionLoadOptions;
102184
+ /**
102185
+ * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
102186
+ *
102187
+ * @remarks
102188
+ * [Api set: WordApi 1.3]
102189
+ */
102190
+ parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;
102191
+ /**
102192
+ * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
102193
+ *
102194
+ * @remarks
102195
+ * [Api set: WordApi 1.1]
102196
+ */
102197
+ style?: boolean;
102198
+ /**
102199
+ * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
102200
+ *
102201
+ * @remarks
102202
+ * [Api set: WordApi 1.3]
102203
+ */
102204
+ styleBuiltIn?: boolean;
102205
+ /**
102206
+ * Gets the text of the body. Use the insertText method to insert text.
102207
+ *
102208
+ * @remarks
102209
+ * [Api set: WordApi 1.1]
102210
+ */
102211
+ text?: boolean;
102212
+ /**
102213
+ * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later.
102214
+ *
102215
+ * @remarks
102216
+ * [Api set: WordApi 1.3]
102217
+ */
102218
+ type?: boolean;
102219
+ }
102220
+ /**
102221
+ * Represents the Border object for text, a paragraph, or a table.
102222
+ *
102223
+ * @remarks
102224
+ * [Api set: WordApiDesktop 1.1]
102225
+ */
102226
+ interface BorderLoadOptions {
102227
+ /**
102228
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
102229
+ */
102230
+ $all?: boolean;
102231
+ /**
102232
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
102233
+ *
102234
+ * @remarks
102235
+ * [Api set: WordApiDesktop 1.1]
102236
+ */
102237
+ color?: boolean;
102238
+ /**
102239
+ * Gets the location of the border.
102240
+ *
102241
+ * @remarks
102242
+ * [Api set: WordApiDesktop 1.1]
102243
+ */
102244
+ location?: boolean;
102245
+ /**
102246
+ * Specifies the border type for the border.
102247
+ *
102248
+ * @remarks
102249
+ * [Api set: WordApiDesktop 1.1]
102250
+ */
102251
+ type?: boolean;
102252
+ /**
102253
+ * Specifies whether the border is visible.
102254
+ *
102255
+ * @remarks
102256
+ * [Api set: WordApiDesktop 1.1]
102257
+ */
102258
+ visible?: boolean;
102259
+ /**
102260
+ * Specifies the width for the border.
102261
+ *
102262
+ * @remarks
102263
+ * [Api set: WordApiDesktop 1.1]
102264
+ */
102265
+ width?: boolean;
102266
+ }
102267
+ /**
102268
+ * Represents the collection of border styles.
102269
+ *
102270
+ * @remarks
102271
+ * [Api set: WordApiDesktop 1.1]
102272
+ */
102273
+ interface BorderCollectionLoadOptions {
102274
+ /**
102275
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
102276
+ */
102277
+ $all?: boolean;
100374
102278
  /**
100375
- * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
102279
+ * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
100376
102280
  *
100377
102281
  * @remarks
100378
- * [Api set: WordApi 1.3]
102282
+ * [Api set: WordApiDesktop 1.1]
100379
102283
  */
100380
- parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;
102284
+ color?: boolean;
100381
102285
  /**
100382
- * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
102286
+ * For EACH ITEM in the collection: Gets the location of the border.
100383
102287
  *
100384
102288
  * @remarks
100385
- * [Api set: WordApi 1.1]
102289
+ * [Api set: WordApiDesktop 1.1]
100386
102290
  */
100387
- style?: boolean;
102291
+ location?: boolean;
100388
102292
  /**
100389
- * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
102293
+ * For EACH ITEM in the collection: Specifies the border type for the border.
100390
102294
  *
100391
102295
  * @remarks
100392
- * [Api set: WordApi 1.3]
102296
+ * [Api set: WordApiDesktop 1.1]
100393
102297
  */
100394
- styleBuiltIn?: boolean;
102298
+ type?: boolean;
100395
102299
  /**
100396
- * Gets the text of the body. Use the insertText method to insert text.
102300
+ * For EACH ITEM in the collection: Specifies whether the border is visible.
100397
102301
  *
100398
102302
  * @remarks
100399
- * [Api set: WordApi 1.1]
102303
+ * [Api set: WordApiDesktop 1.1]
100400
102304
  */
100401
- text?: boolean;
102305
+ visible?: boolean;
100402
102306
  /**
100403
- * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later.
102307
+ * For EACH ITEM in the collection: Specifies the width for the border.
100404
102308
  *
100405
102309
  * @remarks
100406
- * [Api set: WordApi 1.3]
102310
+ * [Api set: WordApiDesktop 1.1]
100407
102311
  */
100408
- type?: boolean;
102312
+ width?: boolean;
100409
102313
  }
100410
102314
  /**
100411
102315
  * The data specific to content controls of type CheckBox.
@@ -100619,18 +102523,18 @@ declare namespace Word {
100619
102523
  */
100620
102524
  $all?: boolean;
100621
102525
  /**
100622
- * Specifies the commentReply's content range.
100623
- *
100624
- * @remarks
100625
- * [Api set: WordApi 1.4]
100626
- */
102526
+ * Specifies the commentReply's content range.
102527
+ *
102528
+ * @remarks
102529
+ * [Api set: WordApi 1.4]
102530
+ */
100627
102531
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
100628
102532
  /**
100629
- * Gets the parent comment of this reply.
100630
- *
100631
- * @remarks
100632
- * [Api set: WordApi 1.4]
100633
- */
102533
+ * Gets the parent comment of this reply.
102534
+ *
102535
+ * @remarks
102536
+ * [Api set: WordApi 1.4]
102537
+ */
100634
102538
  parentComment?: Word.Interfaces.CommentLoadOptions;
100635
102539
  /**
100636
102540
  * Gets the email of the comment reply's author.
@@ -100680,18 +102584,18 @@ declare namespace Word {
100680
102584
  */
100681
102585
  $all?: boolean;
100682
102586
  /**
100683
- * For EACH ITEM in the collection: Specifies the commentReply's content range.
100684
- *
100685
- * @remarks
100686
- * [Api set: WordApi 1.4]
100687
- */
102587
+ * For EACH ITEM in the collection: Specifies the commentReply's content range.
102588
+ *
102589
+ * @remarks
102590
+ * [Api set: WordApi 1.4]
102591
+ */
100688
102592
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
100689
102593
  /**
100690
- * For EACH ITEM in the collection: Gets the parent comment of this reply.
100691
- *
100692
- * @remarks
100693
- * [Api set: WordApi 1.4]
100694
- */
102594
+ * For EACH ITEM in the collection: Gets the parent comment of this reply.
102595
+ *
102596
+ * @remarks
102597
+ * [Api set: WordApi 1.4]
102598
+ */
100695
102599
  parentComment?: Word.Interfaces.CommentLoadOptions;
100696
102600
  /**
100697
102601
  * For EACH ITEM in the collection: Gets the email of the comment reply's author.
@@ -101530,6 +103434,13 @@ declare namespace Word {
101530
103434
  * [Api set: WordApi 1.5]
101531
103435
  */
101532
103436
  locked?: boolean;
103437
+ /**
103438
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
103439
+ *
103440
+ * @remarks
103441
+ * [Api set: WordApiDesktop 1.1]
103442
+ */
103443
+ showCodes?: boolean;
101533
103444
  /**
101534
103445
  * Gets the field's type.
101535
103446
  *
@@ -101641,6 +103552,13 @@ declare namespace Word {
101641
103552
  * [Api set: WordApi 1.5]
101642
103553
  */
101643
103554
  locked?: boolean;
103555
+ /**
103556
+ * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
103557
+ *
103558
+ * @remarks
103559
+ * [Api set: WordApiDesktop 1.1]
103560
+ */
103561
+ showCodes?: boolean;
101644
103562
  /**
101645
103563
  * For EACH ITEM in the collection: Gets the field's type.
101646
103564
  *
@@ -101826,6 +103744,13 @@ declare namespace Word {
101826
103744
  * [Api set: WordApi 1.1]
101827
103745
  */
101828
103746
  hyperlink?: boolean;
103747
+ /**
103748
+ * Gets the format of the inline image.
103749
+ *
103750
+ * @remarks
103751
+ * [Api set: WordApiDesktop 1.1]
103752
+ */
103753
+ imageFormat?: boolean;
101829
103754
  /**
101830
103755
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
101831
103756
  *
@@ -101929,6 +103854,13 @@ declare namespace Word {
101929
103854
  * [Api set: WordApi 1.1]
101930
103855
  */
101931
103856
  hyperlink?: boolean;
103857
+ /**
103858
+ * For EACH ITEM in the collection: Gets the format of the inline image.
103859
+ *
103860
+ * @remarks
103861
+ * [Api set: WordApiDesktop 1.1]
103862
+ */
103863
+ imageFormat?: boolean;
101932
103864
  /**
101933
103865
  * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
101934
103866
  *
@@ -102043,6 +103975,203 @@ declare namespace Word {
102043
103975
  */
102044
103976
  siblingIndex?: boolean;
102045
103977
  }
103978
+ /**
103979
+ * Represents a list level.
103980
+ *
103981
+ * @remarks
103982
+ * [Api set: WordApiDesktop 1.1]
103983
+ */
103984
+ interface ListLevelLoadOptions {
103985
+ /**
103986
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103987
+ */
103988
+ $all?: boolean;
103989
+ /**
103990
+ * Gets a Font object that represents the character formatting of the specified object.
103991
+ *
103992
+ * @remarks
103993
+ * [Api set: WordApiDesktop 1.1]
103994
+ */
103995
+ font?: Word.Interfaces.FontLoadOptions;
103996
+ /**
103997
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
103998
+ *
103999
+ * @remarks
104000
+ * [Api set: WordApiDesktop 1.1]
104001
+ */
104002
+ alignment?: boolean;
104003
+ /**
104004
+ * Specifies the name of the style that's linked to the specified list level object.
104005
+ *
104006
+ * @remarks
104007
+ * [Api set: WordApiDesktop 1.1]
104008
+ */
104009
+ linkedStyle?: boolean;
104010
+ /**
104011
+ * Specifies the number format for the specified list level.
104012
+ *
104013
+ * @remarks
104014
+ * [Api set: WordApiDesktop 1.1]
104015
+ */
104016
+ numberFormat?: boolean;
104017
+ /**
104018
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
104019
+ *
104020
+ * @remarks
104021
+ * [Api set: WordApiDesktop 1.1]
104022
+ */
104023
+ numberPosition?: boolean;
104024
+ /**
104025
+ * Specifies the number style for the list level object.
104026
+ *
104027
+ * @remarks
104028
+ * [Api set: WordApiDesktop 1.1]
104029
+ */
104030
+ numberStyle?: boolean;
104031
+ /**
104032
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
104033
+ *
104034
+ * @remarks
104035
+ * [Api set: WordApiDesktop 1.1]
104036
+ */
104037
+ resetOnHigher?: boolean;
104038
+ /**
104039
+ * Specifies the starting number for the specified list level object.
104040
+ *
104041
+ * @remarks
104042
+ * [Api set: WordApiDesktop 1.1]
104043
+ */
104044
+ startAt?: boolean;
104045
+ /**
104046
+ * Specifies the tab position for the specified list level object.
104047
+ *
104048
+ * @remarks
104049
+ * [Api set: WordApiDesktop 1.1]
104050
+ */
104051
+ tabPosition?: boolean;
104052
+ /**
104053
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
104054
+ *
104055
+ * @remarks
104056
+ * [Api set: WordApiDesktop 1.1]
104057
+ */
104058
+ textPosition?: boolean;
104059
+ /**
104060
+ * Specifies the character inserted after the number for the specified list level.
104061
+ *
104062
+ * @remarks
104063
+ * [Api set: WordApiDesktop 1.1]
104064
+ */
104065
+ trailingCharacter?: boolean;
104066
+ }
104067
+ /**
104068
+ * Contains a collection of {@link Word.ListLevel} objects.
104069
+ *
104070
+ * @remarks
104071
+ * [Api set: WordApiDesktop 1.1]
104072
+ */
104073
+ interface ListLevelCollectionLoadOptions {
104074
+ /**
104075
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
104076
+ */
104077
+ $all?: boolean;
104078
+ /**
104079
+ * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.
104080
+ *
104081
+ * @remarks
104082
+ * [Api set: WordApiDesktop 1.1]
104083
+ */
104084
+ font?: Word.Interfaces.FontLoadOptions;
104085
+ /**
104086
+ * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
104087
+ *
104088
+ * @remarks
104089
+ * [Api set: WordApiDesktop 1.1]
104090
+ */
104091
+ alignment?: boolean;
104092
+ /**
104093
+ * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object.
104094
+ *
104095
+ * @remarks
104096
+ * [Api set: WordApiDesktop 1.1]
104097
+ */
104098
+ linkedStyle?: boolean;
104099
+ /**
104100
+ * For EACH ITEM in the collection: Specifies the number format for the specified list level.
104101
+ *
104102
+ * @remarks
104103
+ * [Api set: WordApiDesktop 1.1]
104104
+ */
104105
+ numberFormat?: boolean;
104106
+ /**
104107
+ * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object.
104108
+ *
104109
+ * @remarks
104110
+ * [Api set: WordApiDesktop 1.1]
104111
+ */
104112
+ numberPosition?: boolean;
104113
+ /**
104114
+ * For EACH ITEM in the collection: Specifies the number style for the list level object.
104115
+ *
104116
+ * @remarks
104117
+ * [Api set: WordApiDesktop 1.1]
104118
+ */
104119
+ numberStyle?: boolean;
104120
+ /**
104121
+ * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1.
104122
+ *
104123
+ * @remarks
104124
+ * [Api set: WordApiDesktop 1.1]
104125
+ */
104126
+ resetOnHigher?: boolean;
104127
+ /**
104128
+ * For EACH ITEM in the collection: Specifies the starting number for the specified list level object.
104129
+ *
104130
+ * @remarks
104131
+ * [Api set: WordApiDesktop 1.1]
104132
+ */
104133
+ startAt?: boolean;
104134
+ /**
104135
+ * For EACH ITEM in the collection: Specifies the tab position for the specified list level object.
104136
+ *
104137
+ * @remarks
104138
+ * [Api set: WordApiDesktop 1.1]
104139
+ */
104140
+ tabPosition?: boolean;
104141
+ /**
104142
+ * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object.
104143
+ *
104144
+ * @remarks
104145
+ * [Api set: WordApiDesktop 1.1]
104146
+ */
104147
+ textPosition?: boolean;
104148
+ /**
104149
+ * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level.
104150
+ *
104151
+ * @remarks
104152
+ * [Api set: WordApiDesktop 1.1]
104153
+ */
104154
+ trailingCharacter?: boolean;
104155
+ }
104156
+ /**
104157
+ * Represents a ListTemplate.
104158
+ *
104159
+ * @remarks
104160
+ * [Api set: WordApiDesktop 1.1]
104161
+ */
104162
+ interface ListTemplateLoadOptions {
104163
+ /**
104164
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
104165
+ */
104166
+ $all?: boolean;
104167
+ /**
104168
+ * Specifies whether the specified ListTemplate object is outline numbered.
104169
+ *
104170
+ * @remarks
104171
+ * [Api set: WordApiDesktop 1.1]
104172
+ */
104173
+ outlineNumbered?: boolean;
104174
+ }
102046
104175
  /**
102047
104176
  * Represents a footnote or endnote.
102048
104177
  *
@@ -102088,18 +104217,18 @@ declare namespace Word {
102088
104217
  */
102089
104218
  $all?: boolean;
102090
104219
  /**
102091
- * 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.
102092
- *
102093
- * @remarks
102094
- * [Api set: WordApi 1.5]
102095
- */
104220
+ * 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.
104221
+ *
104222
+ * @remarks
104223
+ * [Api set: WordApi 1.5]
104224
+ */
102096
104225
  body?: Word.Interfaces.BodyLoadOptions;
102097
104226
  /**
102098
- * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
102099
- *
102100
- * @remarks
102101
- * [Api set: WordApi 1.5]
102102
- */
104227
+ * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
104228
+ *
104229
+ * @remarks
104230
+ * [Api set: WordApi 1.5]
104231
+ */
102103
104232
  reference?: Word.Interfaces.RangeLoadOptions;
102104
104233
  /**
102105
104234
  * For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
@@ -102929,11 +105058,11 @@ declare namespace Word {
102929
105058
  */
102930
105059
  $all?: boolean;
102931
105060
  /**
102932
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
102933
- *
102934
- * @remarks
102935
- * [Api set: WordApi 1.1]
102936
- */
105061
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
105062
+ *
105063
+ * @remarks
105064
+ * [Api set: WordApi 1.1]
105065
+ */
102937
105066
  body?: Word.Interfaces.BodyLoadOptions;
102938
105067
  }
102939
105068
  /**
@@ -103018,6 +105147,13 @@ declare namespace Word {
103018
105147
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103019
105148
  */
103020
105149
  $all?: boolean;
105150
+ /**
105151
+ * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
105152
+ *
105153
+ * @remarks
105154
+ * [Api set: WordApiDesktop 1.1]
105155
+ */
105156
+ borders?: Word.Interfaces.BorderCollectionLoadOptions;
103021
105157
  /**
103022
105158
  * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
103023
105159
  *
@@ -103025,6 +105161,13 @@ declare namespace Word {
103025
105161
  * [Api set: WordApi 1.5]
103026
105162
  */
103027
105163
  font?: Word.Interfaces.FontLoadOptions;
105164
+ /**
105165
+ * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
105166
+ *
105167
+ * @remarks
105168
+ * [Api set: WordApiDesktop 1.1]
105169
+ */
105170
+ listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
103028
105171
  /**
103029
105172
  * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
103030
105173
  *
@@ -103139,6 +105282,13 @@ declare namespace Word {
103139
105282
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103140
105283
  */
103141
105284
  $all?: boolean;
105285
+ /**
105286
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
105287
+ *
105288
+ * @remarks
105289
+ * [Api set: WordApiDesktop 1.1]
105290
+ */
105291
+ borders?: Word.Interfaces.BorderCollectionLoadOptions;
103142
105292
  /**
103143
105293
  * Gets a font object that represents the character formatting of the specified style.
103144
105294
  *
@@ -103146,6 +105296,13 @@ declare namespace Word {
103146
105296
  * [Api set: WordApi 1.5]
103147
105297
  */
103148
105298
  font?: Word.Interfaces.FontLoadOptions;
105299
+ /**
105300
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
105301
+ *
105302
+ * @remarks
105303
+ * [Api set: WordApiDesktop 1.1]
105304
+ */
105305
+ listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
103149
105306
  /**
103150
105307
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
103151
105308
  *
@@ -103267,6 +105424,20 @@ declare namespace Word {
103267
105424
  * [Api set: WordApi 1.6]
103268
105425
  */
103269
105426
  backgroundPatternColor?: boolean;
105427
+ /**
105428
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
105429
+ *
105430
+ * @remarks
105431
+ * [Api set: WordApiDesktop 1.1]
105432
+ */
105433
+ foregroundPatternColor?: boolean;
105434
+ /**
105435
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
105436
+ *
105437
+ * @remarks
105438
+ * [Api set: WordApiDesktop 1.1]
105439
+ */
105440
+ texture?: boolean;
103270
105441
  }
103271
105442
  /**
103272
105443
  * Represents a table in a Word document.
@@ -103466,6 +105637,20 @@ declare namespace Word {
103466
105637
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103467
105638
  */
103468
105639
  $all?: boolean;
105640
+ /**
105641
+ * Specifies the table's alignment against the page margin.
105642
+ *
105643
+ * @remarks
105644
+ * [Api set: WordApiDesktop 1.1]
105645
+ */
105646
+ alignment?: boolean;
105647
+ /**
105648
+ * Specifies whether lines in tables formatted with a specified style break across pages.
105649
+ *
105650
+ * @remarks
105651
+ * [Api set: WordApiDesktop 1.1]
105652
+ */
105653
+ allowBreakAcrossPage?: boolean;
103469
105654
  /**
103470
105655
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
103471
105656
  *
@@ -104076,28 +106261,28 @@ declare namespace Word {
104076
106261
  */
104077
106262
  $all?: boolean;
104078
106263
  /**
104079
- * Specifies the author of the tracked change.
106264
+ * Gets the author of the tracked change.
104080
106265
  *
104081
106266
  * @remarks
104082
106267
  * [Api set: WordApi 1.6]
104083
106268
  */
104084
106269
  author?: boolean;
104085
106270
  /**
104086
- * Specifies the date of the tracked change.
106271
+ * Gets the date of the tracked change.
104087
106272
  *
104088
106273
  * @remarks
104089
106274
  * [Api set: WordApi 1.6]
104090
106275
  */
104091
106276
  date?: boolean;
104092
106277
  /**
104093
- * Specifies the text of the tracked change.
106278
+ * Gets the text of the tracked change.
104094
106279
  *
104095
106280
  * @remarks
104096
106281
  * [Api set: WordApi 1.6]
104097
106282
  */
104098
106283
  text?: boolean;
104099
106284
  /**
104100
- * Specifies the type of the tracked change.
106285
+ * Gets the type of the tracked change.
104101
106286
  *
104102
106287
  * @remarks
104103
106288
  * [Api set: WordApi 1.6]
@@ -104116,28 +106301,28 @@ declare namespace Word {
104116
106301
  */
104117
106302
  $all?: boolean;
104118
106303
  /**
104119
- * For EACH ITEM in the collection: Specifies the author of the tracked change.
106304
+ * For EACH ITEM in the collection: Gets the author of the tracked change.
104120
106305
  *
104121
106306
  * @remarks
104122
106307
  * [Api set: WordApi 1.6]
104123
106308
  */
104124
106309
  author?: boolean;
104125
106310
  /**
104126
- * For EACH ITEM in the collection: Specifies the date of the tracked change.
106311
+ * For EACH ITEM in the collection: Gets the date of the tracked change.
104127
106312
  *
104128
106313
  * @remarks
104129
106314
  * [Api set: WordApi 1.6]
104130
106315
  */
104131
106316
  date?: boolean;
104132
106317
  /**
104133
- * For EACH ITEM in the collection: Specifies the text of the tracked change.
106318
+ * For EACH ITEM in the collection: Gets the text of the tracked change.
104134
106319
  *
104135
106320
  * @remarks
104136
106321
  * [Api set: WordApi 1.6]
104137
106322
  */
104138
106323
  text?: boolean;
104139
106324
  /**
104140
- * For EACH ITEM in the collection: Specifies the type of the tracked change.
106325
+ * For EACH ITEM in the collection: Gets the type of the tracked change.
104141
106326
  *
104142
106327
  * @remarks
104143
106328
  * [Api set: WordApi 1.6]