@types/office-js 1.0.277 → 1.0.279
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.
- office-js/README.md +1 -1
- office-js/index.d.ts +135 -674
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -983,14 +983,14 @@ declare namespace Office {
|
|
|
983
983
|
}
|
|
984
984
|
namespace AddinCommands {
|
|
985
985
|
/**
|
|
986
|
-
* The `Event` object is passed as a parameter to add-in functions invoked by
|
|
986
|
+
* The `Event` object is passed as a parameter to add-in functions invoked by function command buttons. The object allows the add-in to identify
|
|
987
987
|
* which button was clicked and to signal the host that it has completed its processing.
|
|
988
988
|
*
|
|
989
989
|
* @remarks
|
|
990
990
|
*
|
|
991
991
|
* See {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
992
992
|
*
|
|
993
|
-
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
|
|
993
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
994
994
|
*
|
|
995
995
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
996
996
|
*/
|
|
@@ -1006,25 +1006,27 @@ declare namespace Office {
|
|
|
1006
1006
|
|
|
1007
1007
|
/**
|
|
1008
1008
|
* Indicates that the add-in has completed processing and will automatically be closed.
|
|
1009
|
-
*
|
|
1010
|
-
* This method must be called at the end of a function which was invoked by the following
|
|
1011
|
-
*
|
|
1012
|
-
* - A
|
|
1009
|
+
*
|
|
1010
|
+
* This method must be called at the end of a function which was invoked by the following:
|
|
1011
|
+
*
|
|
1012
|
+
* - A function command button (that is, an add-in command defined with an `Action` element, where the `xsi:type` attribute is set to `ExecuteFunction`).
|
|
1013
|
+
*
|
|
1014
|
+
* - An event defined in the {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
|
|
1015
|
+
* For example, an `OnMessageSend` event.
|
|
1013
1016
|
*
|
|
1014
1017
|
* - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
|
|
1015
|
-
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
|
|
1016
|
-
* e.g., an `ItemSend` event
|
|
1017
|
-
*
|
|
1018
|
-
* [Api set: Mailbox 1.3]
|
|
1018
|
+
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}. For example, an `ItemSend` event.
|
|
1019
1019
|
*
|
|
1020
1020
|
* @remarks
|
|
1021
|
+
*
|
|
1022
|
+
* [Api set: Mailbox 1.3]
|
|
1021
1023
|
*
|
|
1022
1024
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `Restricted`
|
|
1023
|
-
*
|
|
1025
|
+
*
|
|
1024
1026
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1025
|
-
*
|
|
1027
|
+
*
|
|
1026
1028
|
* **Note**: The `options` parameter was introduced in Mailbox 1.8.
|
|
1027
|
-
*
|
|
1029
|
+
*
|
|
1028
1030
|
* @param options Optional. An object that specifies behavior options for when the event is completed.
|
|
1029
1031
|
*/
|
|
1030
1032
|
completed(options?: EventCompletedOptions): void;
|
|
@@ -1035,11 +1037,37 @@ declare namespace Office {
|
|
|
1035
1037
|
*/
|
|
1036
1038
|
interface EventCompletedOptions {
|
|
1037
1039
|
/**
|
|
1038
|
-
* When the completed
|
|
1039
|
-
* this value indicates if the handled event should continue execution or be canceled.
|
|
1040
|
-
* For example, an add-in that handles the `
|
|
1040
|
+
* When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1041
|
+
* is used to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
|
|
1042
|
+
* For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the
|
|
1043
|
+
* sending of an item. For a complete sample, see the
|
|
1044
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1045
|
+
*
|
|
1046
|
+
* @remarks
|
|
1047
|
+
*
|
|
1048
|
+
* [Api set: Mailbox 1.8]
|
|
1049
|
+
*
|
|
1050
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
1051
|
+
*
|
|
1052
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1041
1053
|
*/
|
|
1042
1054
|
allowEvent: boolean;
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* When the {@link https://docs.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1058
|
+
* is used to signal completion of an event handler and if the `allowEvent` option is set to `false`, this value sets the error message
|
|
1059
|
+
* that will be displayed to the user. For an example, see the
|
|
1060
|
+
* {@link https://docs.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1061
|
+
*
|
|
1062
|
+
* @remarks
|
|
1063
|
+
*
|
|
1064
|
+
* [Api set: Mailbox 1.12]
|
|
1065
|
+
*
|
|
1066
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: `Restricted`
|
|
1067
|
+
*
|
|
1068
|
+
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1069
|
+
*/
|
|
1070
|
+
errorMessage?: string;
|
|
1043
1071
|
}
|
|
1044
1072
|
|
|
1045
1073
|
/**
|
|
@@ -9468,7 +9496,7 @@ declare namespace Office {
|
|
|
9468
9496
|
*
|
|
9469
9497
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9470
9498
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9471
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9499
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
9472
9500
|
*
|
|
9473
9501
|
* Child interfaces:
|
|
9474
9502
|
*
|
|
@@ -9483,7 +9511,7 @@ declare namespace Office {
|
|
|
9483
9511
|
*
|
|
9484
9512
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9485
9513
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9486
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9514
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
9487
9515
|
*
|
|
9488
9516
|
* Parent interfaces:
|
|
9489
9517
|
*
|
|
@@ -9868,7 +9896,7 @@ declare namespace Office {
|
|
|
9868
9896
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
9869
9897
|
*
|
|
9870
9898
|
* For supported events, refer to the Item object model
|
|
9871
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9899
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
9872
9900
|
*
|
|
9873
9901
|
* @remarks
|
|
9874
9902
|
* [Api set: Mailbox 1.7]
|
|
@@ -9890,7 +9918,7 @@ declare namespace Office {
|
|
|
9890
9918
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
9891
9919
|
*
|
|
9892
9920
|
* For supported events, refer to the Item object model
|
|
9893
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
9921
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
9894
9922
|
*
|
|
9895
9923
|
* @remarks
|
|
9896
9924
|
* [Api set: Mailbox 1.7]
|
|
@@ -10392,7 +10420,7 @@ declare namespace Office {
|
|
|
10392
10420
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10393
10421
|
*
|
|
10394
10422
|
* For supported events, refer to the Item object model
|
|
10395
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10423
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
10396
10424
|
*
|
|
10397
10425
|
* @remarks
|
|
10398
10426
|
* [Api set: Mailbox 1.7]
|
|
@@ -10412,7 +10440,7 @@ declare namespace Office {
|
|
|
10412
10440
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10413
10441
|
*
|
|
10414
10442
|
* For supported events, refer to the Item object model
|
|
10415
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10443
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
10416
10444
|
*
|
|
10417
10445
|
* @remarks
|
|
10418
10446
|
* [Api set: Mailbox 1.7]
|
|
@@ -10737,7 +10765,7 @@ declare namespace Office {
|
|
|
10737
10765
|
*
|
|
10738
10766
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
10739
10767
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
10740
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
10768
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
10741
10769
|
*
|
|
10742
10770
|
* Parent interfaces:
|
|
10743
10771
|
*
|
|
@@ -11057,7 +11085,7 @@ declare namespace Office {
|
|
|
11057
11085
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11058
11086
|
*
|
|
11059
11087
|
* For supported events, refer to the Item object model
|
|
11060
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11088
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
11061
11089
|
*
|
|
11062
11090
|
* @remarks
|
|
11063
11091
|
* [Api set: Mailbox 1.7]
|
|
@@ -11079,7 +11107,7 @@ declare namespace Office {
|
|
|
11079
11107
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11080
11108
|
*
|
|
11081
11109
|
* For supported events, refer to the Item object model
|
|
11082
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11110
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
11083
11111
|
*
|
|
11084
11112
|
* @remarks
|
|
11085
11113
|
* [Api set: Mailbox 1.7]
|
|
@@ -11568,7 +11596,7 @@ declare namespace Office {
|
|
|
11568
11596
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11569
11597
|
*
|
|
11570
11598
|
* For supported events, refer to the Item object model
|
|
11571
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11599
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
11572
11600
|
*
|
|
11573
11601
|
* @remarks
|
|
11574
11602
|
* [Api set: Mailbox 1.7]
|
|
@@ -11588,7 +11616,7 @@ declare namespace Office {
|
|
|
11588
11616
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11589
11617
|
*
|
|
11590
11618
|
* For supported events, refer to the Item object model
|
|
11591
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
11619
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
11592
11620
|
*
|
|
11593
11621
|
* @remarks
|
|
11594
11622
|
* [Api set: Mailbox 1.7]
|
|
@@ -13135,7 +13163,7 @@ declare namespace Office {
|
|
|
13135
13163
|
* You can determine the type of the item by using the `itemType` property.
|
|
13136
13164
|
*
|
|
13137
13165
|
* To see the full member list, refer to the
|
|
13138
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13166
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
13139
13167
|
*
|
|
13140
13168
|
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
13141
13169
|
*
|
|
@@ -13160,7 +13188,7 @@ declare namespace Office {
|
|
|
13160
13188
|
*
|
|
13161
13189
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13162
13190
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13163
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13191
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
13164
13192
|
*
|
|
13165
13193
|
* Child interfaces:
|
|
13166
13194
|
*
|
|
@@ -13175,7 +13203,7 @@ declare namespace Office {
|
|
|
13175
13203
|
*
|
|
13176
13204
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13177
13205
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13178
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13206
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
13179
13207
|
*
|
|
13180
13208
|
* Child interfaces:
|
|
13181
13209
|
*
|
|
@@ -13496,7 +13524,7 @@ declare namespace Office {
|
|
|
13496
13524
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13497
13525
|
*
|
|
13498
13526
|
* For supported events, refer to the Mailbox object model
|
|
13499
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13527
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
|
|
13500
13528
|
*
|
|
13501
13529
|
* @remarks
|
|
13502
13530
|
* [Api set: Mailbox 1.5]
|
|
@@ -13517,7 +13545,7 @@ declare namespace Office {
|
|
|
13517
13545
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13518
13546
|
*
|
|
13519
13547
|
* For supported events, refer to the Mailbox object model
|
|
13520
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
13548
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
|
|
13521
13549
|
*
|
|
13522
13550
|
* @remarks
|
|
13523
13551
|
* [Api set: Mailbox 1.5]
|
|
@@ -14220,7 +14248,7 @@ declare namespace Office {
|
|
|
14220
14248
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14221
14249
|
*
|
|
14222
14250
|
* For supported events, refer to the Mailbox object model
|
|
14223
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14251
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
|
|
14224
14252
|
*
|
|
14225
14253
|
* @remarks
|
|
14226
14254
|
* [Api set: Mailbox 1.5]
|
|
@@ -14239,7 +14267,7 @@ declare namespace Office {
|
|
|
14239
14267
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14240
14268
|
*
|
|
14241
14269
|
* For supported events, refer to the Mailbox object model
|
|
14242
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14270
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox#events | events section}.
|
|
14243
14271
|
*
|
|
14244
14272
|
* @remarks
|
|
14245
14273
|
* [Api set: Mailbox 1.5]
|
|
@@ -14431,7 +14459,7 @@ declare namespace Office {
|
|
|
14431
14459
|
*
|
|
14432
14460
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14433
14461
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14434
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14462
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
14435
14463
|
*
|
|
14436
14464
|
* Child interfaces:
|
|
14437
14465
|
*
|
|
@@ -14446,7 +14474,7 @@ declare namespace Office {
|
|
|
14446
14474
|
*
|
|
14447
14475
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14448
14476
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14449
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14477
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
14450
14478
|
*
|
|
14451
14479
|
* Parent interfaces:
|
|
14452
14480
|
*
|
|
@@ -14798,7 +14826,7 @@ declare namespace Office {
|
|
|
14798
14826
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
14799
14827
|
*
|
|
14800
14828
|
* For supported events, refer to the Item object model
|
|
14801
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14829
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
14802
14830
|
*
|
|
14803
14831
|
* @remarks
|
|
14804
14832
|
* [Api set: Mailbox 1.7]
|
|
@@ -14820,7 +14848,7 @@ declare namespace Office {
|
|
|
14820
14848
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
14821
14849
|
*
|
|
14822
14850
|
* For supported events, refer to the Item object model
|
|
14823
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
14851
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
14824
14852
|
*
|
|
14825
14853
|
* @remarks
|
|
14826
14854
|
* [Api set: Mailbox 1.7]
|
|
@@ -15380,7 +15408,7 @@ declare namespace Office {
|
|
|
15380
15408
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15381
15409
|
*
|
|
15382
15410
|
* For supported events, refer to the Item object model
|
|
15383
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15411
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
15384
15412
|
*
|
|
15385
15413
|
* @remarks
|
|
15386
15414
|
* [Api set: Mailbox 1.7]
|
|
@@ -15400,7 +15428,7 @@ declare namespace Office {
|
|
|
15400
15428
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15401
15429
|
*
|
|
15402
15430
|
* For supported events, refer to the Item object model
|
|
15403
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15431
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
15404
15432
|
*
|
|
15405
15433
|
* @remarks
|
|
15406
15434
|
* [Api set: Mailbox 1.7]
|
|
@@ -15544,7 +15572,7 @@ declare namespace Office {
|
|
|
15544
15572
|
*
|
|
15545
15573
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15546
15574
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
15547
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15575
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item | Object Model} page.
|
|
15548
15576
|
*
|
|
15549
15577
|
* Parent interfaces:
|
|
15550
15578
|
*
|
|
@@ -15915,7 +15943,7 @@ declare namespace Office {
|
|
|
15915
15943
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15916
15944
|
*
|
|
15917
15945
|
* For supported events, refer to the Item object model
|
|
15918
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15946
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
15919
15947
|
*
|
|
15920
15948
|
* @remarks
|
|
15921
15949
|
* [Api set: Mailbox 1.7]
|
|
@@ -15937,7 +15965,7 @@ declare namespace Office {
|
|
|
15937
15965
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15938
15966
|
*
|
|
15939
15967
|
* For supported events, refer to the Item object model
|
|
15940
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
15968
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
15941
15969
|
*
|
|
15942
15970
|
* @remarks
|
|
15943
15971
|
* [Api set: Mailbox 1.7]
|
|
@@ -16466,7 +16494,7 @@ declare namespace Office {
|
|
|
16466
16494
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16467
16495
|
*
|
|
16468
16496
|
* For supported events, refer to the Item object model
|
|
16469
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16497
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
16470
16498
|
*
|
|
16471
16499
|
* @remarks
|
|
16472
16500
|
* [Api set: Mailbox 1.7]
|
|
@@ -16486,7 +16514,7 @@ declare namespace Office {
|
|
|
16486
16514
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16487
16515
|
*
|
|
16488
16516
|
* For supported events, refer to the Item object model
|
|
16489
|
-
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.
|
|
16517
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.12/office.context.mailbox.item#events | events section}.
|
|
16490
16518
|
*
|
|
16491
16519
|
* @remarks
|
|
16492
16520
|
* [Api set: Mailbox 1.7]
|
|
@@ -75670,16 +75698,7 @@ declare namespace Word {
|
|
|
75670
75698
|
*
|
|
75671
75699
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
75672
75700
|
*/
|
|
75673
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
75674
|
-
/**
|
|
75675
|
-
* Gets the whole body, or the starting or ending point of the body, as a range.
|
|
75676
|
-
*
|
|
75677
|
-
* @remarks
|
|
75678
|
-
* [Api set: WordApi 1.3]
|
|
75679
|
-
*
|
|
75680
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
75681
|
-
*/
|
|
75682
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
75701
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
75683
75702
|
/**
|
|
75684
75703
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
75685
75704
|
*
|
|
@@ -75707,17 +75726,7 @@ declare namespace Word {
|
|
|
75707
75726
|
* @param breakType Required. The break type to add to the body.
|
|
75708
75727
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75709
75728
|
*/
|
|
75710
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
75711
|
-
/**
|
|
75712
|
-
* Inserts a break at the specified location in the main document.
|
|
75713
|
-
*
|
|
75714
|
-
* @remarks
|
|
75715
|
-
* [Api set: WordApi 1.1]
|
|
75716
|
-
*
|
|
75717
|
-
* @param breakType Required. The break type to add to the body.
|
|
75718
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75719
|
-
*/
|
|
75720
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
75729
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void;
|
|
75721
75730
|
/**
|
|
75722
75731
|
* Wraps the body object with a Rich Text content control.
|
|
75723
75732
|
*
|
|
@@ -75734,27 +75743,7 @@ declare namespace Word {
|
|
|
75734
75743
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
75735
75744
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75736
75745
|
*/
|
|
75737
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
75738
|
-
/**
|
|
75739
|
-
* Inserts a document into the body at the specified location.
|
|
75740
|
-
*
|
|
75741
|
-
* @remarks
|
|
75742
|
-
* [Api set: WordApi 1.1]
|
|
75743
|
-
*
|
|
75744
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
75745
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75746
|
-
*/
|
|
75747
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
75748
|
-
/**
|
|
75749
|
-
* Inserts HTML at the specified location.
|
|
75750
|
-
*
|
|
75751
|
-
* @remarks
|
|
75752
|
-
* [Api set: WordApi 1.1]
|
|
75753
|
-
*
|
|
75754
|
-
* @param html Required. The HTML to be inserted in the document.
|
|
75755
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75756
|
-
*/
|
|
75757
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
75746
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
75758
75747
|
/**
|
|
75759
75748
|
* Inserts HTML at the specified location.
|
|
75760
75749
|
*
|
|
@@ -75764,17 +75753,7 @@ declare namespace Word {
|
|
|
75764
75753
|
* @param html Required. The HTML to be inserted in the document.
|
|
75765
75754
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75766
75755
|
*/
|
|
75767
|
-
insertHtml(html: string, insertLocation:
|
|
75768
|
-
/**
|
|
75769
|
-
* Inserts a picture into the body at the specified location.
|
|
75770
|
-
*
|
|
75771
|
-
* @remarks
|
|
75772
|
-
* [Api set: WordApi 1.2]
|
|
75773
|
-
*
|
|
75774
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
|
|
75775
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75776
|
-
*/
|
|
75777
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
75756
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
75778
75757
|
/**
|
|
75779
75758
|
* Inserts a picture into the body at the specified location.
|
|
75780
75759
|
*
|
|
@@ -75784,7 +75763,7 @@ declare namespace Word {
|
|
|
75784
75763
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the body.
|
|
75785
75764
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75786
75765
|
*/
|
|
75787
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
75766
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
|
|
75788
75767
|
/**
|
|
75789
75768
|
* Inserts OOXML at the specified location.
|
|
75790
75769
|
*
|
|
@@ -75794,27 +75773,7 @@ declare namespace Word {
|
|
|
75794
75773
|
* @param ooxml Required. The OOXML to be inserted.
|
|
75795
75774
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75796
75775
|
*/
|
|
75797
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
75798
|
-
/**
|
|
75799
|
-
* Inserts OOXML at the specified location.
|
|
75800
|
-
*
|
|
75801
|
-
* @remarks
|
|
75802
|
-
* [Api set: WordApi 1.1]
|
|
75803
|
-
*
|
|
75804
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
75805
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75806
|
-
*/
|
|
75807
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
75808
|
-
/**
|
|
75809
|
-
* Inserts a paragraph at the specified location.
|
|
75810
|
-
*
|
|
75811
|
-
* @remarks
|
|
75812
|
-
* [Api set: WordApi 1.1]
|
|
75813
|
-
*
|
|
75814
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
75815
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75816
|
-
*/
|
|
75817
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
75776
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
75818
75777
|
/**
|
|
75819
75778
|
* Inserts a paragraph at the specified location.
|
|
75820
75779
|
*
|
|
@@ -75824,19 +75783,7 @@ declare namespace Word {
|
|
|
75824
75783
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
75825
75784
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75826
75785
|
*/
|
|
75827
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
75828
|
-
/**
|
|
75829
|
-
* Inserts a table with the specified number of rows and columns.
|
|
75830
|
-
*
|
|
75831
|
-
* @remarks
|
|
75832
|
-
* [Api set: WordApi 1.3]
|
|
75833
|
-
*
|
|
75834
|
-
* @param rowCount Required. The number of rows in the table.
|
|
75835
|
-
* @param columnCount Required. The number of columns in the table.
|
|
75836
|
-
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75837
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
75838
|
-
*/
|
|
75839
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
75786
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph;
|
|
75840
75787
|
/**
|
|
75841
75788
|
* Inserts a table with the specified number of rows and columns.
|
|
75842
75789
|
*
|
|
@@ -75848,7 +75795,7 @@ declare namespace Word {
|
|
|
75848
75795
|
* @param insertLocation Required. The value must be 'Start' or 'End'.
|
|
75849
75796
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
75850
75797
|
*/
|
|
75851
|
-
insertTable(rowCount: number, columnCount: number, insertLocation:
|
|
75798
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table;
|
|
75852
75799
|
/**
|
|
75853
75800
|
* Inserts text into the body at the specified location.
|
|
75854
75801
|
*
|
|
@@ -75858,17 +75805,7 @@ declare namespace Word {
|
|
|
75858
75805
|
* @param text Required. Text to be inserted.
|
|
75859
75806
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75860
75807
|
*/
|
|
75861
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
75862
|
-
/**
|
|
75863
|
-
* Inserts text into the body at the specified location.
|
|
75864
|
-
*
|
|
75865
|
-
* @remarks
|
|
75866
|
-
* [Api set: WordApi 1.1]
|
|
75867
|
-
*
|
|
75868
|
-
* @param text Required. Text to be inserted.
|
|
75869
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
75870
|
-
*/
|
|
75871
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
75808
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
75872
75809
|
/**
|
|
75873
75810
|
* Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects.
|
|
75874
75811
|
*
|
|
@@ -76096,15 +76033,6 @@ declare namespace Word {
|
|
|
76096
76033
|
* [Api set: WordApiOnline 1.1]
|
|
76097
76034
|
*/
|
|
76098
76035
|
getFirstOrNullObject(): Word.Comment;
|
|
76099
|
-
/**
|
|
76100
|
-
* Gets a comment object by its index in the collection.
|
|
76101
|
-
*
|
|
76102
|
-
* @remarks
|
|
76103
|
-
* [Api set: WordApiOnline 1.1]
|
|
76104
|
-
*
|
|
76105
|
-
* @param index A number that identifies the index location of a comment object.
|
|
76106
|
-
*/
|
|
76107
|
-
getItem(index: number): Word.Comment;
|
|
76108
76036
|
/**
|
|
76109
76037
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
76110
76038
|
*
|
|
@@ -76208,19 +76136,9 @@ declare namespace Word {
|
|
|
76208
76136
|
* [Api set: WordApiOnline 1.1]
|
|
76209
76137
|
*
|
|
76210
76138
|
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
76211
|
-
* @param insertLocation Required. The value must be '
|
|
76212
|
-
*/
|
|
76213
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
76214
|
-
/**
|
|
76215
|
-
* Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI.
|
|
76216
|
-
*
|
|
76217
|
-
* @remarks
|
|
76218
|
-
* [Api set: WordApiOnline 1.1]
|
|
76219
|
-
*
|
|
76220
|
-
* @param text Required. The text to be inserted in to the CommentContentRange.
|
|
76221
|
-
* @param insertLocation Required. The value must be 'After', 'Before', 'Replace', 'Start', or 'End'.
|
|
76139
|
+
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
76222
76140
|
*/
|
|
76223
|
-
insertText(text: string, insertLocation:
|
|
76141
|
+
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;
|
|
76224
76142
|
/**
|
|
76225
76143
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
76226
76144
|
*
|
|
@@ -76389,15 +76307,6 @@ declare namespace Word {
|
|
|
76389
76307
|
* [Api set: WordApiOnline 1.1]
|
|
76390
76308
|
*/
|
|
76391
76309
|
getFirstOrNullObject(): Word.CommentReply;
|
|
76392
|
-
/**
|
|
76393
|
-
* Gets a comment reply object by its index in the collection.
|
|
76394
|
-
*
|
|
76395
|
-
* @remarks
|
|
76396
|
-
* [Api set: WordApiOnline 1.1]
|
|
76397
|
-
*
|
|
76398
|
-
* @param index A number that identifies the index location of a comment reply object.
|
|
76399
|
-
*/
|
|
76400
|
-
getItem(index: number): Word.CommentReply;
|
|
76401
76310
|
/**
|
|
76402
76311
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
76403
76312
|
*
|
|
@@ -76694,18 +76603,9 @@ declare namespace Word {
|
|
|
76694
76603
|
* @remarks
|
|
76695
76604
|
* [Api set: WordApi 1.3]
|
|
76696
76605
|
*
|
|
76697
|
-
* @param rangeLocation Optional. The range location must be 'Whole', '
|
|
76606
|
+
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'.
|
|
76698
76607
|
*/
|
|
76699
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
76700
|
-
/**
|
|
76701
|
-
* Gets the whole content control, or the starting or ending point of the content control, as a range.
|
|
76702
|
-
*
|
|
76703
|
-
* @remarks
|
|
76704
|
-
* [Api set: WordApi 1.3]
|
|
76705
|
-
*
|
|
76706
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Before', 'Start', 'End', 'After', or 'Content'.
|
|
76707
|
-
*/
|
|
76708
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
76608
|
+
getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
76709
76609
|
/**
|
|
76710
76610
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
76711
76611
|
*
|
|
@@ -76743,27 +76643,7 @@ declare namespace Word {
|
|
|
76743
76643
|
* @param breakType Required. Type of break.
|
|
76744
76644
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
76745
76645
|
*/
|
|
76746
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
76747
|
-
/**
|
|
76748
|
-
* Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76749
|
-
*
|
|
76750
|
-
* @remarks
|
|
76751
|
-
* [Api set: WordApi 1.1]
|
|
76752
|
-
*
|
|
76753
|
-
* @param breakType Required. Type of break.
|
|
76754
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
76755
|
-
*/
|
|
76756
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
76757
|
-
/**
|
|
76758
|
-
* Inserts a document into the content control at the specified location.
|
|
76759
|
-
*
|
|
76760
|
-
* @remarks
|
|
76761
|
-
* [Api set: WordApi 1.1]
|
|
76762
|
-
*
|
|
76763
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
76764
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76765
|
-
*/
|
|
76766
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
76646
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void;
|
|
76767
76647
|
/**
|
|
76768
76648
|
* Inserts a document into the content control at the specified location.
|
|
76769
76649
|
*
|
|
@@ -76773,7 +76653,7 @@ declare namespace Word {
|
|
|
76773
76653
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
76774
76654
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76775
76655
|
*/
|
|
76776
|
-
insertFileFromBase64(base64File: string, insertLocation:
|
|
76656
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
76777
76657
|
/**
|
|
76778
76658
|
* Inserts HTML into the content control at the specified location.
|
|
76779
76659
|
*
|
|
@@ -76783,17 +76663,7 @@ declare namespace Word {
|
|
|
76783
76663
|
* @param html Required. The HTML to be inserted in to the content control.
|
|
76784
76664
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76785
76665
|
*/
|
|
76786
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
76787
|
-
/**
|
|
76788
|
-
* Inserts HTML into the content control at the specified location.
|
|
76789
|
-
*
|
|
76790
|
-
* @remarks
|
|
76791
|
-
* [Api set: WordApi 1.1]
|
|
76792
|
-
*
|
|
76793
|
-
* @param html Required. The HTML to be inserted in to the content control.
|
|
76794
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76795
|
-
*/
|
|
76796
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
76666
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
76797
76667
|
/**
|
|
76798
76668
|
* Inserts an inline picture into the content control at the specified location.
|
|
76799
76669
|
*
|
|
@@ -76803,17 +76673,7 @@ declare namespace Word {
|
|
|
76803
76673
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
|
|
76804
76674
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76805
76675
|
*/
|
|
76806
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
76807
|
-
/**
|
|
76808
|
-
* Inserts an inline picture into the content control at the specified location.
|
|
76809
|
-
*
|
|
76810
|
-
* @remarks
|
|
76811
|
-
* [Api set: WordApi 1.2]
|
|
76812
|
-
*
|
|
76813
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted in the content control.
|
|
76814
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76815
|
-
*/
|
|
76816
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
|
|
76676
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
|
|
76817
76677
|
/**
|
|
76818
76678
|
* Inserts OOXML into the content control at the specified location.
|
|
76819
76679
|
*
|
|
@@ -76823,17 +76683,7 @@ declare namespace Word {
|
|
|
76823
76683
|
* @param ooxml Required. The OOXML to be inserted in to the content control.
|
|
76824
76684
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76825
76685
|
*/
|
|
76826
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
76827
|
-
/**
|
|
76828
|
-
* Inserts OOXML into the content control at the specified location.
|
|
76829
|
-
*
|
|
76830
|
-
* @remarks
|
|
76831
|
-
* [Api set: WordApi 1.1]
|
|
76832
|
-
*
|
|
76833
|
-
* @param ooxml Required. The OOXML to be inserted in to the content control.
|
|
76834
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76835
|
-
*/
|
|
76836
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
76686
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
76837
76687
|
/**
|
|
76838
76688
|
* Inserts a paragraph at the specified location.
|
|
76839
76689
|
*
|
|
@@ -76843,17 +76693,7 @@ declare namespace Word {
|
|
|
76843
76693
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
76844
76694
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76845
76695
|
*/
|
|
76846
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
76847
|
-
/**
|
|
76848
|
-
* Inserts a paragraph at the specified location.
|
|
76849
|
-
*
|
|
76850
|
-
* @remarks
|
|
76851
|
-
* [Api set: WordApi 1.1]
|
|
76852
|
-
*
|
|
76853
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
76854
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76855
|
-
*/
|
|
76856
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
76696
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
|
|
76857
76697
|
/**
|
|
76858
76698
|
* Inserts a table with the specified number of rows and columns into, or next to, a content control.
|
|
76859
76699
|
*
|
|
@@ -76865,19 +76705,7 @@ declare namespace Word {
|
|
|
76865
76705
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76866
76706
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
76867
76707
|
*/
|
|
76868
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
76869
|
-
/**
|
|
76870
|
-
* Inserts a table with the specified number of rows and columns into, or next to, a content control.
|
|
76871
|
-
*
|
|
76872
|
-
* @remarks
|
|
76873
|
-
* [Api set: WordApi 1.3]
|
|
76874
|
-
*
|
|
76875
|
-
* @param rowCount Required. The number of rows in the table.
|
|
76876
|
-
* @param columnCount Required. The number of columns in the table.
|
|
76877
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls.
|
|
76878
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
76879
|
-
*/
|
|
76880
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
76708
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table;
|
|
76881
76709
|
/**
|
|
76882
76710
|
* Inserts text into the content control at the specified location.
|
|
76883
76711
|
*
|
|
@@ -76887,17 +76715,7 @@ declare namespace Word {
|
|
|
76887
76715
|
* @param text Required. The text to be inserted in to the content control.
|
|
76888
76716
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76889
76717
|
*/
|
|
76890
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
76891
|
-
/**
|
|
76892
|
-
* Inserts text into the content control at the specified location.
|
|
76893
|
-
*
|
|
76894
|
-
* @remarks
|
|
76895
|
-
* [Api set: WordApi 1.1]
|
|
76896
|
-
*
|
|
76897
|
-
* @param text Required. The text to be inserted in to the content control.
|
|
76898
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
|
|
76899
|
-
*/
|
|
76900
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
76718
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
76901
76719
|
/**
|
|
76902
76720
|
* Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects.
|
|
76903
76721
|
*
|
|
@@ -77052,14 +76870,14 @@ declare namespace Word {
|
|
|
77052
76870
|
*/
|
|
77053
76871
|
getFirstOrNullObject(): Word.ContentControl;
|
|
77054
76872
|
/**
|
|
77055
|
-
* Gets a content control by its
|
|
76873
|
+
* Gets a content control by its ID.
|
|
77056
76874
|
*
|
|
77057
76875
|
* @remarks
|
|
77058
76876
|
* [Api set: WordApi 1.1]
|
|
77059
76877
|
*
|
|
77060
|
-
* @param
|
|
76878
|
+
* @param id The content control's ID.
|
|
77061
76879
|
*/
|
|
77062
|
-
getItem(
|
|
76880
|
+
getItem(id: number): Word.ContentControl;
|
|
77063
76881
|
/**
|
|
77064
76882
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
77065
76883
|
*
|
|
@@ -77949,26 +77767,7 @@ declare namespace Word {
|
|
|
77949
77767
|
*
|
|
77950
77768
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
77951
77769
|
*/
|
|
77952
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
77953
|
-
/**
|
|
77954
|
-
* Gets the picture, or the starting or ending point of the picture, as a range.
|
|
77955
|
-
*
|
|
77956
|
-
* @remarks
|
|
77957
|
-
* [Api set: WordApi 1.3]
|
|
77958
|
-
*
|
|
77959
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'.
|
|
77960
|
-
*/
|
|
77961
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
77962
|
-
/**
|
|
77963
|
-
* Inserts a break at the specified location in the main document.
|
|
77964
|
-
*
|
|
77965
|
-
* @remarks
|
|
77966
|
-
* [Api set: WordApi 1.2]
|
|
77967
|
-
*
|
|
77968
|
-
* @param breakType Required. The break type to add.
|
|
77969
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
77970
|
-
*/
|
|
77971
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
77770
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
|
|
77972
77771
|
/**
|
|
77973
77772
|
* Inserts a break at the specified location in the main document.
|
|
77974
77773
|
*
|
|
@@ -77978,7 +77777,7 @@ declare namespace Word {
|
|
|
77978
77777
|
* @param breakType Required. The break type to add.
|
|
77979
77778
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
77980
77779
|
*/
|
|
77981
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation:
|
|
77780
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
77982
77781
|
/**
|
|
77983
77782
|
* Wraps the inline picture with a rich text content control.
|
|
77984
77783
|
*
|
|
@@ -77995,17 +77794,7 @@ declare namespace Word {
|
|
|
77995
77794
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
77996
77795
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
77997
77796
|
*/
|
|
77998
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
77999
|
-
/**
|
|
78000
|
-
* Inserts a document at the specified location.
|
|
78001
|
-
*
|
|
78002
|
-
* @remarks
|
|
78003
|
-
* [Api set: WordApi 1.2]
|
|
78004
|
-
*
|
|
78005
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
78006
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78007
|
-
*/
|
|
78008
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
77797
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
78009
77798
|
/**
|
|
78010
77799
|
* Inserts HTML at the specified location.
|
|
78011
77800
|
*
|
|
@@ -78015,17 +77804,7 @@ declare namespace Word {
|
|
|
78015
77804
|
* @param html Required. The HTML to be inserted.
|
|
78016
77805
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78017
77806
|
*/
|
|
78018
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
78019
|
-
/**
|
|
78020
|
-
* Inserts HTML at the specified location.
|
|
78021
|
-
*
|
|
78022
|
-
* @remarks
|
|
78023
|
-
* [Api set: WordApi 1.2]
|
|
78024
|
-
*
|
|
78025
|
-
* @param html Required. The HTML to be inserted.
|
|
78026
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78027
|
-
*/
|
|
78028
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
77807
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
78029
77808
|
/**
|
|
78030
77809
|
* Inserts an inline picture at the specified location.
|
|
78031
77810
|
*
|
|
@@ -78035,27 +77814,7 @@ declare namespace Word {
|
|
|
78035
77814
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
78036
77815
|
* @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
|
|
78037
77816
|
*/
|
|
78038
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
78039
|
-
/**
|
|
78040
|
-
* Inserts an inline picture at the specified location.
|
|
78041
|
-
*
|
|
78042
|
-
* @remarks
|
|
78043
|
-
* [Api set: WordApi 1.2]
|
|
78044
|
-
*
|
|
78045
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
78046
|
-
* @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'.
|
|
78047
|
-
*/
|
|
78048
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;
|
|
78049
|
-
/**
|
|
78050
|
-
* Inserts OOXML at the specified location.
|
|
78051
|
-
*
|
|
78052
|
-
* @remarks
|
|
78053
|
-
* [Api set: WordApi 1.2]
|
|
78054
|
-
*
|
|
78055
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
78056
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78057
|
-
*/
|
|
78058
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
77817
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;
|
|
78059
77818
|
/**
|
|
78060
77819
|
* Inserts OOXML at the specified location.
|
|
78061
77820
|
*
|
|
@@ -78065,17 +77824,7 @@ declare namespace Word {
|
|
|
78065
77824
|
* @param ooxml Required. The OOXML to be inserted.
|
|
78066
77825
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78067
77826
|
*/
|
|
78068
|
-
insertOoxml(ooxml: string, insertLocation:
|
|
78069
|
-
/**
|
|
78070
|
-
* Inserts a paragraph at the specified location.
|
|
78071
|
-
*
|
|
78072
|
-
* @remarks
|
|
78073
|
-
* [Api set: WordApi 1.2]
|
|
78074
|
-
*
|
|
78075
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
78076
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78077
|
-
*/
|
|
78078
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
77827
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
78079
77828
|
/**
|
|
78080
77829
|
* Inserts a paragraph at the specified location.
|
|
78081
77830
|
*
|
|
@@ -78085,7 +77834,7 @@ declare namespace Word {
|
|
|
78085
77834
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
78086
77835
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78087
77836
|
*/
|
|
78088
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
77837
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
78089
77838
|
/**
|
|
78090
77839
|
* Inserts text at the specified location.
|
|
78091
77840
|
*
|
|
@@ -78095,17 +77844,7 @@ declare namespace Word {
|
|
|
78095
77844
|
* @param text Required. Text to be inserted.
|
|
78096
77845
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78097
77846
|
*/
|
|
78098
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
78099
|
-
/**
|
|
78100
|
-
* Inserts text at the specified location.
|
|
78101
|
-
*
|
|
78102
|
-
* @remarks
|
|
78103
|
-
* [Api set: WordApi 1.2]
|
|
78104
|
-
*
|
|
78105
|
-
* @param text Required. Text to be inserted.
|
|
78106
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
78107
|
-
*/
|
|
78108
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
77847
|
+
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;
|
|
78109
77848
|
/**
|
|
78110
77849
|
* Selects the inline picture. This causes Word to scroll to the selection.
|
|
78111
77850
|
*
|
|
@@ -78280,17 +78019,7 @@ declare namespace Word {
|
|
|
78280
78019
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
78281
78020
|
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
78282
78021
|
*/
|
|
78283
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
78284
|
-
/**
|
|
78285
|
-
* Inserts a paragraph at the specified location.
|
|
78286
|
-
*
|
|
78287
|
-
* @remarks
|
|
78288
|
-
* [Api set: WordApi 1.3]
|
|
78289
|
-
*
|
|
78290
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
78291
|
-
* @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'.
|
|
78292
|
-
*/
|
|
78293
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
78022
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
|
|
78294
78023
|
/**
|
|
78295
78024
|
* Sets the alignment of the bullet, number, or picture at the specified level in the list.
|
|
78296
78025
|
*
|
|
@@ -78457,14 +78186,14 @@ declare namespace Word {
|
|
|
78457
78186
|
*/
|
|
78458
78187
|
getFirstOrNullObject(): Word.List;
|
|
78459
78188
|
/**
|
|
78460
|
-
* Gets a list object by its
|
|
78189
|
+
* Gets a list object by its ID.
|
|
78461
78190
|
*
|
|
78462
78191
|
* @remarks
|
|
78463
78192
|
* [Api set: WordApi 1.3]
|
|
78464
78193
|
*
|
|
78465
|
-
* @param
|
|
78194
|
+
* @param id The list's ID.
|
|
78466
78195
|
*/
|
|
78467
|
-
getItem(
|
|
78196
|
+
getItem(id: number): Word.List;
|
|
78468
78197
|
/**
|
|
78469
78198
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
78470
78199
|
*
|
|
@@ -79077,16 +78806,7 @@ declare namespace Word {
|
|
|
79077
78806
|
*
|
|
79078
78807
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
79079
78808
|
*/
|
|
79080
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
79081
|
-
/**
|
|
79082
|
-
* Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.
|
|
79083
|
-
*
|
|
79084
|
-
* @remarks
|
|
79085
|
-
* [Api set: WordApi 1.3]
|
|
79086
|
-
*
|
|
79087
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
79088
|
-
*/
|
|
79089
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
78809
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
79090
78810
|
/**
|
|
79091
78811
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79092
78812
|
*
|
|
@@ -79124,17 +78844,7 @@ declare namespace Word {
|
|
|
79124
78844
|
* @param breakType Required. The break type to add to the document.
|
|
79125
78845
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79126
78846
|
*/
|
|
79127
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
79128
|
-
/**
|
|
79129
|
-
* Inserts a break at the specified location in the main document.
|
|
79130
|
-
*
|
|
79131
|
-
* @remarks
|
|
79132
|
-
* [Api set: WordApi 1.1]
|
|
79133
|
-
*
|
|
79134
|
-
* @param breakType Required. The break type to add to the document.
|
|
79135
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79136
|
-
*/
|
|
79137
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
78847
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
79138
78848
|
/**
|
|
79139
78849
|
* Wraps the paragraph object with a rich text content control.
|
|
79140
78850
|
*
|
|
@@ -79151,17 +78861,7 @@ declare namespace Word {
|
|
|
79151
78861
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
79152
78862
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79153
78863
|
*/
|
|
79154
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79155
|
-
/**
|
|
79156
|
-
* Inserts a document into the paragraph at the specified location.
|
|
79157
|
-
*
|
|
79158
|
-
* @remarks
|
|
79159
|
-
* [Api set: WordApi 1.1]
|
|
79160
|
-
*
|
|
79161
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
79162
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79163
|
-
*/
|
|
79164
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
78864
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
79165
78865
|
/**
|
|
79166
78866
|
* Inserts HTML into the paragraph at the specified location.
|
|
79167
78867
|
*
|
|
@@ -79171,27 +78871,7 @@ declare namespace Word {
|
|
|
79171
78871
|
* @param html Required. The HTML to be inserted in the paragraph.
|
|
79172
78872
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79173
78873
|
*/
|
|
79174
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79175
|
-
/**
|
|
79176
|
-
* Inserts HTML into the paragraph at the specified location.
|
|
79177
|
-
*
|
|
79178
|
-
* @remarks
|
|
79179
|
-
* [Api set: WordApi 1.1]
|
|
79180
|
-
*
|
|
79181
|
-
* @param html Required. The HTML to be inserted in the paragraph.
|
|
79182
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79183
|
-
*/
|
|
79184
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79185
|
-
/**
|
|
79186
|
-
* Inserts a picture into the paragraph at the specified location.
|
|
79187
|
-
*
|
|
79188
|
-
* @remarks
|
|
79189
|
-
* [Api set: WordApi 1.1]
|
|
79190
|
-
*
|
|
79191
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
79192
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79193
|
-
*/
|
|
79194
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
78874
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
79195
78875
|
/**
|
|
79196
78876
|
* Inserts a picture into the paragraph at the specified location.
|
|
79197
78877
|
*
|
|
@@ -79201,7 +78881,7 @@ declare namespace Word {
|
|
|
79201
78881
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
79202
78882
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79203
78883
|
*/
|
|
79204
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
78884
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
|
|
79205
78885
|
/**
|
|
79206
78886
|
* Inserts OOXML into the paragraph at the specified location.
|
|
79207
78887
|
*
|
|
@@ -79211,27 +78891,7 @@ declare namespace Word {
|
|
|
79211
78891
|
* @param ooxml Required. The OOXML to be inserted in the paragraph.
|
|
79212
78892
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79213
78893
|
*/
|
|
79214
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79215
|
-
/**
|
|
79216
|
-
* Inserts OOXML into the paragraph at the specified location.
|
|
79217
|
-
*
|
|
79218
|
-
* @remarks
|
|
79219
|
-
* [Api set: WordApi 1.1]
|
|
79220
|
-
*
|
|
79221
|
-
* @param ooxml Required. The OOXML to be inserted in the paragraph.
|
|
79222
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79223
|
-
*/
|
|
79224
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79225
|
-
/**
|
|
79226
|
-
* Inserts a paragraph at the specified location.
|
|
79227
|
-
*
|
|
79228
|
-
* @remarks
|
|
79229
|
-
* [Api set: WordApi 1.1]
|
|
79230
|
-
*
|
|
79231
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
79232
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79233
|
-
*/
|
|
79234
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
78894
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
79235
78895
|
/**
|
|
79236
78896
|
* Inserts a paragraph at the specified location.
|
|
79237
78897
|
*
|
|
@@ -79241,7 +78901,7 @@ declare namespace Word {
|
|
|
79241
78901
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
79242
78902
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79243
78903
|
*/
|
|
79244
|
-
insertParagraph(paragraphText: string, insertLocation:
|
|
78904
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
79245
78905
|
/**
|
|
79246
78906
|
* Inserts a table with the specified number of rows and columns.
|
|
79247
78907
|
*
|
|
@@ -79253,19 +78913,7 @@ declare namespace Word {
|
|
|
79253
78913
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79254
78914
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
79255
78915
|
*/
|
|
79256
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
79257
|
-
/**
|
|
79258
|
-
* Inserts a table with the specified number of rows and columns.
|
|
79259
|
-
*
|
|
79260
|
-
* @remarks
|
|
79261
|
-
* [Api set: WordApi 1.3]
|
|
79262
|
-
*
|
|
79263
|
-
* @param rowCount Required. The number of rows in the table.
|
|
79264
|
-
* @param columnCount Required. The number of columns in the table.
|
|
79265
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79266
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
79267
|
-
*/
|
|
79268
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
78916
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
79269
78917
|
/**
|
|
79270
78918
|
* Inserts text into the paragraph at the specified location.
|
|
79271
78919
|
*
|
|
@@ -79275,17 +78923,7 @@ declare namespace Word {
|
|
|
79275
78923
|
* @param text Required. Text to be inserted.
|
|
79276
78924
|
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79277
78925
|
*/
|
|
79278
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79279
|
-
/**
|
|
79280
|
-
* Inserts text into the paragraph at the specified location.
|
|
79281
|
-
*
|
|
79282
|
-
* @remarks
|
|
79283
|
-
* [Api set: WordApi 1.1]
|
|
79284
|
-
*
|
|
79285
|
-
* @param text Required. Text to be inserted.
|
|
79286
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
|
|
79287
|
-
*/
|
|
79288
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
78926
|
+
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
|
|
79289
78927
|
/**
|
|
79290
78928
|
* Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects.
|
|
79291
78929
|
*
|
|
@@ -79701,16 +79339,7 @@ declare namespace Word {
|
|
|
79701
79339
|
*
|
|
79702
79340
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
79703
79341
|
*/
|
|
79704
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
79705
|
-
/**
|
|
79706
|
-
* Clones the range, or gets the starting or ending point of the range as a new range.
|
|
79707
|
-
*
|
|
79708
|
-
* @remarks
|
|
79709
|
-
* [Api set: WordApi 1.3]
|
|
79710
|
-
*
|
|
79711
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'.
|
|
79712
|
-
*/
|
|
79713
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
79342
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
|
|
79714
79343
|
/**
|
|
79715
79344
|
* Gets reviewed text based on ChangeTrackingVersion selection.
|
|
79716
79345
|
*
|
|
@@ -79748,17 +79377,7 @@ declare namespace Word {
|
|
|
79748
79377
|
* @param breakType Required. The break type to add.
|
|
79749
79378
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79750
79379
|
*/
|
|
79751
|
-
insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;
|
|
79752
|
-
/**
|
|
79753
|
-
* Inserts a break at the specified location in the main document.
|
|
79754
|
-
*
|
|
79755
|
-
* @remarks
|
|
79756
|
-
* [Api set: WordApi 1.1]
|
|
79757
|
-
*
|
|
79758
|
-
* @param breakType Required. The break type to add.
|
|
79759
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79760
|
-
*/
|
|
79761
|
-
insertBreak(breakType: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;
|
|
79380
|
+
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
|
|
79762
79381
|
/**
|
|
79763
79382
|
* Insert a comment on the range.
|
|
79764
79383
|
*
|
|
@@ -79794,17 +79413,7 @@ declare namespace Word {
|
|
|
79794
79413
|
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
79795
79414
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79796
79415
|
*/
|
|
79797
|
-
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79798
|
-
/**
|
|
79799
|
-
* Inserts a document at the specified location.
|
|
79800
|
-
*
|
|
79801
|
-
* @remarks
|
|
79802
|
-
* [Api set: WordApi 1.1]
|
|
79803
|
-
*
|
|
79804
|
-
* @param base64File Required. The base64 encoded content of a .docx file.
|
|
79805
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79806
|
-
*/
|
|
79807
|
-
insertFileFromBase64(base64File: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79416
|
+
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
79808
79417
|
/**
|
|
79809
79418
|
* Inserts a footnote. The footnote reference is placed after the range.
|
|
79810
79419
|
*
|
|
@@ -79823,27 +79432,7 @@ declare namespace Word {
|
|
|
79823
79432
|
* @param html Required. The HTML to be inserted.
|
|
79824
79433
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79825
79434
|
*/
|
|
79826
|
-
insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79827
|
-
/**
|
|
79828
|
-
* Inserts HTML at the specified location.
|
|
79829
|
-
*
|
|
79830
|
-
* @remarks
|
|
79831
|
-
* [Api set: WordApi 1.1]
|
|
79832
|
-
*
|
|
79833
|
-
* @param html Required. The HTML to be inserted.
|
|
79834
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79835
|
-
*/
|
|
79836
|
-
insertHtml(html: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79837
|
-
/**
|
|
79838
|
-
* Inserts a picture at the specified location.
|
|
79839
|
-
*
|
|
79840
|
-
* @remarks
|
|
79841
|
-
* [Api set: WordApi 1.2]
|
|
79842
|
-
*
|
|
79843
|
-
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
79844
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79845
|
-
*/
|
|
79846
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;
|
|
79435
|
+
insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
79847
79436
|
/**
|
|
79848
79437
|
* Inserts a picture at the specified location.
|
|
79849
79438
|
*
|
|
@@ -79853,7 +79442,7 @@ declare namespace Word {
|
|
|
79853
79442
|
* @param base64EncodedImage Required. The base64 encoded image to be inserted.
|
|
79854
79443
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79855
79444
|
*/
|
|
79856
|
-
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation:
|
|
79445
|
+
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;
|
|
79857
79446
|
/**
|
|
79858
79447
|
* Inserts OOXML at the specified location.
|
|
79859
79448
|
*
|
|
@@ -79863,17 +79452,7 @@ declare namespace Word {
|
|
|
79863
79452
|
* @param ooxml Required. The OOXML to be inserted.
|
|
79864
79453
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79865
79454
|
*/
|
|
79866
|
-
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79867
|
-
/**
|
|
79868
|
-
* Inserts OOXML at the specified location.
|
|
79869
|
-
*
|
|
79870
|
-
* @remarks
|
|
79871
|
-
* [Api set: WordApi 1.1]
|
|
79872
|
-
*
|
|
79873
|
-
* @param ooxml Required. The OOXML to be inserted.
|
|
79874
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79875
|
-
*/
|
|
79876
|
-
insertOoxml(ooxml: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79455
|
+
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
79877
79456
|
/**
|
|
79878
79457
|
* Inserts a paragraph at the specified location.
|
|
79879
79458
|
*
|
|
@@ -79883,17 +79462,7 @@ declare namespace Word {
|
|
|
79883
79462
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
79884
79463
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79885
79464
|
*/
|
|
79886
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
79887
|
-
/**
|
|
79888
|
-
* Inserts a paragraph at the specified location.
|
|
79889
|
-
*
|
|
79890
|
-
* @remarks
|
|
79891
|
-
* [Api set: WordApi 1.1]
|
|
79892
|
-
*
|
|
79893
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
79894
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79895
|
-
*/
|
|
79896
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
79465
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
79897
79466
|
/**
|
|
79898
79467
|
* Inserts a table with the specified number of rows and columns.
|
|
79899
79468
|
*
|
|
@@ -79905,19 +79474,7 @@ declare namespace Word {
|
|
|
79905
79474
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79906
79475
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
79907
79476
|
*/
|
|
79908
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
79909
|
-
/**
|
|
79910
|
-
* Inserts a table with the specified number of rows and columns.
|
|
79911
|
-
*
|
|
79912
|
-
* @remarks
|
|
79913
|
-
* [Api set: WordApi 1.3]
|
|
79914
|
-
*
|
|
79915
|
-
* @param rowCount Required. The number of rows in the table.
|
|
79916
|
-
* @param columnCount Required. The number of columns in the table.
|
|
79917
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
79918
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
79919
|
-
*/
|
|
79920
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;
|
|
79477
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
79921
79478
|
/**
|
|
79922
79479
|
* Inserts text at the specified location.
|
|
79923
79480
|
*
|
|
@@ -79927,17 +79484,7 @@ declare namespace Word {
|
|
|
79927
79484
|
* @param text Required. Text to be inserted.
|
|
79928
79485
|
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79929
79486
|
*/
|
|
79930
|
-
insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;
|
|
79931
|
-
/**
|
|
79932
|
-
* Inserts text at the specified location.
|
|
79933
|
-
*
|
|
79934
|
-
* @remarks
|
|
79935
|
-
* [Api set: WordApi 1.1]
|
|
79936
|
-
*
|
|
79937
|
-
* @param text Required. Text to be inserted.
|
|
79938
|
-
* @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
|
|
79939
|
-
*/
|
|
79940
|
-
insertText(text: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;
|
|
79487
|
+
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
|
|
79941
79488
|
/**
|
|
79942
79489
|
* Returns a new range as the intersection of this range with another range. This range is not changed. Throws an error if the two ranges are not overlapped or adjacent.
|
|
79943
79490
|
*
|
|
@@ -80591,18 +80138,7 @@ declare namespace Word {
|
|
|
80591
80138
|
* @param columnCount Required. Number of columns to add.
|
|
80592
80139
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80593
80140
|
*/
|
|
80594
|
-
addColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
|
|
80595
|
-
/**
|
|
80596
|
-
* Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows.
|
|
80597
|
-
*
|
|
80598
|
-
* @remarks
|
|
80599
|
-
* [Api set: WordApi 1.3]
|
|
80600
|
-
*
|
|
80601
|
-
* @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table.
|
|
80602
|
-
* @param columnCount Required. Number of columns to add.
|
|
80603
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80604
|
-
*/
|
|
80605
|
-
addColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
|
|
80141
|
+
addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;
|
|
80606
80142
|
/**
|
|
80607
80143
|
* Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
80608
80144
|
*
|
|
@@ -80613,18 +80149,7 @@ declare namespace Word {
|
|
|
80613
80149
|
* @param rowCount Required. Number of rows to add.
|
|
80614
80150
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80615
80151
|
*/
|
|
80616
|
-
addRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
80617
|
-
/**
|
|
80618
|
-
* Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
80619
|
-
*
|
|
80620
|
-
* @remarks
|
|
80621
|
-
* [Api set: WordApi 1.3]
|
|
80622
|
-
*
|
|
80623
|
-
* @param insertLocation Required. It must be 'Start' or 'End'.
|
|
80624
|
-
* @param rowCount Required. Number of rows to add.
|
|
80625
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80626
|
-
*/
|
|
80627
|
-
addRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
80152
|
+
addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
80628
80153
|
/**
|
|
80629
80154
|
* Autofits the table columns to the width of the window.
|
|
80630
80155
|
*
|
|
@@ -80779,16 +80304,7 @@ declare namespace Word {
|
|
|
80779
80304
|
*
|
|
80780
80305
|
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
|
|
80781
80306
|
*/
|
|
80782
|
-
getRange(rangeLocation?: Word.RangeLocation): Word.Range;
|
|
80783
|
-
/**
|
|
80784
|
-
* Gets the range that contains this table, or the range at the start or end of the table.
|
|
80785
|
-
*
|
|
80786
|
-
* @remarks
|
|
80787
|
-
* [Api set: WordApi 1.3]
|
|
80788
|
-
*
|
|
80789
|
-
* @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'.
|
|
80790
|
-
*/
|
|
80791
|
-
getRange(rangeLocation?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;
|
|
80307
|
+
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;
|
|
80792
80308
|
/**
|
|
80793
80309
|
* Inserts a content control on the table.
|
|
80794
80310
|
*
|
|
@@ -80805,29 +80321,7 @@ declare namespace Word {
|
|
|
80805
80321
|
* @param paragraphText Required. The paragraph text to be inserted.
|
|
80806
80322
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
80807
80323
|
*/
|
|
80808
|
-
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;
|
|
80809
|
-
/**
|
|
80810
|
-
* Inserts a paragraph at the specified location.
|
|
80811
|
-
*
|
|
80812
|
-
* @remarks
|
|
80813
|
-
* [Api set: WordApi 1.3]
|
|
80814
|
-
*
|
|
80815
|
-
* @param paragraphText Required. The paragraph text to be inserted.
|
|
80816
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
80817
|
-
*/
|
|
80818
|
-
insertParagraph(paragraphText: string, insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;
|
|
80819
|
-
/**
|
|
80820
|
-
* Inserts a table with the specified number of rows and columns.
|
|
80821
|
-
*
|
|
80822
|
-
* @remarks
|
|
80823
|
-
* [Api set: WordApi 1.3]
|
|
80824
|
-
*
|
|
80825
|
-
* @param rowCount Required. The number of rows in the table.
|
|
80826
|
-
* @param columnCount Required. The number of columns in the table.
|
|
80827
|
-
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
80828
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80829
|
-
*/
|
|
80830
|
-
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;
|
|
80324
|
+
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
|
|
80831
80325
|
/**
|
|
80832
80326
|
* Inserts a table with the specified number of rows and columns.
|
|
80833
80327
|
*
|
|
@@ -80839,7 +80333,7 @@ declare namespace Word {
|
|
|
80839
80333
|
* @param insertLocation Required. The value must be 'Before' or 'After'.
|
|
80840
80334
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
80841
80335
|
*/
|
|
80842
|
-
insertTable(rowCount: number, columnCount: number, insertLocation:
|
|
80336
|
+
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
|
|
80843
80337
|
/**
|
|
80844
80338
|
* Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects.
|
|
80845
80339
|
*
|
|
@@ -81170,18 +80664,7 @@ declare namespace Word {
|
|
|
81170
80664
|
* @param rowCount Required. Number of rows to add
|
|
81171
80665
|
* @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
|
|
81172
80666
|
*/
|
|
81173
|
-
insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
81174
|
-
/**
|
|
81175
|
-
* Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
|
|
81176
|
-
*
|
|
81177
|
-
* @remarks
|
|
81178
|
-
* [Api set: WordApi 1.3]
|
|
81179
|
-
*
|
|
81180
|
-
* @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'.
|
|
81181
|
-
* @param rowCount Required. Number of rows to add
|
|
81182
|
-
* @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row.
|
|
81183
|
-
*/
|
|
81184
|
-
insertRows(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
80667
|
+
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
81185
80668
|
/**
|
|
81186
80669
|
* Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects.
|
|
81187
80670
|
*
|
|
@@ -81498,29 +80981,7 @@ declare namespace Word {
|
|
|
81498
80981
|
* @param columnCount Required. Number of columns to add.
|
|
81499
80982
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
81500
80983
|
*/
|
|
81501
|
-
insertColumns(insertLocation: Word.InsertLocation, columnCount: number, values?: string[][]): void;
|
|
81502
|
-
/**
|
|
81503
|
-
* Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows.
|
|
81504
|
-
*
|
|
81505
|
-
* @remarks
|
|
81506
|
-
* [Api set: WordApi 1.3]
|
|
81507
|
-
*
|
|
81508
|
-
* @param insertLocation Required. It must be 'Before' or 'After'.
|
|
81509
|
-
* @param columnCount Required. Number of columns to add.
|
|
81510
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
81511
|
-
*/
|
|
81512
|
-
insertColumns(insertLocation: "Before" | "After" | "Start" | "End" | "Replace", columnCount: number, values?: string[][]): void;
|
|
81513
|
-
/**
|
|
81514
|
-
* Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
81515
|
-
*
|
|
81516
|
-
* @remarks
|
|
81517
|
-
* [Api set: WordApi 1.3]
|
|
81518
|
-
*
|
|
81519
|
-
* @param insertLocation Required. It must be 'Before' or 'After'.
|
|
81520
|
-
* @param rowCount Required. Number of rows to add.
|
|
81521
|
-
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
81522
|
-
*/
|
|
81523
|
-
insertRows(insertLocation: Word.InsertLocation, rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
80984
|
+
insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;
|
|
81524
80985
|
/**
|
|
81525
80986
|
* Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows.
|
|
81526
80987
|
*
|
|
@@ -81531,7 +80992,7 @@ declare namespace Word {
|
|
|
81531
80992
|
* @param rowCount Required. Number of rows to add.
|
|
81532
80993
|
* @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
|
|
81533
80994
|
*/
|
|
81534
|
-
insertRows(insertLocation:
|
|
80995
|
+
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
|
|
81535
80996
|
/**
|
|
81536
80997
|
* Sets cell padding in points.
|
|
81537
80998
|
*
|