@types/office-js 1.0.410 → 1.0.412
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 +175 -123
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Mon, 12 Aug 2024 18:39:04 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -12588,18 +12588,6 @@ declare namespace Office {
|
|
|
12588
12588
|
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}. To learn more
|
|
12589
12589
|
* about append-on-send and its configuration, see
|
|
12590
12590
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12591
|
-
*
|
|
12592
|
-
* **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
|
|
12593
|
-
* is implemented with append-on-send, the following apply.
|
|
12594
|
-
*
|
|
12595
|
-
* - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12596
|
-
*
|
|
12597
|
-
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12598
|
-
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12599
|
-
*
|
|
12600
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
12601
|
-
*
|
|
12602
|
-
* **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12603
12591
|
*
|
|
12604
12592
|
* @remarks
|
|
12605
12593
|
* [Api set: Mailbox 1.9]
|
|
@@ -12608,6 +12596,22 @@ declare namespace Office {
|
|
|
12608
12596
|
*
|
|
12609
12597
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12610
12598
|
*
|
|
12599
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12600
|
+
*
|
|
12601
|
+
* **Important**:
|
|
12602
|
+
*
|
|
12603
|
+
* - If the user is running add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}
|
|
12604
|
+
* using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12605
|
+
*
|
|
12606
|
+
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12607
|
+
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12608
|
+
*
|
|
12609
|
+
* - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12610
|
+
*
|
|
12611
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12612
|
+
*
|
|
12613
|
+
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12614
|
+
*
|
|
12611
12615
|
* **Errors**:
|
|
12612
12616
|
*
|
|
12613
12617
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12628,18 +12632,6 @@ declare namespace Office {
|
|
|
12628
12632
|
* To use `appendOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. See {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}. To learn more
|
|
12629
12633
|
* about append-on-send and its configuration, see
|
|
12630
12634
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12631
|
-
*
|
|
12632
|
-
* **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
|
|
12633
|
-
* is implemented with append-on-send, the following apply.
|
|
12634
|
-
*
|
|
12635
|
-
* - If the user is running add-ins that implement the on-send feature using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12636
|
-
*
|
|
12637
|
-
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12638
|
-
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12639
|
-
*
|
|
12640
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
12641
|
-
*
|
|
12642
|
-
* **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12643
12635
|
*
|
|
12644
12636
|
* @remarks
|
|
12645
12637
|
* [Api set: Mailbox 1.9]
|
|
@@ -12648,6 +12640,22 @@ declare namespace Office {
|
|
|
12648
12640
|
*
|
|
12649
12641
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12650
12642
|
*
|
|
12643
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12644
|
+
*
|
|
12645
|
+
* **Important**:
|
|
12646
|
+
*
|
|
12647
|
+
* - If the user is running add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}
|
|
12648
|
+
* using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12649
|
+
*
|
|
12650
|
+
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12651
|
+
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12652
|
+
*
|
|
12653
|
+
* - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12654
|
+
*
|
|
12655
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12656
|
+
*
|
|
12657
|
+
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12658
|
+
*
|
|
12651
12659
|
* **Errors**:
|
|
12652
12660
|
*
|
|
12653
12661
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12753,6 +12761,8 @@ declare namespace Office {
|
|
|
12753
12761
|
*
|
|
12754
12762
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12755
12763
|
*
|
|
12764
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12765
|
+
*
|
|
12756
12766
|
* **Important**:
|
|
12757
12767
|
*
|
|
12758
12768
|
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
@@ -12772,7 +12782,9 @@ declare namespace Office {
|
|
|
12772
12782
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12773
12783
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12774
12784
|
*
|
|
12775
|
-
*
|
|
12785
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12786
|
+
*
|
|
12787
|
+
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12776
12788
|
*
|
|
12777
12789
|
* **Errors**:
|
|
12778
12790
|
*
|
|
@@ -12796,6 +12808,8 @@ declare namespace Office {
|
|
|
12796
12808
|
*
|
|
12797
12809
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12798
12810
|
*
|
|
12811
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12812
|
+
*
|
|
12799
12813
|
* **Important**:
|
|
12800
12814
|
*
|
|
12801
12815
|
* - After the content is prepended, the position of the cursor depends on which client the add-in is running. In Outlook on the web and on Windows
|
|
@@ -12815,7 +12829,9 @@ declare namespace Office {
|
|
|
12815
12829
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12816
12830
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12817
12831
|
*
|
|
12818
|
-
*
|
|
12832
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12833
|
+
*
|
|
12834
|
+
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12819
12835
|
*
|
|
12820
12836
|
* **Errors**:
|
|
12821
12837
|
*
|
|
@@ -12828,37 +12844,41 @@ declare namespace Office {
|
|
|
12828
12844
|
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12829
12845
|
/**
|
|
12830
12846
|
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12831
|
-
*
|
|
12847
|
+
*
|
|
12832
12848
|
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12833
12849
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12834
|
-
*
|
|
12850
|
+
*
|
|
12835
12851
|
* @remarks
|
|
12836
12852
|
* [Api set: Mailbox 1.13]
|
|
12837
|
-
*
|
|
12853
|
+
*
|
|
12838
12854
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12839
12855
|
*
|
|
12840
12856
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12841
|
-
*
|
|
12857
|
+
*
|
|
12842
12858
|
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12843
|
-
*
|
|
12859
|
+
*
|
|
12844
12860
|
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12845
|
-
*
|
|
12861
|
+
*
|
|
12846
12862
|
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
|
|
12847
12863
|
* the prepend-on-send feature runs first.
|
|
12848
|
-
*
|
|
12864
|
+
*
|
|
12849
12865
|
* - A new line is added after the prepended content.
|
|
12850
|
-
*
|
|
12866
|
+
*
|
|
12851
12867
|
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12852
12868
|
* The content of the last run add-in appears above previously prepended content.
|
|
12853
|
-
*
|
|
12869
|
+
*
|
|
12854
12870
|
* - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
|
|
12855
|
-
*
|
|
12871
|
+
*
|
|
12872
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12873
|
+
*
|
|
12874
|
+
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12875
|
+
*
|
|
12856
12876
|
* **Errors**:
|
|
12857
|
-
*
|
|
12877
|
+
*
|
|
12858
12878
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12859
|
-
*
|
|
12879
|
+
*
|
|
12860
12880
|
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12861
|
-
*
|
|
12881
|
+
*
|
|
12862
12882
|
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12863
12883
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
12864
12884
|
* `asyncContext`: Any object that can be accessed in the callback function.
|
|
@@ -12869,37 +12889,41 @@ declare namespace Office {
|
|
|
12869
12889
|
prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12870
12890
|
/**
|
|
12871
12891
|
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12872
|
-
*
|
|
12892
|
+
*
|
|
12873
12893
|
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12874
12894
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12875
|
-
*
|
|
12895
|
+
*
|
|
12876
12896
|
* @remarks
|
|
12877
12897
|
* [Api set: Mailbox 1.13]
|
|
12878
|
-
*
|
|
12898
|
+
*
|
|
12879
12899
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12880
12900
|
*
|
|
12881
12901
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12882
|
-
*
|
|
12902
|
+
*
|
|
12883
12903
|
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12884
|
-
*
|
|
12904
|
+
*
|
|
12885
12905
|
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12886
|
-
*
|
|
12906
|
+
*
|
|
12887
12907
|
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
|
|
12888
12908
|
* the prepend-on-send feature runs first.
|
|
12889
|
-
*
|
|
12909
|
+
*
|
|
12890
12910
|
* - A new line is added after the prepended content.
|
|
12891
|
-
*
|
|
12911
|
+
*
|
|
12892
12912
|
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12893
12913
|
* The content of the last run add-in appears above previously prepended content.
|
|
12894
|
-
*
|
|
12914
|
+
*
|
|
12895
12915
|
* - If the add-in attempts to insert HTML into a plain text body, the content won't be prepended. Conversely, plain text will be inserted into an HTML body.
|
|
12896
|
-
*
|
|
12916
|
+
*
|
|
12917
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12918
|
+
*
|
|
12919
|
+
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12920
|
+
*
|
|
12897
12921
|
* **Errors**:
|
|
12898
|
-
*
|
|
12922
|
+
*
|
|
12899
12923
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12900
|
-
*
|
|
12924
|
+
*
|
|
12901
12925
|
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12902
|
-
*
|
|
12926
|
+
*
|
|
12903
12927
|
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12904
12928
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12905
12929
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -12915,6 +12939,8 @@ declare namespace Office {
|
|
|
12915
12939
|
*
|
|
12916
12940
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12917
12941
|
*
|
|
12942
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12943
|
+
*
|
|
12918
12944
|
* **Important**:
|
|
12919
12945
|
*
|
|
12920
12946
|
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
@@ -12936,7 +12962,9 @@ declare namespace Office {
|
|
|
12936
12962
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12937
12963
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12938
12964
|
*
|
|
12939
|
-
*
|
|
12965
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12966
|
+
*
|
|
12967
|
+
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12940
12968
|
*
|
|
12941
12969
|
* **Errors**:
|
|
12942
12970
|
*
|
|
@@ -12962,6 +12990,8 @@ declare namespace Office {
|
|
|
12962
12990
|
*
|
|
12963
12991
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12964
12992
|
*
|
|
12993
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12994
|
+
*
|
|
12965
12995
|
* **Important**:
|
|
12966
12996
|
*
|
|
12967
12997
|
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
@@ -12983,7 +13013,9 @@ declare namespace Office {
|
|
|
12983
13013
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12984
13014
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12985
13015
|
*
|
|
12986
|
-
*
|
|
13016
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13017
|
+
*
|
|
13018
|
+
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12987
13019
|
*
|
|
12988
13020
|
* **Errors**:
|
|
12989
13021
|
*
|
|
@@ -13003,11 +13035,6 @@ declare namespace Office {
|
|
|
13003
13035
|
* the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the
|
|
13004
13036
|
* UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content.
|
|
13005
13037
|
*
|
|
13006
|
-
* When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13007
|
-
* (see the **Examples** section for a sample).
|
|
13008
|
-
*
|
|
13009
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13010
|
-
*
|
|
13011
13038
|
* @remarks
|
|
13012
13039
|
* [Api set: Mailbox 1.1]
|
|
13013
13040
|
*
|
|
@@ -13015,6 +13042,17 @@ declare namespace Office {
|
|
|
13015
13042
|
*
|
|
13016
13043
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13017
13044
|
*
|
|
13045
|
+
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13046
|
+
*
|
|
13047
|
+
* **Important*:
|
|
13048
|
+
*
|
|
13049
|
+
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13050
|
+
* (see the **Examples** section for a sample).
|
|
13051
|
+
*
|
|
13052
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13053
|
+
*
|
|
13054
|
+
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13055
|
+
*
|
|
13018
13056
|
* **Errors**:
|
|
13019
13057
|
*
|
|
13020
13058
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13036,11 +13074,6 @@ declare namespace Office {
|
|
|
13036
13074
|
* the editor, it replaces the selected text. If the cursor was never in the body of the item, or if the body of the item lost focus in the
|
|
13037
13075
|
* UI, the string will be inserted at the top of the body content. After insertion, the cursor is placed at the end of the inserted content.
|
|
13038
13076
|
*
|
|
13039
|
-
* When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13040
|
-
* (see the **Examples** section for a sample).
|
|
13041
|
-
*
|
|
13042
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13043
|
-
*
|
|
13044
13077
|
* @remarks
|
|
13045
13078
|
* [Api set: Mailbox 1.1]
|
|
13046
13079
|
*
|
|
@@ -13048,6 +13081,17 @@ declare namespace Office {
|
|
|
13048
13081
|
*
|
|
13049
13082
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13050
13083
|
*
|
|
13084
|
+
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13085
|
+
*
|
|
13086
|
+
* **Important*:
|
|
13087
|
+
*
|
|
13088
|
+
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13089
|
+
* (see the **Examples** section for a sample).
|
|
13090
|
+
*
|
|
13091
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13092
|
+
*
|
|
13093
|
+
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13094
|
+
*
|
|
13051
13095
|
* **Errors**:
|
|
13052
13096
|
*
|
|
13053
13097
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13084,6 +13128,10 @@ declare namespace Office {
|
|
|
13084
13128
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
13085
13129
|
* if the user closes the form without making other edits, they won't be prompted to save changes.
|
|
13086
13130
|
*
|
|
13131
|
+
* - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
|
|
13132
|
+
*
|
|
13133
|
+
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13134
|
+
*
|
|
13087
13135
|
* **Errors**:
|
|
13088
13136
|
*
|
|
13089
13137
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13124,6 +13172,10 @@ declare namespace Office {
|
|
|
13124
13172
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
13125
13173
|
* if the user closes the form without making other edits, they won't be prompted to save changes.
|
|
13126
13174
|
*
|
|
13175
|
+
* - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
|
|
13176
|
+
*
|
|
13177
|
+
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13178
|
+
*
|
|
13127
13179
|
* **Errors**:
|
|
13128
13180
|
*
|
|
13129
13181
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -114406,12 +114458,12 @@ declare namespace PowerPoint {
|
|
|
114406
114458
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
114407
114459
|
context: RequestContext;
|
|
114408
114460
|
/**
|
|
114409
|
-
* Create a new instance of PowerPoint.Application object
|
|
114461
|
+
* Create a new instance of the `PowerPoint.Application` object.
|
|
114410
114462
|
*/
|
|
114411
114463
|
static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application;
|
|
114412
114464
|
/**
|
|
114413
114465
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
114414
|
-
* Whereas the original PowerPoint.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114466
|
+
* Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114415
114467
|
*/
|
|
114416
114468
|
toJSON(): {
|
|
114417
114469
|
[key: string]: string;
|
|
@@ -114528,7 +114580,7 @@ declare namespace PowerPoint {
|
|
|
114528
114580
|
}): PowerPoint.Presentation;
|
|
114529
114581
|
/**
|
|
114530
114582
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
114531
|
-
* Whereas the original PowerPoint.Presentation object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114583
|
+
* Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object.
|
|
114532
114584
|
*/
|
|
114533
114585
|
toJSON(): PowerPoint.Interfaces.PresentationData;
|
|
114534
114586
|
}
|
|
@@ -116164,7 +116216,7 @@ declare namespace PowerPoint {
|
|
|
116164
116216
|
}): PowerPoint.SlideLayout;
|
|
116165
116217
|
/**
|
|
116166
116218
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116167
|
-
* Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116219
|
+
* Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116168
116220
|
*/
|
|
116169
116221
|
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
116170
116222
|
}
|
|
@@ -116302,7 +116354,7 @@ declare namespace PowerPoint {
|
|
|
116302
116354
|
}): PowerPoint.SlideMaster;
|
|
116303
116355
|
/**
|
|
116304
116356
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116305
|
-
* Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116357
|
+
* Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116306
116358
|
*/
|
|
116307
116359
|
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
116308
116360
|
}
|
|
@@ -116352,7 +116404,7 @@ declare namespace PowerPoint {
|
|
|
116352
116404
|
}): PowerPoint.Tag;
|
|
116353
116405
|
/**
|
|
116354
116406
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116355
|
-
* Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116407
|
+
* Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116356
116408
|
*/
|
|
116357
116409
|
toJSON(): PowerPoint.Interfaces.TagData;
|
|
116358
116410
|
}
|
|
@@ -116368,22 +116420,22 @@ declare namespace PowerPoint {
|
|
|
116368
116420
|
/** Gets the loaded child items in this collection. */
|
|
116369
116421
|
readonly items: PowerPoint.Tag[];
|
|
116370
116422
|
/**
|
|
116371
|
-
* Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given `value`.
|
|
116423
|
+
* Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
|
|
116372
116424
|
*
|
|
116373
116425
|
* @remarks
|
|
116374
116426
|
* [Api set: PowerPointApi 1.3]
|
|
116375
116427
|
*
|
|
116376
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
116428
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
|
|
116377
116429
|
* @param value The value of the tag.
|
|
116378
116430
|
*/
|
|
116379
116431
|
add(key: string, value: string): void;
|
|
116380
116432
|
/**
|
|
116381
|
-
* Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
|
|
116433
|
+
* Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
|
|
116382
116434
|
*
|
|
116383
116435
|
* @remarks
|
|
116384
116436
|
* [Api set: PowerPointApi 1.3]
|
|
116385
116437
|
*
|
|
116386
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
116438
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
|
|
116387
116439
|
*/
|
|
116388
116440
|
delete(key: string): void;
|
|
116389
116441
|
/**
|
|
@@ -116400,7 +116452,7 @@ declare namespace PowerPoint {
|
|
|
116400
116452
|
* @remarks
|
|
116401
116453
|
* [Api set: PowerPointApi 1.3]
|
|
116402
116454
|
*
|
|
116403
|
-
* @param key The ID of the tag.
|
|
116455
|
+
* @param key The ID of the tag.
|
|
116404
116456
|
* @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
|
|
116405
116457
|
*/
|
|
116406
116458
|
getItem(key: string): PowerPoint.Tag;
|
|
@@ -116420,7 +116472,7 @@ declare namespace PowerPoint {
|
|
|
116420
116472
|
* @remarks
|
|
116421
116473
|
* [Api set: PowerPointApi 1.3]
|
|
116422
116474
|
*
|
|
116423
|
-
* @param key The ID of the tag.
|
|
116475
|
+
* @param key The ID of the tag.
|
|
116424
116476
|
* @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
|
|
116425
116477
|
*/
|
|
116426
116478
|
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
@@ -116531,7 +116583,7 @@ declare namespace PowerPoint {
|
|
|
116531
116583
|
}): PowerPoint.Slide;
|
|
116532
116584
|
/**
|
|
116533
116585
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116534
|
-
* Whereas the original PowerPoint.Slide object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116586
|
+
* Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116535
116587
|
*/
|
|
116536
116588
|
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
116537
116589
|
}
|
|
@@ -116648,7 +116700,7 @@ declare namespace PowerPoint {
|
|
|
116648
116700
|
}): PowerPoint.ShapeFill;
|
|
116649
116701
|
/**
|
|
116650
116702
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116651
|
-
* Whereas the original PowerPoint.ShapeFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116703
|
+
* Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116652
116704
|
*/
|
|
116653
116705
|
toJSON(): PowerPoint.Interfaces.ShapeFillData;
|
|
116654
116706
|
}
|
|
@@ -116764,7 +116816,7 @@ declare namespace PowerPoint {
|
|
|
116764
116816
|
}): PowerPoint.ShapeLineFormat;
|
|
116765
116817
|
/**
|
|
116766
116818
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116767
|
-
* Whereas the original PowerPoint.ShapeLineFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116819
|
+
* Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116768
116820
|
*/
|
|
116769
116821
|
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
|
|
116770
116822
|
}
|
|
@@ -116883,7 +116935,7 @@ declare namespace PowerPoint {
|
|
|
116883
116935
|
}): PowerPoint.BulletFormat;
|
|
116884
116936
|
/**
|
|
116885
116937
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116886
|
-
* Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116938
|
+
* Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116887
116939
|
*/
|
|
116888
116940
|
toJSON(): PowerPoint.Interfaces.BulletFormatData;
|
|
116889
116941
|
}
|
|
@@ -116933,7 +116985,7 @@ declare namespace PowerPoint {
|
|
|
116933
116985
|
}): PowerPoint.ParagraphFormat;
|
|
116934
116986
|
/**
|
|
116935
116987
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
116936
|
-
* Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116988
|
+
* Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
116937
116989
|
*/
|
|
116938
116990
|
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
|
|
116939
116991
|
}
|
|
@@ -117011,7 +117063,7 @@ declare namespace PowerPoint {
|
|
|
117011
117063
|
}): PowerPoint.ShapeFont;
|
|
117012
117064
|
/**
|
|
117013
117065
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
117014
|
-
* Whereas the original PowerPoint.ShapeFont object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117066
|
+
* Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117015
117067
|
*/
|
|
117016
117068
|
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
117017
117069
|
}
|
|
@@ -117108,7 +117160,7 @@ declare namespace PowerPoint {
|
|
|
117108
117160
|
}): PowerPoint.TextRange;
|
|
117109
117161
|
/**
|
|
117110
117162
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
117111
|
-
* Whereas the original PowerPoint.TextRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117163
|
+
* Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117112
117164
|
*/
|
|
117113
117165
|
toJSON(): PowerPoint.Interfaces.TextRangeData;
|
|
117114
117166
|
}
|
|
@@ -117221,7 +117273,7 @@ declare namespace PowerPoint {
|
|
|
117221
117273
|
}): PowerPoint.TextFrame;
|
|
117222
117274
|
/**
|
|
117223
117275
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
117224
|
-
* Whereas the original PowerPoint.TextFrame object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117276
|
+
* Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117225
117277
|
*/
|
|
117226
117278
|
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
117227
117279
|
}
|
|
@@ -117383,7 +117435,7 @@ declare namespace PowerPoint {
|
|
|
117383
117435
|
}): PowerPoint.Shape;
|
|
117384
117436
|
/**
|
|
117385
117437
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
117386
|
-
* Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117438
|
+
* Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117387
117439
|
*/
|
|
117388
117440
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
117389
117441
|
}
|
|
@@ -117766,15 +117818,15 @@ declare namespace PowerPoint {
|
|
|
117766
117818
|
*/
|
|
117767
117819
|
$skip?: number;
|
|
117768
117820
|
}
|
|
117769
|
-
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
117821
|
+
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
117770
117822
|
interface ShapeCollectionUpdateData {
|
|
117771
117823
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
117772
117824
|
}
|
|
117773
|
-
/** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
117825
|
+
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
117774
117826
|
interface SlideLayoutCollectionUpdateData {
|
|
117775
117827
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
117776
117828
|
}
|
|
117777
|
-
/** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
|
|
117829
|
+
/** An interface for updating data on the `Tag` object, for use in `tag.set({ ... })`. */
|
|
117778
117830
|
interface TagUpdateData {
|
|
117779
117831
|
/**
|
|
117780
117832
|
* Gets the value of the tag.
|
|
@@ -117784,11 +117836,11 @@ declare namespace PowerPoint {
|
|
|
117784
117836
|
*/
|
|
117785
117837
|
value?: string;
|
|
117786
117838
|
}
|
|
117787
|
-
/** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
|
|
117839
|
+
/** An interface for updating data on the `TagCollection` object, for use in `tagCollection.set({ ... })`. */
|
|
117788
117840
|
interface TagCollectionUpdateData {
|
|
117789
117841
|
items?: PowerPoint.Interfaces.TagData[];
|
|
117790
117842
|
}
|
|
117791
|
-
/** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */
|
|
117843
|
+
/** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
|
|
117792
117844
|
interface ShapeFillUpdateData {
|
|
117793
117845
|
/**
|
|
117794
117846
|
* Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
@@ -117805,7 +117857,7 @@ declare namespace PowerPoint {
|
|
|
117805
117857
|
*/
|
|
117806
117858
|
transparency?: number;
|
|
117807
117859
|
}
|
|
117808
|
-
/** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */
|
|
117860
|
+
/** An interface for updating data on the `ShapeLineFormat` object, for use in `shapeLineFormat.set({ ... })`. */
|
|
117809
117861
|
interface ShapeLineFormatUpdateData {
|
|
117810
117862
|
/**
|
|
117811
117863
|
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
@@ -117850,7 +117902,7 @@ declare namespace PowerPoint {
|
|
|
117850
117902
|
*/
|
|
117851
117903
|
weight?: number;
|
|
117852
117904
|
}
|
|
117853
|
-
/** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
|
|
117905
|
+
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
|
|
117854
117906
|
interface BulletFormatUpdateData {
|
|
117855
117907
|
/**
|
|
117856
117908
|
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
@@ -117860,7 +117912,7 @@ declare namespace PowerPoint {
|
|
|
117860
117912
|
*/
|
|
117861
117913
|
visible?: boolean;
|
|
117862
117914
|
}
|
|
117863
|
-
/** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
|
|
117915
|
+
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
|
|
117864
117916
|
interface ParagraphFormatUpdateData {
|
|
117865
117917
|
/**
|
|
117866
117918
|
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
@@ -117870,7 +117922,7 @@ declare namespace PowerPoint {
|
|
|
117870
117922
|
*/
|
|
117871
117923
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
117872
117924
|
}
|
|
117873
|
-
/** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
|
|
117925
|
+
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
|
|
117874
117926
|
interface ShapeFontUpdateData {
|
|
117875
117927
|
/**
|
|
117876
117928
|
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
@@ -117915,7 +117967,7 @@ declare namespace PowerPoint {
|
|
|
117915
117967
|
*/
|
|
117916
117968
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
|
|
117917
117969
|
}
|
|
117918
|
-
/** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
|
|
117970
|
+
/** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
|
|
117919
117971
|
interface TextRangeUpdateData {
|
|
117920
117972
|
/**
|
|
117921
117973
|
* Gets or sets the length of the range that this `TextRange` represents.
|
|
@@ -117941,7 +117993,7 @@ declare namespace PowerPoint {
|
|
|
117941
117993
|
*/
|
|
117942
117994
|
text?: string;
|
|
117943
117995
|
}
|
|
117944
|
-
/** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */
|
|
117996
|
+
/** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */
|
|
117945
117997
|
interface TextFrameUpdateData {
|
|
117946
117998
|
/**
|
|
117947
117999
|
* The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
|
|
@@ -117993,7 +118045,7 @@ declare namespace PowerPoint {
|
|
|
117993
118045
|
*/
|
|
117994
118046
|
wordWrap?: boolean;
|
|
117995
118047
|
}
|
|
117996
|
-
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
118048
|
+
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
117997
118049
|
interface ShapeUpdateData {
|
|
117998
118050
|
/**
|
|
117999
118051
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
@@ -118031,19 +118083,19 @@ declare namespace PowerPoint {
|
|
|
118031
118083
|
*/
|
|
118032
118084
|
width?: number;
|
|
118033
118085
|
}
|
|
118034
|
-
/** An interface for updating data on the ShapeScopedCollection object, for use in `shapeScopedCollection.set({ ... })`. */
|
|
118086
|
+
/** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
|
|
118035
118087
|
interface ShapeScopedCollectionUpdateData {
|
|
118036
118088
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
118037
118089
|
}
|
|
118038
|
-
/** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
|
|
118090
|
+
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
|
|
118039
118091
|
interface SlideCollectionUpdateData {
|
|
118040
118092
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
118041
118093
|
}
|
|
118042
|
-
/** An interface for updating data on the SlideScopedCollection object, for use in `slideScopedCollection.set({ ... })`. */
|
|
118094
|
+
/** An interface for updating data on the `SlideScopedCollection` object, for use in `slideScopedCollection.set({ ... })`. */
|
|
118043
118095
|
interface SlideScopedCollectionUpdateData {
|
|
118044
118096
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
118045
118097
|
}
|
|
118046
|
-
/** An interface for updating data on the SlideMasterCollection object, for use in `slideMasterCollection.set({ ... })`. */
|
|
118098
|
+
/** An interface for updating data on the `SlideMasterCollection` object, for use in `slideMasterCollection.set({ ... })`. */
|
|
118047
118099
|
interface SlideMasterCollectionUpdateData {
|
|
118048
118100
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
118049
118101
|
}
|
|
@@ -118424,7 +118476,7 @@ declare namespace PowerPoint {
|
|
|
118424
118476
|
*/
|
|
118425
118477
|
interface PresentationLoadOptions {
|
|
118426
118478
|
/**
|
|
118427
|
-
Specifying `$all` for the
|
|
118479
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118428
118480
|
*/
|
|
118429
118481
|
$all?: boolean;
|
|
118430
118482
|
/**
|
|
@@ -118444,7 +118496,7 @@ declare namespace PowerPoint {
|
|
|
118444
118496
|
*/
|
|
118445
118497
|
interface ShapeCollectionLoadOptions {
|
|
118446
118498
|
/**
|
|
118447
|
-
Specifying `$all` for the
|
|
118499
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118448
118500
|
*/
|
|
118449
118501
|
$all?: boolean;
|
|
118450
118502
|
/**
|
|
@@ -118526,7 +118578,7 @@ declare namespace PowerPoint {
|
|
|
118526
118578
|
*/
|
|
118527
118579
|
interface SlideLayoutLoadOptions {
|
|
118528
118580
|
/**
|
|
118529
|
-
Specifying `$all` for the
|
|
118581
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118530
118582
|
*/
|
|
118531
118583
|
$all?: boolean;
|
|
118532
118584
|
/**
|
|
@@ -118552,7 +118604,7 @@ declare namespace PowerPoint {
|
|
|
118552
118604
|
*/
|
|
118553
118605
|
interface SlideLayoutCollectionLoadOptions {
|
|
118554
118606
|
/**
|
|
118555
|
-
Specifying `$all` for the
|
|
118607
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118556
118608
|
*/
|
|
118557
118609
|
$all?: boolean;
|
|
118558
118610
|
/**
|
|
@@ -118578,7 +118630,7 @@ declare namespace PowerPoint {
|
|
|
118578
118630
|
*/
|
|
118579
118631
|
interface SlideMasterLoadOptions {
|
|
118580
118632
|
/**
|
|
118581
|
-
Specifying `$all` for the
|
|
118633
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118582
118634
|
*/
|
|
118583
118635
|
$all?: boolean;
|
|
118584
118636
|
/**
|
|
@@ -118604,7 +118656,7 @@ declare namespace PowerPoint {
|
|
|
118604
118656
|
*/
|
|
118605
118657
|
interface TagLoadOptions {
|
|
118606
118658
|
/**
|
|
118607
|
-
Specifying `$all` for the
|
|
118659
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118608
118660
|
*/
|
|
118609
118661
|
$all?: boolean;
|
|
118610
118662
|
/**
|
|
@@ -118630,7 +118682,7 @@ declare namespace PowerPoint {
|
|
|
118630
118682
|
*/
|
|
118631
118683
|
interface TagCollectionLoadOptions {
|
|
118632
118684
|
/**
|
|
118633
|
-
Specifying `$all` for the
|
|
118685
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118634
118686
|
*/
|
|
118635
118687
|
$all?: boolean;
|
|
118636
118688
|
/**
|
|
@@ -118656,7 +118708,7 @@ declare namespace PowerPoint {
|
|
|
118656
118708
|
*/
|
|
118657
118709
|
interface SlideLoadOptions {
|
|
118658
118710
|
/**
|
|
118659
|
-
Specifying `$all` for the
|
|
118711
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118660
118712
|
*/
|
|
118661
118713
|
$all?: boolean;
|
|
118662
118714
|
/**
|
|
@@ -118689,7 +118741,7 @@ declare namespace PowerPoint {
|
|
|
118689
118741
|
*/
|
|
118690
118742
|
interface ShapeFillLoadOptions {
|
|
118691
118743
|
/**
|
|
118692
|
-
Specifying `$all` for the
|
|
118744
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118693
118745
|
*/
|
|
118694
118746
|
$all?: boolean;
|
|
118695
118747
|
/**
|
|
@@ -118722,7 +118774,7 @@ declare namespace PowerPoint {
|
|
|
118722
118774
|
*/
|
|
118723
118775
|
interface ShapeLineFormatLoadOptions {
|
|
118724
118776
|
/**
|
|
118725
|
-
Specifying `$all` for the
|
|
118777
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118726
118778
|
*/
|
|
118727
118779
|
$all?: boolean;
|
|
118728
118780
|
/**
|
|
@@ -118776,7 +118828,7 @@ declare namespace PowerPoint {
|
|
|
118776
118828
|
*/
|
|
118777
118829
|
interface BulletFormatLoadOptions {
|
|
118778
118830
|
/**
|
|
118779
|
-
Specifying `$all` for the
|
|
118831
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118780
118832
|
*/
|
|
118781
118833
|
$all?: boolean;
|
|
118782
118834
|
/**
|
|
@@ -118795,7 +118847,7 @@ declare namespace PowerPoint {
|
|
|
118795
118847
|
*/
|
|
118796
118848
|
interface ParagraphFormatLoadOptions {
|
|
118797
118849
|
/**
|
|
118798
|
-
Specifying `$all` for the
|
|
118850
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118799
118851
|
*/
|
|
118800
118852
|
$all?: boolean;
|
|
118801
118853
|
/**
|
|
@@ -118821,7 +118873,7 @@ declare namespace PowerPoint {
|
|
|
118821
118873
|
*/
|
|
118822
118874
|
interface ShapeFontLoadOptions {
|
|
118823
118875
|
/**
|
|
118824
|
-
Specifying `$all` for the
|
|
118876
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118825
118877
|
*/
|
|
118826
118878
|
$all?: boolean;
|
|
118827
118879
|
/**
|
|
@@ -118875,7 +118927,7 @@ declare namespace PowerPoint {
|
|
|
118875
118927
|
*/
|
|
118876
118928
|
interface TextRangeLoadOptions {
|
|
118877
118929
|
/**
|
|
118878
|
-
Specifying `$all` for the
|
|
118930
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118879
118931
|
*/
|
|
118880
118932
|
$all?: boolean;
|
|
118881
118933
|
/**
|
|
@@ -118924,7 +118976,7 @@ declare namespace PowerPoint {
|
|
|
118924
118976
|
*/
|
|
118925
118977
|
interface TextFrameLoadOptions {
|
|
118926
118978
|
/**
|
|
118927
|
-
Specifying `$all` for the
|
|
118979
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
118928
118980
|
*/
|
|
118929
118981
|
$all?: boolean;
|
|
118930
118982
|
/**
|
|
@@ -118999,7 +119051,7 @@ declare namespace PowerPoint {
|
|
|
118999
119051
|
*/
|
|
119000
119052
|
interface ShapeLoadOptions {
|
|
119001
119053
|
/**
|
|
119002
|
-
Specifying `$all` for the
|
|
119054
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119003
119055
|
*/
|
|
119004
119056
|
$all?: boolean;
|
|
119005
119057
|
/**
|
|
@@ -119077,11 +119129,11 @@ declare namespace PowerPoint {
|
|
|
119077
119129
|
* Represents a collection of shapes.
|
|
119078
119130
|
*
|
|
119079
119131
|
* @remarks
|
|
119080
|
-
* [Api set: PowerPointApi 1.
|
|
119132
|
+
* [Api set: PowerPointApi 1.5]
|
|
119081
119133
|
*/
|
|
119082
119134
|
interface ShapeScopedCollectionLoadOptions {
|
|
119083
119135
|
/**
|
|
119084
|
-
Specifying `$all` for the
|
|
119136
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119085
119137
|
*/
|
|
119086
119138
|
$all?: boolean;
|
|
119087
119139
|
/**
|
|
@@ -119163,7 +119215,7 @@ declare namespace PowerPoint {
|
|
|
119163
119215
|
*/
|
|
119164
119216
|
interface SlideCollectionLoadOptions {
|
|
119165
119217
|
/**
|
|
119166
|
-
Specifying `$all` for the
|
|
119218
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119167
119219
|
*/
|
|
119168
119220
|
$all?: boolean;
|
|
119169
119221
|
/**
|
|
@@ -119192,11 +119244,11 @@ declare namespace PowerPoint {
|
|
|
119192
119244
|
* Represents a collection of slides in the presentation.
|
|
119193
119245
|
*
|
|
119194
119246
|
* @remarks
|
|
119195
|
-
* [Api set: PowerPointApi 1.
|
|
119247
|
+
* [Api set: PowerPointApi 1.5]
|
|
119196
119248
|
*/
|
|
119197
119249
|
interface SlideScopedCollectionLoadOptions {
|
|
119198
119250
|
/**
|
|
119199
|
-
Specifying `$all` for the
|
|
119251
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119200
119252
|
*/
|
|
119201
119253
|
$all?: boolean;
|
|
119202
119254
|
/**
|
|
@@ -119229,7 +119281,7 @@ declare namespace PowerPoint {
|
|
|
119229
119281
|
*/
|
|
119230
119282
|
interface SlideMasterCollectionLoadOptions {
|
|
119231
119283
|
/**
|
|
119232
|
-
Specifying `$all` for the
|
|
119284
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
119233
119285
|
*/
|
|
119234
119286
|
$all?: boolean;
|
|
119235
119287
|
/**
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.412",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "5b233252e5b8991ddebae66b8e74df96960f11a01f7639737e9e43263d38c9a9",
|
|
49
49
|
"typeScriptVersion": "4.8"
|
|
50
50
|
}
|