@types/office-js-preview 1.0.381 → 1.0.383

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.
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 17 Apr 2023 19:02:43 GMT
11
+ * Last updated: Thu, 20 Apr 2023 21:32:46 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -10251,15 +10251,12 @@ declare namespace Office {
10251
10251
  */
10252
10252
  addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
10253
10253
  /**
10254
- * Closes the current item that is being composed
10254
+ * Closes the current item that is being composed.
10255
10255
  *
10256
- * The behaviors of the `close` method depends on the current state of the item being composed.
10256
+ * The behavior of the `close` method depends on the current state of the item being composed.
10257
10257
  * If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
10258
10258
  *
10259
- * In the Outlook desktop client, if the message is an inline reply, the `close` method has no effect.
10260
- *
10261
- * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
10262
- * discard, or cancel even if no changes have occurred since the item was last saved.
10259
+ * In the Outlook desktop client, the `close` method has no effect on a reply in the Reading Pane.
10263
10260
  *
10264
10261
  * @remarks
10265
10262
  * [Api set: Mailbox 1.3]
@@ -10267,6 +10264,9 @@ declare namespace Office {
10267
10264
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
10268
10265
  *
10269
10266
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
10267
+ *
10268
+ * **Important**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
10269
+ * discard, or cancel even if no changes have occurred since the item was last saved.
10270
10270
  */
10271
10271
  close(): void;
10272
10272
  /**
@@ -15569,15 +15569,12 @@ declare namespace Office {
15569
15569
  */
15570
15570
  addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
15571
15571
  /**
15572
- * Closes the current item that is being composed
15572
+ * Closes the current item that is being composed.
15573
15573
  *
15574
- * The behaviors of the close method depends on the current state of the item being composed.
15574
+ * The behavior of the `close` method depends on the current state of the item being composed.
15575
15575
  * If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
15576
15576
  *
15577
- * In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
15578
- *
15579
- * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
15580
- * discard, or cancel even if no changes have occurred since the item was last saved.
15577
+ * In the Outlook desktop client, the `close` method has no effect on a reply in the Reading Pane.
15581
15578
  *
15582
15579
  * @remarks
15583
15580
  * [Api set: Mailbox 1.3]
@@ -15585,8 +15582,83 @@ declare namespace Office {
15585
15582
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
15586
15583
  *
15587
15584
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15585
+ *
15586
+ * **Important**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
15587
+ * discard, or cancel even if no changes have occurred since the item was last saved.
15588
+ *
15589
+ * **Tip**: Use the
15590
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.messagecompose?view=outlook-js-preview&preserve-view=true#outlook-office-messagecompose-closeasync-member(1) | closeAsync}
15591
+ * method instead of the `close` method if you want your add-in to:
15592
+ *
15593
+ * - Automatically discard a message being composed without prompting the user with the save dialog.
15594
+ *
15595
+ * - Determine when a user cancels the save item dialog on a message being composed.
15596
+ *
15597
+ * - Close a reply in the Reading Pane or an existing draft from an Outlook desktop client.
15598
+ *
15588
15599
  */
15589
15600
  close(): void;
15601
+ /**
15602
+ * Closes the current message being composed with the option to discard unsaved changes.
15603
+ * The message being composed can be a new message, reply, or an existing draft.
15604
+ *
15605
+ * @remarks
15606
+ * [Api set: Mailbox preview]
15607
+ *
15608
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
15609
+ *
15610
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15611
+ *
15612
+ * **Important**: The `closeAsync` method is in preview. It's only supported in Outlook on Windows at this time.
15613
+ *
15614
+ * **Errors**:
15615
+ *
15616
+ * - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog and the `discardItem` property isn't defined or is set to `false`.
15617
+ *
15618
+ * - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft and the `discardItem` property isn't defined or
15619
+ * is set to `false`.
15620
+ *
15621
+ * @param options - An object literal that contains one or more of the following properties:-
15622
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
15623
+ * `discardItem`: If `true`, the current message being composed is closed and unsaved changes are discarded. When the parameter isn't declared or is
15624
+ * set to `false`, a save dialog appears prompting the user to save a draft, discard changes, or cancel the operation. This behavior occurs for new messages and replies
15625
+ * popped out from the Reading Pane. If you want to close a reply in the Reading Pane or an existing draft, you must set `discardItem` to `true`. Otherwise, the call will
15626
+ * return an error. For more information on the error, see the Remarks section.
15627
+ *
15628
+ * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
15629
+ * `asyncResult`, which is an `Office.AsyncResult` object.
15630
+ *
15631
+ * @beta
15632
+ */
15633
+ closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
15634
+ /**
15635
+ * Closes the current new message being composed.
15636
+ *
15637
+ * The behavior on a new message being composed depends on whether the message contains any unsaved changes. If no changes have been made, the message is
15638
+ * closed without a save dialog. On the other hand, if the message contains unsaved changes, a save dialog appears prompting the user to save a draft,
15639
+ * discard changes, or cancel the operation.
15640
+ *
15641
+ * @remarks
15642
+ * [Api set: Mailbox preview]
15643
+ *
15644
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
15645
+ *
15646
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15647
+ *
15648
+ * **Important**: The `closeAsync` method is in preview. It's only supported in Outlook on Windows at this time.
15649
+ *
15650
+ * **Errors**:
15651
+ *
15652
+ * - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
15653
+ *
15654
+ * - `The operation is not supported`: The `closeAsync` method attempts to close a reply in the Reading Pane or an existing draft.
15655
+ *
15656
+ * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
15657
+ * `asyncResult`, which is an `Office.AsyncResult` object.
15658
+ *
15659
+ * @beta
15660
+ */
15661
+ closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
15590
15662
  /**
15591
15663
  * Disables the Outlook client signature.
15592
15664
  *
@@ -87748,16 +87820,16 @@ declare namespace Word {
87748
87820
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
87749
87821
  context: RequestContext;
87750
87822
  /**
87751
- * Creates a new document by using an optional base64 encoded .docx file.
87823
+ * Creates a new document by using an optional Base64-encoded .docx file.
87752
87824
  *
87753
87825
  * @remarks
87754
87826
  * [Api set: WordApi 1.3]
87755
87827
  *
87756
- * @param base64File Optional. The base64 encoded .docx file. The default value is null.
87828
+ * @param base64File Optional. The Base64-encoded .docx file. The default value is null.
87757
87829
  */
87758
87830
  createDocument(base64File?: string): Word.DocumentCreated;
87759
87831
  /**
87760
- * Parse styles from template base 64 file and return JSON format of retrieved styles as a string.
87832
+ * Parse styles from template Base64 file and return JSON format of retrieved styles as a string.
87761
87833
  *
87762
87834
  * @remarks
87763
87835
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -87944,7 +88016,8 @@ declare namespace Word {
87944
88016
  getComments(): Word.CommentCollection;
87945
88017
  /**
87946
88018
  * Gets the currently supported content controls in the body. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
87947
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
88019
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
88020
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
87948
88021
  *
87949
88022
  * @remarks
87950
88023
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -88019,7 +88092,7 @@ declare namespace Word {
88019
88092
  * @remarks
88020
88093
  * [Api set: WordApi 1.1]
88021
88094
  *
88022
- * @param base64File Required. The base64 encoded content of a .docx file.
88095
+ * @param base64File Required. The Base64-encoded content of a .docx file.
88023
88096
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
88024
88097
  */
88025
88098
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
@@ -88039,7 +88112,7 @@ declare namespace Word {
88039
88112
  * @remarks
88040
88113
  * [Api set: WordApi 1.2]
88041
88114
  *
88042
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
88115
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the body.
88043
88116
  * @param insertLocation Required. The value must be 'Start' or 'End'.
88044
88117
  */
88045
88118
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
@@ -88920,7 +88993,8 @@ declare namespace Word {
88920
88993
  getComments(): Word.CommentCollection;
88921
88994
  /**
88922
88995
  * Gets the currently supported child content controls in this content control. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
88923
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
88996
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
88997
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
88924
88998
  *
88925
88999
  * @remarks
88926
89000
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -88996,7 +89070,7 @@ declare namespace Word {
88996
89070
  * @remarks
88997
89071
  * [Api set: WordApi 1.1]
88998
89072
  *
88999
- * @param base64File Required. The base64 encoded content of a .docx file.
89073
+ * @param base64File Required. The Base64-encoded content of a .docx file.
89000
89074
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
89001
89075
  */
89002
89076
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
@@ -89016,7 +89090,7 @@ declare namespace Word {
89016
89090
  * @remarks
89017
89091
  * [Api set: WordApi 1.2]
89018
89092
  *
89019
- * @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
89093
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the content control.
89020
89094
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
89021
89095
  */
89022
89096
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
@@ -89180,7 +89254,7 @@ declare namespace Word {
89180
89254
  * @eventproperty
89181
89255
  * @beta
89182
89256
  */
89183
- readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
89257
+ readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlDataChangedEventArgs>;
89184
89258
  /**
89185
89259
  * Occurs when the content control is deleted. Do not load this content control in the handler, otherwise you won't be able to get its original properties.
89186
89260
  *
@@ -89190,7 +89264,7 @@ declare namespace Word {
89190
89264
  * @eventproperty
89191
89265
  * @beta
89192
89266
  */
89193
- readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
89267
+ readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlDeletedEventArgs>;
89194
89268
  /**
89195
89269
  * Occurs when the content control is entered.
89196
89270
  *
@@ -89200,7 +89274,7 @@ declare namespace Word {
89200
89274
  * @eventproperty
89201
89275
  * @beta
89202
89276
  */
89203
- readonly onEntered: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
89277
+ readonly onEntered: OfficeExtension.EventHandlers<Word.ContentControlEnteredEventArgs>;
89204
89278
  /**
89205
89279
  * Occurs when the content control is exited, for example, when the cursor leaves the content control.
89206
89280
  *
@@ -89210,7 +89284,7 @@ declare namespace Word {
89210
89284
  * @eventproperty
89211
89285
  * @beta
89212
89286
  */
89213
- readonly onExited: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
89287
+ readonly onExited: OfficeExtension.EventHandlers<Word.ContentControlExitedEventArgs>;
89214
89288
  /**
89215
89289
  * Occurs when selection within the content control is changed.
89216
89290
  *
@@ -89220,7 +89294,7 @@ declare namespace Word {
89220
89294
  * @eventproperty
89221
89295
  * @beta
89222
89296
  */
89223
- readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
89297
+ readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlSelectionChangedEventArgs>;
89224
89298
  /**
89225
89299
  * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you 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.
89226
89300
  */
@@ -90129,7 +90203,8 @@ declare namespace Word {
90129
90203
  getBookmarkRangeOrNullObject(name: string): Word.Range;
90130
90204
  /**
90131
90205
  * Gets the currently supported content controls in the document. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
90132
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90206
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
90207
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90133
90208
  *
90134
90209
  * @remarks
90135
90210
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -90177,13 +90252,13 @@ declare namespace Word {
90177
90252
  * [Api set: WordApi BETA (PREVIEW ONLY)]
90178
90253
  * @beta
90179
90254
  *
90180
- * @param base64File Required. The base64 encoded content of a .docx file.
90255
+ * @param base64File Required. The Base64-encoded content of a .docx file.
90181
90256
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
90182
90257
  * @param insertFileOptions Optional. The additional properties that should be imported to the destination document.
90183
90258
  */
90184
90259
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;
90185
90260
  /**
90186
- * Save the document.
90261
+ * Saves the document.
90187
90262
  *
90188
90263
  * @remarks
90189
90264
  * [Api set: WordApi 1.1]
@@ -90193,7 +90268,7 @@ declare namespace Word {
90193
90268
  */
90194
90269
  save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;
90195
90270
  /**
90196
- * Save the document.
90271
+ * Saves the document.
90197
90272
  *
90198
90273
  * @remarks
90199
90274
  * [Api set: WordApi 1.1]
@@ -90247,7 +90322,7 @@ declare namespace Word {
90247
90322
  * @eventproperty
90248
90323
  * @beta
90249
90324
  */
90250
- readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
90325
+ readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;
90251
90326
  /**
90252
90327
  * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you 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.
90253
90328
  */
@@ -90379,7 +90454,8 @@ declare namespace Word {
90379
90454
  getBookmarkRangeOrNullObject(name: string): Word.Range;
90380
90455
  /**
90381
90456
  * Gets the currently supported content controls in the document. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
90382
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90457
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
90458
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90383
90459
  *
90384
90460
  * @remarks
90385
90461
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -90398,13 +90474,13 @@ declare namespace Word {
90398
90474
  getStyles(): Word.StyleCollection;
90399
90475
  /**
90400
90476
  * Inserts a document into the target document at a specific location with additional properties.
90401
- Headers, footers, watermarks, and other section properties are copied by default.
90477
+ Headers, footers, watermarks, and other section properties are copied by default.
90402
90478
  *
90403
90479
  * @remarks
90404
90480
  * [Api set: WordApi BETA (PREVIEW ONLY)]
90405
90481
  * @beta
90406
90482
  *
90407
- * @param base64File Required. The base64 encoded content of a .docx file.
90483
+ * @param base64File Required. The Base64-encoded content of a .docx file.
90408
90484
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
90409
90485
  * @param insertFileOptions Optional. The additional properties that should be imported to the destination document.
90410
90486
  */
@@ -90417,7 +90493,7 @@ declare namespace Word {
90417
90493
  */
90418
90494
  open(): void;
90419
90495
  /**
90420
- * Save the document.
90496
+ * Saves the document.
90421
90497
  *
90422
90498
  * @remarks
90423
90499
  * [Api set: WordApiHiddenDocument 1.3]
@@ -90427,7 +90503,7 @@ declare namespace Word {
90427
90503
  */
90428
90504
  save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;
90429
90505
  /**
90430
- * Save the document.
90506
+ * Saves the document.
90431
90507
  *
90432
90508
  * @remarks
90433
90509
  * [Api set: WordApiHiddenDocument 1.3]
@@ -91174,7 +91250,7 @@ declare namespace Word {
91174
91250
  */
91175
91251
  delete(): void;
91176
91252
  /**
91177
- * Gets the base64 encoded string representation of the inline image.
91253
+ * Gets the Base64-encoded string representation of the inline image.
91178
91254
  *
91179
91255
  * @remarks
91180
91256
  * [Api set: WordApi 1.1]
@@ -91226,7 +91302,7 @@ declare namespace Word {
91226
91302
  * @remarks
91227
91303
  * [Api set: WordApi 1.2]
91228
91304
  *
91229
- * @param base64File Required. The base64 encoded content of a .docx file.
91305
+ * @param base64File Required. The Base64-encoded content of a .docx file.
91230
91306
  * @param insertLocation Required. The value must be 'Before' or 'After'.
91231
91307
  */
91232
91308
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
@@ -91246,7 +91322,7 @@ declare namespace Word {
91246
91322
  * @remarks
91247
91323
  * [Api set: WordApi 1.2]
91248
91324
  *
91249
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
91325
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted.
91250
91326
  * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
91251
91327
  */
91252
91328
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;
@@ -91447,7 +91523,7 @@ declare namespace Word {
91447
91523
  */
91448
91524
  getLevelParagraphs(level: number): Word.ParagraphCollection;
91449
91525
  /**
91450
- * Gets the base64 encoded string representation of the picture at the specified level in the list.
91526
+ * Gets the Base64-encoded string representation of the picture at the specified level in the list.
91451
91527
  *
91452
91528
  * @remarks
91453
91529
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91571,7 +91647,7 @@ declare namespace Word {
91571
91647
  * @beta
91572
91648
  *
91573
91649
  * @param level Required. The level in the list.
91574
- * @param base64EncodedImage Optional. The base64 encoded image to be set. If not given, the default picture is set.
91650
+ * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set.
91575
91651
  */
91576
91652
  setLevelPicture(level: number, base64EncodedImage?: string): void;
91577
91653
  /**
@@ -91846,7 +91922,7 @@ declare namespace Word {
91846
91922
  */
91847
91923
  numberFormat: string;
91848
91924
  /**
91849
- * Gets or sets the position (in points) of the number or bullet for the specified list level object
91925
+ * Gets or sets the position (in points) of the number or bullet for the specified list level object.
91850
91926
  *
91851
91927
  * @remarks
91852
91928
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91854,7 +91930,7 @@ declare namespace Word {
91854
91930
  */
91855
91931
  numberPosition: number;
91856
91932
  /**
91857
- * Gets or sets the number style for the list level object
91933
+ * Gets or sets the number style for the list level object.
91858
91934
  *
91859
91935
  * @remarks
91860
91936
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91862,7 +91938,7 @@ declare namespace Word {
91862
91938
  */
91863
91939
  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";
91864
91940
  /**
91865
- * Gets or sets the list level that must appear before the specified list level restarts numbering at 1
91941
+ * Gets or sets the list level that must appear before the specified list level restarts numbering at 1.
91866
91942
  *
91867
91943
  * @remarks
91868
91944
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91870,7 +91946,7 @@ declare namespace Word {
91870
91946
  */
91871
91947
  resetOnHigher: number;
91872
91948
  /**
91873
- * Gets or sets the starting number for the specified list level object
91949
+ * Gets or sets the starting number for the specified list level object.
91874
91950
  *
91875
91951
  * @remarks
91876
91952
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91878,7 +91954,7 @@ declare namespace Word {
91878
91954
  */
91879
91955
  startAt: number;
91880
91956
  /**
91881
- * Gets or sets the tab position for the specified list level object
91957
+ * Gets or sets the tab position for the specified list level object.
91882
91958
  *
91883
91959
  * @remarks
91884
91960
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -91886,7 +91962,7 @@ declare namespace Word {
91886
91962
  */
91887
91963
  tabPosition: number;
91888
91964
  /**
91889
- * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object
91965
+ * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object.
91890
91966
  *
91891
91967
  * @remarks
91892
91968
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92023,7 +92099,7 @@ declare namespace Word {
92023
92099
  */
92024
92100
  readonly listLevels: Word.ListLevelCollection;
92025
92101
  /**
92026
- * Gets or sets whether the specified ListTemplate object is outline numbered
92102
+ * Gets or sets whether the specified ListTemplate object is outline numbered.
92027
92103
  *
92028
92104
  * @remarks
92029
92105
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92512,7 +92588,8 @@ declare namespace Word {
92512
92588
  getComments(): Word.CommentCollection;
92513
92589
  /**
92514
92590
  * Gets the currently supported content controls in the paragraph. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
92515
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
92591
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
92592
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
92516
92593
  *
92517
92594
  * @remarks
92518
92595
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92625,7 +92702,7 @@ declare namespace Word {
92625
92702
  * @remarks
92626
92703
  * [Api set: WordApi 1.1]
92627
92704
  *
92628
- * @param base64File Required. The base64 encoded content of a .docx file.
92705
+ * @param base64File Required. The Base64-encoded content of a .docx file.
92629
92706
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
92630
92707
  */
92631
92708
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
@@ -92645,7 +92722,7 @@ declare namespace Word {
92645
92722
  * @remarks
92646
92723
  * [Api set: WordApi 1.1]
92647
92724
  *
92648
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
92725
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted.
92649
92726
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
92650
92727
  */
92651
92728
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
@@ -92944,7 +93021,7 @@ declare namespace Word {
92944
93021
  */
92945
93022
  keepWithNext: boolean;
92946
93023
  /**
92947
- * Gets or sets the left Indent.
93024
+ * Gets or sets the left indent.
92948
93025
  *
92949
93026
  * @remarks
92950
93027
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -92990,7 +93067,7 @@ declare namespace Word {
92990
93067
  * [Api set: WordApi BETA (PREVIEW ONLY)]
92991
93068
  * @beta
92992
93069
  */
92993
- outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4";
93070
+ outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";
92994
93071
  /**
92995
93072
  * Gets or sets the right indent (in points) for the specified paragraphs.
92996
93073
  *
@@ -93291,7 +93368,8 @@ declare namespace Word {
93291
93368
  getComments(): Word.CommentCollection;
93292
93369
  /**
93293
93370
  * Gets the currently supported content controls in the range. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
93294
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
93371
+ Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
93372
+ With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
93295
93373
  *
93296
93374
  * @remarks
93297
93375
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -93457,7 +93535,7 @@ declare namespace Word {
93457
93535
  * @remarks
93458
93536
  * [Api set: WordApi 1.1]
93459
93537
  *
93460
- * @param base64File Required. The base64 encoded content of a .docx file.
93538
+ * @param base64File Required. The Base64-encoded content of a .docx file.
93461
93539
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
93462
93540
  */
93463
93541
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
@@ -93486,7 +93564,7 @@ declare namespace Word {
93486
93564
  * @remarks
93487
93565
  * [Api set: WordApi 1.2]
93488
93566
  *
93489
- * @param base64EncodedImage Required. The base64 encoded image to be inserted.
93567
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted.
93490
93568
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
93491
93569
  */
93492
93570
  insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;
@@ -96020,6 +96098,204 @@ declare namespace Word {
96020
96098
  */
96021
96099
  source: Word.EventSource | "Local" | "Remote";
96022
96100
  }
96101
+ /**
96102
+ * Provides information about the content control that raised contentControlAdded event.
96103
+ *
96104
+ * @remarks
96105
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96106
+ * @beta
96107
+ */
96108
+ interface ContentControlAddedEventArgs {
96109
+ /**
96110
+ * The event type. See Word.EventType for details.
96111
+ *
96112
+ * @remarks
96113
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96114
+ * @beta
96115
+ */
96116
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96117
+ /**
96118
+ * Gets the content control IDs.
96119
+ *
96120
+ * @remarks
96121
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96122
+ * @beta
96123
+ */
96124
+ ids: number[];
96125
+ /**
96126
+ * The source of the event. It can be local or remote (through coauthoring).
96127
+ *
96128
+ * @remarks
96129
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96130
+ * @beta
96131
+ */
96132
+ source: Word.EventSource | "Local" | "Remote";
96133
+ }
96134
+ /**
96135
+ * Provides information about the content control that raised contentControlDataChanged event.
96136
+ *
96137
+ * @remarks
96138
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96139
+ * @beta
96140
+ */
96141
+ interface ContentControlDataChangedEventArgs {
96142
+ /**
96143
+ * The event type. See Word.EventType for details.
96144
+ *
96145
+ * @remarks
96146
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96147
+ * @beta
96148
+ */
96149
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96150
+ /**
96151
+ * Gets the content control IDs.
96152
+ *
96153
+ * @remarks
96154
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96155
+ * @beta
96156
+ */
96157
+ ids: number[];
96158
+ /**
96159
+ * The source of the event. It can be local or remote (through coauthoring).
96160
+ *
96161
+ * @remarks
96162
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96163
+ * @beta
96164
+ */
96165
+ source: Word.EventSource | "Local" | "Remote";
96166
+ }
96167
+ /**
96168
+ * Provides information about the content control that raised contentControlDeleted event.
96169
+ *
96170
+ * @remarks
96171
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96172
+ * @beta
96173
+ */
96174
+ interface ContentControlDeletedEventArgs {
96175
+ /**
96176
+ * The event type. See Word.EventType for details.
96177
+ *
96178
+ * @remarks
96179
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96180
+ * @beta
96181
+ */
96182
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96183
+ /**
96184
+ * Gets the content control IDs.
96185
+ *
96186
+ * @remarks
96187
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96188
+ * @beta
96189
+ */
96190
+ ids: number[];
96191
+ /**
96192
+ * The source of the event. It can be local or remote (through coauthoring).
96193
+ *
96194
+ * @remarks
96195
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96196
+ * @beta
96197
+ */
96198
+ source: Word.EventSource | "Local" | "Remote";
96199
+ }
96200
+ /**
96201
+ * Provides information about the content control that raised contentControlEntered event.
96202
+ *
96203
+ * @remarks
96204
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96205
+ * @beta
96206
+ */
96207
+ interface ContentControlEnteredEventArgs {
96208
+ /**
96209
+ * The event type. See Word.EventType for details.
96210
+ *
96211
+ * @remarks
96212
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96213
+ * @beta
96214
+ */
96215
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96216
+ /**
96217
+ * Gets the content control IDs.
96218
+ *
96219
+ * @remarks
96220
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96221
+ * @beta
96222
+ */
96223
+ ids: number[];
96224
+ /**
96225
+ * The source of the event. It can be local or remote (through coauthoring).
96226
+ *
96227
+ * @remarks
96228
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96229
+ * @beta
96230
+ */
96231
+ source: Word.EventSource | "Local" | "Remote";
96232
+ }
96233
+ /**
96234
+ * Provides information about the content control that raised contentControlExited event.
96235
+ *
96236
+ * @remarks
96237
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96238
+ * @beta
96239
+ */
96240
+ interface ContentControlExitedEventArgs {
96241
+ /**
96242
+ * The event type. See Word.EventType for details.
96243
+ *
96244
+ * @remarks
96245
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96246
+ * @beta
96247
+ */
96248
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96249
+ /**
96250
+ * Gets the content control IDs.
96251
+ *
96252
+ * @remarks
96253
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96254
+ * @beta
96255
+ */
96256
+ ids: number[];
96257
+ /**
96258
+ * The source of the event. It can be local or remote (through coauthoring).
96259
+ *
96260
+ * @remarks
96261
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96262
+ * @beta
96263
+ */
96264
+ source: Word.EventSource | "Local" | "Remote";
96265
+ }
96266
+ /**
96267
+ * Provides information about the content control that raised contentControlSelectionChanged event.
96268
+ *
96269
+ * @remarks
96270
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96271
+ * @beta
96272
+ */
96273
+ interface ContentControlSelectionChangedEventArgs {
96274
+ /**
96275
+ * The event type. See Word.EventType for details.
96276
+ *
96277
+ * @remarks
96278
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96279
+ * @beta
96280
+ */
96281
+ eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";
96282
+ /**
96283
+ * Gets the content control IDs.
96284
+ *
96285
+ * @remarks
96286
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96287
+ * @beta
96288
+ */
96289
+ ids: number[];
96290
+ /**
96291
+ * The source of the event. It can be local or remote (through coauthoring).
96292
+ *
96293
+ * @remarks
96294
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
96295
+ * @beta
96296
+ */
96297
+ source: Word.EventSource | "Local" | "Remote";
96298
+ }
96023
96299
  /**
96024
96300
  * Provides information about the comments that raised the comment event.
96025
96301
  *
@@ -97967,7 +98243,7 @@ declare namespace Word {
97967
98243
  */
97968
98244
  character = "Character",
97969
98245
  /**
97970
- * Represents that the style is a list style.
98246
+ * Represents that the style is a list style. Currently supported on desktop.
97971
98247
  * @remarks
97972
98248
  * [Api set: WordApi BETA (PREVIEW ONLY)]
97973
98249
  * @beta
@@ -98024,6 +98300,48 @@ declare namespace Word {
98024
98300
  * @beta
98025
98301
  */
98026
98302
  outlineLevel4 = "OutlineLevel4",
98303
+ /**
98304
+ * Represents outline level 5.
98305
+ * @remarks
98306
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98307
+ * @beta
98308
+ */
98309
+ outlineLevel5 = "OutlineLevel5",
98310
+ /**
98311
+ * Represents outline level 6.
98312
+ * @remarks
98313
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98314
+ * @beta
98315
+ */
98316
+ outlineLevel6 = "OutlineLevel6",
98317
+ /**
98318
+ * Represents outline level 7.
98319
+ * @remarks
98320
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98321
+ * @beta
98322
+ */
98323
+ outlineLevel7 = "OutlineLevel7",
98324
+ /**
98325
+ * Represents outline level 8.
98326
+ * @remarks
98327
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98328
+ * @beta
98329
+ */
98330
+ outlineLevel8 = "OutlineLevel8",
98331
+ /**
98332
+ * Represents outline level 9.
98333
+ * @remarks
98334
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98335
+ * @beta
98336
+ */
98337
+ outlineLevel9 = "OutlineLevel9",
98338
+ /**
98339
+ * Represents outline level body text, not an outline level.
98340
+ * @remarks
98341
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
98342
+ * @beta
98343
+ */
98344
+ outlineLevelBodyText = "OutlineLevelBodyText",
98027
98345
  }
98028
98346
  /**
98029
98347
  * Specifies the close behavior for `Document.close`.
@@ -99494,7 +99812,7 @@ declare namespace Word {
99494
99812
  */
99495
99813
  code?: string;
99496
99814
  /**
99497
- * Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when setting it.
99815
+ * Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
99498
99816
  *
99499
99817
  * @remarks
99500
99818
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99700,7 +100018,7 @@ declare namespace Word {
99700
100018
  */
99701
100019
  numberFormat?: string;
99702
100020
  /**
99703
- * Gets or sets the position (in points) of the number or bullet for the specified list level object
100021
+ * Gets or sets the position (in points) of the number or bullet for the specified list level object.
99704
100022
  *
99705
100023
  * @remarks
99706
100024
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99708,7 +100026,7 @@ declare namespace Word {
99708
100026
  */
99709
100027
  numberPosition?: number;
99710
100028
  /**
99711
- * Gets or sets the number style for the list level object
100029
+ * Gets or sets the number style for the list level object.
99712
100030
  *
99713
100031
  * @remarks
99714
100032
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99716,7 +100034,7 @@ declare namespace Word {
99716
100034
  */
99717
100035
  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";
99718
100036
  /**
99719
- * Gets or sets the list level that must appear before the specified list level restarts numbering at 1
100037
+ * Gets or sets the list level that must appear before the specified list level restarts numbering at 1.
99720
100038
  *
99721
100039
  * @remarks
99722
100040
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99724,7 +100042,7 @@ declare namespace Word {
99724
100042
  */
99725
100043
  resetOnHigher?: number;
99726
100044
  /**
99727
- * Gets or sets the starting number for the specified list level object
100045
+ * Gets or sets the starting number for the specified list level object.
99728
100046
  *
99729
100047
  * @remarks
99730
100048
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99732,7 +100050,7 @@ declare namespace Word {
99732
100050
  */
99733
100051
  startAt?: number;
99734
100052
  /**
99735
- * Gets or sets the tab position for the specified list level object
100053
+ * Gets or sets the tab position for the specified list level object.
99736
100054
  *
99737
100055
  * @remarks
99738
100056
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99740,7 +100058,7 @@ declare namespace Word {
99740
100058
  */
99741
100059
  tabPosition?: number;
99742
100060
  /**
99743
- * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object
100061
+ * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object.
99744
100062
  *
99745
100063
  * @remarks
99746
100064
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99763,7 +100081,7 @@ declare namespace Word {
99763
100081
  /** An interface for updating data on the ListTemplate object, for use in `listTemplate.set({ ... })`. */
99764
100082
  interface ListTemplateUpdateData {
99765
100083
  /**
99766
- * Gets or sets whether the specified ListTemplate object is outline numbered
100084
+ * Gets or sets whether the specified ListTemplate object is outline numbered.
99767
100085
  *
99768
100086
  * @remarks
99769
100087
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99939,7 +100257,7 @@ declare namespace Word {
99939
100257
  */
99940
100258
  keepWithNext?: boolean;
99941
100259
  /**
99942
- * Gets or sets the left Indent.
100260
+ * Gets or sets the left indent.
99943
100261
  *
99944
100262
  * @remarks
99945
100263
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -99985,7 +100303,7 @@ declare namespace Word {
99985
100303
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99986
100304
  * @beta
99987
100305
  */
99988
- outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4";
100306
+ outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";
99989
100307
  /**
99990
100308
  * Gets or sets the right indent (in points) for the specified paragraphs.
99991
100309
  *
@@ -101421,7 +101739,7 @@ declare namespace Word {
101421
101739
  */
101422
101740
  numberFormat?: string;
101423
101741
  /**
101424
- * Gets or sets the position (in points) of the number or bullet for the specified list level object
101742
+ * Gets or sets the position (in points) of the number or bullet for the specified list level object.
101425
101743
  *
101426
101744
  * @remarks
101427
101745
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101429,7 +101747,7 @@ declare namespace Word {
101429
101747
  */
101430
101748
  numberPosition?: number;
101431
101749
  /**
101432
- * Gets or sets the number style for the list level object
101750
+ * Gets or sets the number style for the list level object.
101433
101751
  *
101434
101752
  * @remarks
101435
101753
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101437,7 +101755,7 @@ declare namespace Word {
101437
101755
  */
101438
101756
  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";
101439
101757
  /**
101440
- * Gets or sets the list level that must appear before the specified list level restarts numbering at 1
101758
+ * Gets or sets the list level that must appear before the specified list level restarts numbering at 1.
101441
101759
  *
101442
101760
  * @remarks
101443
101761
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101445,7 +101763,7 @@ declare namespace Word {
101445
101763
  */
101446
101764
  resetOnHigher?: number;
101447
101765
  /**
101448
- * Gets or sets the starting number for the specified list level object
101766
+ * Gets or sets the starting number for the specified list level object.
101449
101767
  *
101450
101768
  * @remarks
101451
101769
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101453,7 +101771,7 @@ declare namespace Word {
101453
101771
  */
101454
101772
  startAt?: number;
101455
101773
  /**
101456
- * Gets or sets the tab position for the specified list level object
101774
+ * Gets or sets the tab position for the specified list level object.
101457
101775
  *
101458
101776
  * @remarks
101459
101777
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101461,7 +101779,7 @@ declare namespace Word {
101461
101779
  */
101462
101780
  tabPosition?: number;
101463
101781
  /**
101464
- * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object
101782
+ * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object.
101465
101783
  *
101466
101784
  * @remarks
101467
101785
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101492,7 +101810,7 @@ declare namespace Word {
101492
101810
  */
101493
101811
  listLevels?: Word.Interfaces.ListLevelData[];
101494
101812
  /**
101495
- * Gets or sets whether the specified ListTemplate object is outline numbered
101813
+ * Gets or sets whether the specified ListTemplate object is outline numbered.
101496
101814
  *
101497
101815
  * @remarks
101498
101816
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101717,7 +102035,7 @@ declare namespace Word {
101717
102035
  */
101718
102036
  keepWithNext?: boolean;
101719
102037
  /**
101720
- * Gets or sets the left Indent.
102038
+ * Gets or sets the left indent.
101721
102039
  *
101722
102040
  * @remarks
101723
102041
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101763,7 +102081,7 @@ declare namespace Word {
101763
102081
  * [Api set: WordApi BETA (PREVIEW ONLY)]
101764
102082
  * @beta
101765
102083
  */
101766
- outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4";
102084
+ outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";
101767
102085
  /**
101768
102086
  * Gets or sets the right indent (in points) for the specified paragraphs.
101769
102087
  *
@@ -103553,7 +103871,7 @@ declare namespace Word {
103553
103871
  */
103554
103872
  code?: boolean;
103555
103873
  /**
103556
- * Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when setting it.
103874
+ * Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
103557
103875
  *
103558
103876
  * @remarks
103559
103877
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -103668,7 +103986,7 @@ declare namespace Word {
103668
103986
  */
103669
103987
  code?: boolean;
103670
103988
  /**
103671
- * For EACH ITEM in the collection: Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when setting it.
103989
+ * For EACH ITEM in the collection: Gets or sets data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
103672
103990
  *
103673
103991
  * @remarks
103674
103992
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104163,7 +104481,7 @@ declare namespace Word {
104163
104481
  */
104164
104482
  numberFormat?: boolean;
104165
104483
  /**
104166
- * Gets or sets the position (in points) of the number or bullet for the specified list level object
104484
+ * Gets or sets the position (in points) of the number or bullet for the specified list level object.
104167
104485
  *
104168
104486
  * @remarks
104169
104487
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104171,7 +104489,7 @@ declare namespace Word {
104171
104489
  */
104172
104490
  numberPosition?: boolean;
104173
104491
  /**
104174
- * Gets or sets the number style for the list level object
104492
+ * Gets or sets the number style for the list level object.
104175
104493
  *
104176
104494
  * @remarks
104177
104495
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104179,7 +104497,7 @@ declare namespace Word {
104179
104497
  */
104180
104498
  numberStyle?: boolean;
104181
104499
  /**
104182
- * Gets or sets the list level that must appear before the specified list level restarts numbering at 1
104500
+ * Gets or sets the list level that must appear before the specified list level restarts numbering at 1.
104183
104501
  *
104184
104502
  * @remarks
104185
104503
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104187,7 +104505,7 @@ declare namespace Word {
104187
104505
  */
104188
104506
  resetOnHigher?: boolean;
104189
104507
  /**
104190
- * Gets or sets the starting number for the specified list level object
104508
+ * Gets or sets the starting number for the specified list level object.
104191
104509
  *
104192
104510
  * @remarks
104193
104511
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104195,7 +104513,7 @@ declare namespace Word {
104195
104513
  */
104196
104514
  startAt?: boolean;
104197
104515
  /**
104198
- * Gets or sets the tab position for the specified list level object
104516
+ * Gets or sets the tab position for the specified list level object.
104199
104517
  *
104200
104518
  * @remarks
104201
104519
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104203,7 +104521,7 @@ declare namespace Word {
104203
104521
  */
104204
104522
  tabPosition?: boolean;
104205
104523
  /**
104206
- * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object
104524
+ * Gets or sets the position (in points) for the second line of wrapping text for the specified list level object.
104207
104525
  *
104208
104526
  * @remarks
104209
104527
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104264,7 +104582,7 @@ declare namespace Word {
104264
104582
  */
104265
104583
  numberFormat?: boolean;
104266
104584
  /**
104267
- * For EACH ITEM in the collection: Gets or sets the position (in points) of the number or bullet for the specified list level object
104585
+ * For EACH ITEM in the collection: Gets or sets the position (in points) of the number or bullet for the specified list level object.
104268
104586
  *
104269
104587
  * @remarks
104270
104588
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104272,7 +104590,7 @@ declare namespace Word {
104272
104590
  */
104273
104591
  numberPosition?: boolean;
104274
104592
  /**
104275
- * For EACH ITEM in the collection: Gets or sets the number style for the list level object
104593
+ * For EACH ITEM in the collection: Gets or sets the number style for the list level object.
104276
104594
  *
104277
104595
  * @remarks
104278
104596
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104280,7 +104598,7 @@ declare namespace Word {
104280
104598
  */
104281
104599
  numberStyle?: boolean;
104282
104600
  /**
104283
- * For EACH ITEM in the collection: Gets or sets the list level that must appear before the specified list level restarts numbering at 1
104601
+ * For EACH ITEM in the collection: Gets or sets the list level that must appear before the specified list level restarts numbering at 1.
104284
104602
  *
104285
104603
  * @remarks
104286
104604
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104288,7 +104606,7 @@ declare namespace Word {
104288
104606
  */
104289
104607
  resetOnHigher?: boolean;
104290
104608
  /**
104291
- * For EACH ITEM in the collection: Gets or sets the starting number for the specified list level object
104609
+ * For EACH ITEM in the collection: Gets or sets the starting number for the specified list level object.
104292
104610
  *
104293
104611
  * @remarks
104294
104612
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104296,7 +104614,7 @@ declare namespace Word {
104296
104614
  */
104297
104615
  startAt?: boolean;
104298
104616
  /**
104299
- * For EACH ITEM in the collection: Gets or sets the tab position for the specified list level object
104617
+ * For EACH ITEM in the collection: Gets or sets the tab position for the specified list level object.
104300
104618
  *
104301
104619
  * @remarks
104302
104620
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104304,7 +104622,7 @@ declare namespace Word {
104304
104622
  */
104305
104623
  tabPosition?: boolean;
104306
104624
  /**
104307
- * For EACH ITEM in the collection: Gets or sets the position (in points) for the second line of wrapping text for the specified list level object
104625
+ * For EACH ITEM in the collection: Gets or sets the position (in points) for the second line of wrapping text for the specified list level object.
104308
104626
  *
104309
104627
  * @remarks
104310
104628
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104333,7 +104651,7 @@ declare namespace Word {
104333
104651
  */
104334
104652
  $all?: boolean;
104335
104653
  /**
104336
- * Gets or sets whether the specified ListTemplate object is outline numbered
104654
+ * Gets or sets whether the specified ListTemplate object is outline numbered.
104337
104655
  *
104338
104656
  * @remarks
104339
104657
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104868,7 +105186,7 @@ declare namespace Word {
104868
105186
  */
104869
105187
  keepWithNext?: boolean;
104870
105188
  /**
104871
- * Gets or sets the left Indent.
105189
+ * Gets or sets the left indent.
104872
105190
  *
104873
105191
  * @remarks
104874
105192
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.381",
3
+ "version": "1.0.383",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "d9be09e80fb0b76b6836d314e2a69413acaea87d8081c47ec070b9f2a8f15b2b",
48
+ "typesPublisherContentHash": "d68c30aac167a5c05122e2408207ea802b255a74c7ba244fb94734618394d5e7",
49
49
  "typeScriptVersion": "4.3"
50
50
  }