@types/office-js-preview 1.0.495 → 1.0.497
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +175 -123
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Mon, 12 Aug 2024 18:39:04 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -12692,18 +12692,6 @@ declare namespace Office {
|
|
|
12692
12692
|
* 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
|
|
12693
12693
|
* about append-on-send and its configuration, see
|
|
12694
12694
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12695
|
-
*
|
|
12696
|
-
* **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
|
|
12697
|
-
* is implemented with append-on-send, the following apply.
|
|
12698
|
-
*
|
|
12699
|
-
* - 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.
|
|
12700
|
-
*
|
|
12701
|
-
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12702
|
-
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12703
|
-
*
|
|
12704
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
12705
|
-
*
|
|
12706
|
-
* **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12707
12695
|
*
|
|
12708
12696
|
* @remarks
|
|
12709
12697
|
* [Api set: Mailbox 1.9]
|
|
@@ -12712,6 +12700,22 @@ declare namespace Office {
|
|
|
12712
12700
|
*
|
|
12713
12701
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12714
12702
|
*
|
|
12703
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12704
|
+
*
|
|
12705
|
+
* **Important**:
|
|
12706
|
+
*
|
|
12707
|
+
* - 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}
|
|
12708
|
+
* using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12709
|
+
*
|
|
12710
|
+
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12711
|
+
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12712
|
+
*
|
|
12713
|
+
* - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12714
|
+
*
|
|
12715
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12716
|
+
*
|
|
12717
|
+
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12718
|
+
*
|
|
12715
12719
|
* **Errors**:
|
|
12716
12720
|
*
|
|
12717
12721
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12732,18 +12736,6 @@ declare namespace Office {
|
|
|
12732
12736
|
* 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
|
|
12733
12737
|
* about append-on-send and its configuration, see
|
|
12734
12738
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/append-on-send | Implement append-on-send in your Outlook add-in}.
|
|
12735
|
-
*
|
|
12736
|
-
* **Important**: If the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins?tabs=windows | on-send feature}
|
|
12737
|
-
* is implemented with append-on-send, the following apply.
|
|
12738
|
-
*
|
|
12739
|
-
* - 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.
|
|
12740
|
-
*
|
|
12741
|
-
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12742
|
-
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12743
|
-
*
|
|
12744
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
12745
|
-
*
|
|
12746
|
-
* **Note**: To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12747
12739
|
*
|
|
12748
12740
|
* @remarks
|
|
12749
12741
|
* [Api set: Mailbox 1.9]
|
|
@@ -12752,6 +12744,22 @@ declare namespace Office {
|
|
|
12752
12744
|
*
|
|
12753
12745
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12754
12746
|
*
|
|
12747
|
+
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12748
|
+
*
|
|
12749
|
+
* **Important**:
|
|
12750
|
+
*
|
|
12751
|
+
* - 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}
|
|
12752
|
+
* using `ItemSend` in the manifest, append-on-send runs before on-send functionality.
|
|
12753
|
+
*
|
|
12754
|
+
* - If your add-in implements the on-send feature and calls `appendOnSendAsync` in the `ItemSend` handler,
|
|
12755
|
+
* the `appendOnSendAsync` call returns an error as this scenario isn't supported.
|
|
12756
|
+
*
|
|
12757
|
+
* - To clear data from a previous `appendOnSendAsync` call, you can call it again with the `data` parameter set to `null`.
|
|
12758
|
+
*
|
|
12759
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12760
|
+
*
|
|
12761
|
+
* - The `appendOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12762
|
+
*
|
|
12755
12763
|
* **Errors**:
|
|
12756
12764
|
*
|
|
12757
12765
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 5,000 characters.
|
|
@@ -12857,6 +12865,8 @@ declare namespace Office {
|
|
|
12857
12865
|
*
|
|
12858
12866
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12859
12867
|
*
|
|
12868
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12869
|
+
*
|
|
12860
12870
|
* **Important**:
|
|
12861
12871
|
*
|
|
12862
12872
|
* - 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
|
|
@@ -12876,7 +12886,9 @@ declare namespace Office {
|
|
|
12876
12886
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12877
12887
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12878
12888
|
*
|
|
12879
|
-
*
|
|
12889
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12890
|
+
*
|
|
12891
|
+
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12880
12892
|
*
|
|
12881
12893
|
* **Errors**:
|
|
12882
12894
|
*
|
|
@@ -12900,6 +12912,8 @@ declare namespace Office {
|
|
|
12900
12912
|
*
|
|
12901
12913
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12902
12914
|
*
|
|
12915
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
12916
|
+
*
|
|
12903
12917
|
* **Important**:
|
|
12904
12918
|
*
|
|
12905
12919
|
* - 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
|
|
@@ -12919,7 +12933,9 @@ declare namespace Office {
|
|
|
12919
12933
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
12920
12934
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
12921
12935
|
*
|
|
12922
|
-
*
|
|
12936
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12937
|
+
*
|
|
12938
|
+
* - The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12923
12939
|
*
|
|
12924
12940
|
* **Errors**:
|
|
12925
12941
|
*
|
|
@@ -12932,37 +12948,41 @@ declare namespace Office {
|
|
|
12932
12948
|
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12933
12949
|
/**
|
|
12934
12950
|
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12935
|
-
*
|
|
12951
|
+
*
|
|
12936
12952
|
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12937
12953
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12938
|
-
*
|
|
12954
|
+
*
|
|
12939
12955
|
* @remarks
|
|
12940
12956
|
* [Api set: Mailbox 1.13]
|
|
12941
|
-
*
|
|
12957
|
+
*
|
|
12942
12958
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12943
12959
|
*
|
|
12944
12960
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12945
|
-
*
|
|
12961
|
+
*
|
|
12946
12962
|
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12947
|
-
*
|
|
12963
|
+
*
|
|
12948
12964
|
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12949
|
-
*
|
|
12965
|
+
*
|
|
12950
12966
|
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
|
|
12951
12967
|
* the prepend-on-send feature runs first.
|
|
12952
|
-
*
|
|
12968
|
+
*
|
|
12953
12969
|
* - A new line is added after the prepended content.
|
|
12954
|
-
*
|
|
12970
|
+
*
|
|
12955
12971
|
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12956
12972
|
* The content of the last run add-in appears above previously prepended content.
|
|
12957
|
-
*
|
|
12973
|
+
*
|
|
12958
12974
|
* - 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.
|
|
12959
|
-
*
|
|
12975
|
+
*
|
|
12976
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
12977
|
+
*
|
|
12978
|
+
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
12979
|
+
*
|
|
12960
12980
|
* **Errors**:
|
|
12961
|
-
*
|
|
12981
|
+
*
|
|
12962
12982
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
12963
|
-
*
|
|
12983
|
+
*
|
|
12964
12984
|
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
12965
|
-
*
|
|
12985
|
+
*
|
|
12966
12986
|
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
12967
12987
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
12968
12988
|
* `asyncContext`: Any object that can be accessed in the callback function.
|
|
@@ -12973,37 +12993,41 @@ declare namespace Office {
|
|
|
12973
12993
|
prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
12974
12994
|
/**
|
|
12975
12995
|
* Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.
|
|
12976
|
-
*
|
|
12996
|
+
*
|
|
12977
12997
|
* To use `prependOnSendAsync`, you must specify a supplementary permission in the manifest. Details vary with the type of manifest. For guidance,
|
|
12978
12998
|
* see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Understanding Outlook add-in permissions}.
|
|
12979
|
-
*
|
|
12999
|
+
*
|
|
12980
13000
|
* @remarks
|
|
12981
13001
|
* [Api set: Mailbox 1.13]
|
|
12982
|
-
*
|
|
13002
|
+
*
|
|
12983
13003
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
12984
13004
|
*
|
|
12985
13005
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12986
|
-
*
|
|
13006
|
+
*
|
|
12987
13007
|
* **Recommended**: Call `getTypeAsync`, then pass its returned value to the `options.coercionType` parameter.
|
|
12988
|
-
*
|
|
13008
|
+
*
|
|
12989
13009
|
* **Important**: When implementing `prependOnSendAsync`, keep the following in mind.
|
|
12990
|
-
*
|
|
13010
|
+
*
|
|
12991
13011
|
* - In a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts add-in},
|
|
12992
13012
|
* the prepend-on-send feature runs first.
|
|
12993
|
-
*
|
|
13013
|
+
*
|
|
12994
13014
|
* - A new line is added after the prepended content.
|
|
12995
|
-
*
|
|
13015
|
+
*
|
|
12996
13016
|
* - If multiple active add-ins call `prependOnSendAsync`, the order of the inserted content depends on the order in which the add-in runs.
|
|
12997
13017
|
* The content of the last run add-in appears above previously prepended content.
|
|
12998
|
-
*
|
|
13018
|
+
*
|
|
12999
13019
|
* - 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.
|
|
13000
|
-
*
|
|
13020
|
+
*
|
|
13021
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13022
|
+
*
|
|
13023
|
+
* - The `prependOnSendAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13024
|
+
*
|
|
13001
13025
|
* **Errors**:
|
|
13002
|
-
*
|
|
13026
|
+
*
|
|
13003
13027
|
* - `DataExceedsMaximumSize`: The `data` parameter exceeds 5,000 characters.
|
|
13004
|
-
*
|
|
13028
|
+
*
|
|
13005
13029
|
* - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html`, but the item body is in plain text format.
|
|
13006
|
-
*
|
|
13030
|
+
*
|
|
13007
13031
|
* @param data - The string to be prepended to the beginning of the message or appointment body. The string is limited to 5,000 characters.
|
|
13008
13032
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
13009
13033
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -13019,6 +13043,8 @@ declare namespace Office {
|
|
|
13019
13043
|
*
|
|
13020
13044
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13021
13045
|
*
|
|
13046
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
13047
|
+
*
|
|
13022
13048
|
* **Important**:
|
|
13023
13049
|
*
|
|
13024
13050
|
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
@@ -13040,7 +13066,9 @@ declare namespace Office {
|
|
|
13040
13066
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
13041
13067
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13042
13068
|
*
|
|
13043
|
-
*
|
|
13069
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13070
|
+
*
|
|
13071
|
+
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13044
13072
|
*
|
|
13045
13073
|
* **Errors**:
|
|
13046
13074
|
*
|
|
@@ -13066,6 +13094,8 @@ declare namespace Office {
|
|
|
13066
13094
|
*
|
|
13067
13095
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13068
13096
|
*
|
|
13097
|
+
* **Recommended**: Call `getTypeAsync`, then pass the returned value to the `options.coercionType` parameter.
|
|
13098
|
+
*
|
|
13069
13099
|
* **Important**:
|
|
13070
13100
|
*
|
|
13071
13101
|
* - After the body is replaced with the specified content, the position of the cursor depends on which client the add-in is running.
|
|
@@ -13087,7 +13117,9 @@ declare namespace Office {
|
|
|
13087
13117
|
* supported. For more information on supported APIs in Outlook mobile, see
|
|
13088
13118
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
13089
13119
|
*
|
|
13090
|
-
*
|
|
13120
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13121
|
+
*
|
|
13122
|
+
* - The `setAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13091
13123
|
*
|
|
13092
13124
|
* **Errors**:
|
|
13093
13125
|
*
|
|
@@ -13107,11 +13139,6 @@ declare namespace Office {
|
|
|
13107
13139
|
* 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
|
|
13108
13140
|
* 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.
|
|
13109
13141
|
*
|
|
13110
|
-
* When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13111
|
-
* (see the **Examples** section for a sample).
|
|
13112
|
-
*
|
|
13113
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13114
|
-
*
|
|
13115
13142
|
* @remarks
|
|
13116
13143
|
* [Api set: Mailbox 1.1]
|
|
13117
13144
|
*
|
|
@@ -13119,6 +13146,17 @@ declare namespace Office {
|
|
|
13119
13146
|
*
|
|
13120
13147
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13121
13148
|
*
|
|
13149
|
+
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13150
|
+
*
|
|
13151
|
+
* **Important*:
|
|
13152
|
+
*
|
|
13153
|
+
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13154
|
+
* (see the **Examples** section for a sample).
|
|
13155
|
+
*
|
|
13156
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13157
|
+
*
|
|
13158
|
+
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13159
|
+
*
|
|
13122
13160
|
* **Errors**:
|
|
13123
13161
|
*
|
|
13124
13162
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13140,11 +13178,6 @@ declare namespace Office {
|
|
|
13140
13178
|
* 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
|
|
13141
13179
|
* 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.
|
|
13142
13180
|
*
|
|
13143
|
-
* When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13144
|
-
* (see the **Examples** section for a sample).
|
|
13145
|
-
*
|
|
13146
|
-
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13147
|
-
*
|
|
13148
13181
|
* @remarks
|
|
13149
13182
|
* [Api set: Mailbox 1.1]
|
|
13150
13183
|
*
|
|
@@ -13152,6 +13185,17 @@ declare namespace Office {
|
|
|
13152
13185
|
*
|
|
13153
13186
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13154
13187
|
*
|
|
13188
|
+
* **Recommended**: Call `getTypeAsync` then pass the returned value to the `options.coercionType` parameter.
|
|
13189
|
+
*
|
|
13190
|
+
* **Important*:
|
|
13191
|
+
*
|
|
13192
|
+
* - When including links in HTML markup, you can disable online link preview by setting the `id` attribute on the anchor (\<a\>) to "LPNoLP"
|
|
13193
|
+
* (see the **Examples** section for a sample).
|
|
13194
|
+
*
|
|
13195
|
+
* - SVG files aren't supported. Use JPG or PNG files instead.
|
|
13196
|
+
*
|
|
13197
|
+
* - The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13198
|
+
*
|
|
13155
13199
|
* **Errors**:
|
|
13156
13200
|
*
|
|
13157
13201
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 1,000,000 characters.
|
|
@@ -13188,6 +13232,10 @@ declare namespace Office {
|
|
|
13188
13232
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
13189
13233
|
* if the user closes the form without making other edits, they won't be prompted to save changes.
|
|
13190
13234
|
*
|
|
13235
|
+
* - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
|
|
13236
|
+
*
|
|
13237
|
+
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13238
|
+
*
|
|
13191
13239
|
* **Errors**:
|
|
13192
13240
|
*
|
|
13193
13241
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -13228,6 +13276,10 @@ declare namespace Office {
|
|
|
13228
13276
|
* When the user composes a new item (including reply or forward), the signature is set but doesn't modify the form. This means
|
|
13229
13277
|
* if the user closes the form without making other edits, they won't be prompted to save changes.
|
|
13230
13278
|
*
|
|
13279
|
+
* - SVG files aren't supported in mail signatures. Use JPG or PNG files instead.
|
|
13280
|
+
*
|
|
13281
|
+
* - The `setSignatureAsync` method doesn't support inline CSS. Use internal or external CSS instead.
|
|
13282
|
+
*
|
|
13231
13283
|
* **Errors**:
|
|
13232
13284
|
*
|
|
13233
13285
|
* - `DataExceedsMaximumSize`: The `data` parameter is longer than 30,000 characters.
|
|
@@ -122501,12 +122553,12 @@ declare namespace PowerPoint {
|
|
|
122501
122553
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
122502
122554
|
context: RequestContext;
|
|
122503
122555
|
/**
|
|
122504
|
-
* Create a new instance of PowerPoint.Application object
|
|
122556
|
+
* Create a new instance of the `PowerPoint.Application` object.
|
|
122505
122557
|
*/
|
|
122506
122558
|
static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application;
|
|
122507
122559
|
/**
|
|
122508
122560
|
* 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.)
|
|
122509
|
-
* 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.
|
|
122561
|
+
* 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.
|
|
122510
122562
|
*/
|
|
122511
122563
|
toJSON(): {
|
|
122512
122564
|
[key: string]: string;
|
|
@@ -122623,7 +122675,7 @@ declare namespace PowerPoint {
|
|
|
122623
122675
|
}): PowerPoint.Presentation;
|
|
122624
122676
|
/**
|
|
122625
122677
|
* 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.)
|
|
122626
|
-
* 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.
|
|
122678
|
+
* 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.
|
|
122627
122679
|
*/
|
|
122628
122680
|
toJSON(): PowerPoint.Interfaces.PresentationData;
|
|
122629
122681
|
}
|
|
@@ -124284,7 +124336,7 @@ declare namespace PowerPoint {
|
|
|
124284
124336
|
}): PowerPoint.SlideLayout;
|
|
124285
124337
|
/**
|
|
124286
124338
|
* 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.)
|
|
124287
|
-
* 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.
|
|
124339
|
+
* 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.
|
|
124288
124340
|
*/
|
|
124289
124341
|
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
124290
124342
|
}
|
|
@@ -124422,7 +124474,7 @@ declare namespace PowerPoint {
|
|
|
124422
124474
|
}): PowerPoint.SlideMaster;
|
|
124423
124475
|
/**
|
|
124424
124476
|
* 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.)
|
|
124425
|
-
* 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.
|
|
124477
|
+
* 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.
|
|
124426
124478
|
*/
|
|
124427
124479
|
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
124428
124480
|
}
|
|
@@ -124472,7 +124524,7 @@ declare namespace PowerPoint {
|
|
|
124472
124524
|
}): PowerPoint.Tag;
|
|
124473
124525
|
/**
|
|
124474
124526
|
* 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.)
|
|
124475
|
-
* 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.
|
|
124527
|
+
* 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.
|
|
124476
124528
|
*/
|
|
124477
124529
|
toJSON(): PowerPoint.Interfaces.TagData;
|
|
124478
124530
|
}
|
|
@@ -124488,22 +124540,22 @@ declare namespace PowerPoint {
|
|
|
124488
124540
|
/** Gets the loaded child items in this collection. */
|
|
124489
124541
|
readonly items: PowerPoint.Tag[];
|
|
124490
124542
|
/**
|
|
124491
|
-
* 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`.
|
|
124543
|
+
* 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`.
|
|
124492
124544
|
*
|
|
124493
124545
|
* @remarks
|
|
124494
124546
|
* [Api set: PowerPointApi 1.3]
|
|
124495
124547
|
*
|
|
124496
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
124548
|
+
* @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.
|
|
124497
124549
|
* @param value The value of the tag.
|
|
124498
124550
|
*/
|
|
124499
124551
|
add(key: string, value: string): void;
|
|
124500
124552
|
/**
|
|
124501
|
-
* Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
|
|
124553
|
+
* Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
|
|
124502
124554
|
*
|
|
124503
124555
|
* @remarks
|
|
124504
124556
|
* [Api set: PowerPointApi 1.3]
|
|
124505
124557
|
*
|
|
124506
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
124558
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
|
|
124507
124559
|
*/
|
|
124508
124560
|
delete(key: string): void;
|
|
124509
124561
|
/**
|
|
@@ -124520,7 +124572,7 @@ declare namespace PowerPoint {
|
|
|
124520
124572
|
* @remarks
|
|
124521
124573
|
* [Api set: PowerPointApi 1.3]
|
|
124522
124574
|
*
|
|
124523
|
-
* @param key The ID of the tag.
|
|
124575
|
+
* @param key The ID of the tag.
|
|
124524
124576
|
* @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
|
|
124525
124577
|
*/
|
|
124526
124578
|
getItem(key: string): PowerPoint.Tag;
|
|
@@ -124540,7 +124592,7 @@ declare namespace PowerPoint {
|
|
|
124540
124592
|
* @remarks
|
|
124541
124593
|
* [Api set: PowerPointApi 1.3]
|
|
124542
124594
|
*
|
|
124543
|
-
* @param key The ID of the tag.
|
|
124595
|
+
* @param key The ID of the tag.
|
|
124544
124596
|
* @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.
|
|
124545
124597
|
*/
|
|
124546
124598
|
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
@@ -124672,7 +124724,7 @@ declare namespace PowerPoint {
|
|
|
124672
124724
|
}): PowerPoint.Slide;
|
|
124673
124725
|
/**
|
|
124674
124726
|
* 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.)
|
|
124675
|
-
* 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.
|
|
124727
|
+
* 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.
|
|
124676
124728
|
*/
|
|
124677
124729
|
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
124678
124730
|
}
|
|
@@ -124789,7 +124841,7 @@ declare namespace PowerPoint {
|
|
|
124789
124841
|
}): PowerPoint.ShapeFill;
|
|
124790
124842
|
/**
|
|
124791
124843
|
* 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.)
|
|
124792
|
-
* 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.
|
|
124844
|
+
* 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.
|
|
124793
124845
|
*/
|
|
124794
124846
|
toJSON(): PowerPoint.Interfaces.ShapeFillData;
|
|
124795
124847
|
}
|
|
@@ -124905,7 +124957,7 @@ declare namespace PowerPoint {
|
|
|
124905
124957
|
}): PowerPoint.ShapeLineFormat;
|
|
124906
124958
|
/**
|
|
124907
124959
|
* 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.)
|
|
124908
|
-
* 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.
|
|
124960
|
+
* 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.
|
|
124909
124961
|
*/
|
|
124910
124962
|
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
|
|
124911
124963
|
}
|
|
@@ -125024,7 +125076,7 @@ declare namespace PowerPoint {
|
|
|
125024
125076
|
}): PowerPoint.BulletFormat;
|
|
125025
125077
|
/**
|
|
125026
125078
|
* 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.)
|
|
125027
|
-
* 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.
|
|
125079
|
+
* 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.
|
|
125028
125080
|
*/
|
|
125029
125081
|
toJSON(): PowerPoint.Interfaces.BulletFormatData;
|
|
125030
125082
|
}
|
|
@@ -125074,7 +125126,7 @@ declare namespace PowerPoint {
|
|
|
125074
125126
|
}): PowerPoint.ParagraphFormat;
|
|
125075
125127
|
/**
|
|
125076
125128
|
* 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.)
|
|
125077
|
-
* 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.
|
|
125129
|
+
* 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.
|
|
125078
125130
|
*/
|
|
125079
125131
|
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
|
|
125080
125132
|
}
|
|
@@ -125152,7 +125204,7 @@ declare namespace PowerPoint {
|
|
|
125152
125204
|
}): PowerPoint.ShapeFont;
|
|
125153
125205
|
/**
|
|
125154
125206
|
* 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.)
|
|
125155
|
-
* 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.
|
|
125207
|
+
* 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.
|
|
125156
125208
|
*/
|
|
125157
125209
|
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
125158
125210
|
}
|
|
@@ -125249,7 +125301,7 @@ declare namespace PowerPoint {
|
|
|
125249
125301
|
}): PowerPoint.TextRange;
|
|
125250
125302
|
/**
|
|
125251
125303
|
* 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.)
|
|
125252
|
-
* 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.
|
|
125304
|
+
* 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.
|
|
125253
125305
|
*/
|
|
125254
125306
|
toJSON(): PowerPoint.Interfaces.TextRangeData;
|
|
125255
125307
|
}
|
|
@@ -125362,7 +125414,7 @@ declare namespace PowerPoint {
|
|
|
125362
125414
|
}): PowerPoint.TextFrame;
|
|
125363
125415
|
/**
|
|
125364
125416
|
* 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.)
|
|
125365
|
-
* 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.
|
|
125417
|
+
* 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.
|
|
125366
125418
|
*/
|
|
125367
125419
|
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
125368
125420
|
}
|
|
@@ -125524,7 +125576,7 @@ declare namespace PowerPoint {
|
|
|
125524
125576
|
}): PowerPoint.Shape;
|
|
125525
125577
|
/**
|
|
125526
125578
|
* 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.)
|
|
125527
|
-
* 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.
|
|
125579
|
+
* 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.
|
|
125528
125580
|
*/
|
|
125529
125581
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
125530
125582
|
}
|
|
@@ -125907,15 +125959,15 @@ declare namespace PowerPoint {
|
|
|
125907
125959
|
*/
|
|
125908
125960
|
$skip?: number;
|
|
125909
125961
|
}
|
|
125910
|
-
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
125962
|
+
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
125911
125963
|
interface ShapeCollectionUpdateData {
|
|
125912
125964
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
125913
125965
|
}
|
|
125914
|
-
/** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
125966
|
+
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
125915
125967
|
interface SlideLayoutCollectionUpdateData {
|
|
125916
125968
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
125917
125969
|
}
|
|
125918
|
-
/** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
|
|
125970
|
+
/** An interface for updating data on the `Tag` object, for use in `tag.set({ ... })`. */
|
|
125919
125971
|
interface TagUpdateData {
|
|
125920
125972
|
/**
|
|
125921
125973
|
* Gets the value of the tag.
|
|
@@ -125925,11 +125977,11 @@ declare namespace PowerPoint {
|
|
|
125925
125977
|
*/
|
|
125926
125978
|
value?: string;
|
|
125927
125979
|
}
|
|
125928
|
-
/** An interface for updating data on the TagCollection object, for use in `tagCollection.set({ ... })`. */
|
|
125980
|
+
/** An interface for updating data on the `TagCollection` object, for use in `tagCollection.set({ ... })`. */
|
|
125929
125981
|
interface TagCollectionUpdateData {
|
|
125930
125982
|
items?: PowerPoint.Interfaces.TagData[];
|
|
125931
125983
|
}
|
|
125932
|
-
/** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */
|
|
125984
|
+
/** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
|
|
125933
125985
|
interface ShapeFillUpdateData {
|
|
125934
125986
|
/**
|
|
125935
125987
|
* 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").
|
|
@@ -125946,7 +125998,7 @@ declare namespace PowerPoint {
|
|
|
125946
125998
|
*/
|
|
125947
125999
|
transparency?: number;
|
|
125948
126000
|
}
|
|
125949
|
-
/** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */
|
|
126001
|
+
/** An interface for updating data on the `ShapeLineFormat` object, for use in `shapeLineFormat.set({ ... })`. */
|
|
125950
126002
|
interface ShapeLineFormatUpdateData {
|
|
125951
126003
|
/**
|
|
125952
126004
|
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
@@ -125991,7 +126043,7 @@ declare namespace PowerPoint {
|
|
|
125991
126043
|
*/
|
|
125992
126044
|
weight?: number;
|
|
125993
126045
|
}
|
|
125994
|
-
/** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
|
|
126046
|
+
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
|
|
125995
126047
|
interface BulletFormatUpdateData {
|
|
125996
126048
|
/**
|
|
125997
126049
|
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
@@ -126001,7 +126053,7 @@ declare namespace PowerPoint {
|
|
|
126001
126053
|
*/
|
|
126002
126054
|
visible?: boolean;
|
|
126003
126055
|
}
|
|
126004
|
-
/** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
|
|
126056
|
+
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
|
|
126005
126057
|
interface ParagraphFormatUpdateData {
|
|
126006
126058
|
/**
|
|
126007
126059
|
* 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.
|
|
@@ -126011,7 +126063,7 @@ declare namespace PowerPoint {
|
|
|
126011
126063
|
*/
|
|
126012
126064
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
126013
126065
|
}
|
|
126014
|
-
/** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
|
|
126066
|
+
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
|
|
126015
126067
|
interface ShapeFontUpdateData {
|
|
126016
126068
|
/**
|
|
126017
126069
|
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
@@ -126056,7 +126108,7 @@ declare namespace PowerPoint {
|
|
|
126056
126108
|
*/
|
|
126057
126109
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
|
|
126058
126110
|
}
|
|
126059
|
-
/** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
|
|
126111
|
+
/** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
|
|
126060
126112
|
interface TextRangeUpdateData {
|
|
126061
126113
|
/**
|
|
126062
126114
|
* Gets or sets the length of the range that this `TextRange` represents.
|
|
@@ -126082,7 +126134,7 @@ declare namespace PowerPoint {
|
|
|
126082
126134
|
*/
|
|
126083
126135
|
text?: string;
|
|
126084
126136
|
}
|
|
126085
|
-
/** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */
|
|
126137
|
+
/** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */
|
|
126086
126138
|
interface TextFrameUpdateData {
|
|
126087
126139
|
/**
|
|
126088
126140
|
* 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.
|
|
@@ -126134,7 +126186,7 @@ declare namespace PowerPoint {
|
|
|
126134
126186
|
*/
|
|
126135
126187
|
wordWrap?: boolean;
|
|
126136
126188
|
}
|
|
126137
|
-
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
126189
|
+
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
126138
126190
|
interface ShapeUpdateData {
|
|
126139
126191
|
/**
|
|
126140
126192
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
@@ -126172,19 +126224,19 @@ declare namespace PowerPoint {
|
|
|
126172
126224
|
*/
|
|
126173
126225
|
width?: number;
|
|
126174
126226
|
}
|
|
126175
|
-
/** An interface for updating data on the ShapeScopedCollection object, for use in `shapeScopedCollection.set({ ... })`. */
|
|
126227
|
+
/** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
|
|
126176
126228
|
interface ShapeScopedCollectionUpdateData {
|
|
126177
126229
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
126178
126230
|
}
|
|
126179
|
-
/** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
|
|
126231
|
+
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
|
|
126180
126232
|
interface SlideCollectionUpdateData {
|
|
126181
126233
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
126182
126234
|
}
|
|
126183
|
-
/** An interface for updating data on the SlideScopedCollection object, for use in `slideScopedCollection.set({ ... })`. */
|
|
126235
|
+
/** An interface for updating data on the `SlideScopedCollection` object, for use in `slideScopedCollection.set({ ... })`. */
|
|
126184
126236
|
interface SlideScopedCollectionUpdateData {
|
|
126185
126237
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
126186
126238
|
}
|
|
126187
|
-
/** An interface for updating data on the SlideMasterCollection object, for use in `slideMasterCollection.set({ ... })`. */
|
|
126239
|
+
/** An interface for updating data on the `SlideMasterCollection` object, for use in `slideMasterCollection.set({ ... })`. */
|
|
126188
126240
|
interface SlideMasterCollectionUpdateData {
|
|
126189
126241
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
126190
126242
|
}
|
|
@@ -126565,7 +126617,7 @@ declare namespace PowerPoint {
|
|
|
126565
126617
|
*/
|
|
126566
126618
|
interface PresentationLoadOptions {
|
|
126567
126619
|
/**
|
|
126568
|
-
Specifying `$all` for the
|
|
126620
|
+
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`).
|
|
126569
126621
|
*/
|
|
126570
126622
|
$all?: boolean;
|
|
126571
126623
|
/**
|
|
@@ -126585,7 +126637,7 @@ declare namespace PowerPoint {
|
|
|
126585
126637
|
*/
|
|
126586
126638
|
interface ShapeCollectionLoadOptions {
|
|
126587
126639
|
/**
|
|
126588
|
-
Specifying `$all` for the
|
|
126640
|
+
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`).
|
|
126589
126641
|
*/
|
|
126590
126642
|
$all?: boolean;
|
|
126591
126643
|
/**
|
|
@@ -126667,7 +126719,7 @@ declare namespace PowerPoint {
|
|
|
126667
126719
|
*/
|
|
126668
126720
|
interface SlideLayoutLoadOptions {
|
|
126669
126721
|
/**
|
|
126670
|
-
Specifying `$all` for the
|
|
126722
|
+
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`).
|
|
126671
126723
|
*/
|
|
126672
126724
|
$all?: boolean;
|
|
126673
126725
|
/**
|
|
@@ -126693,7 +126745,7 @@ declare namespace PowerPoint {
|
|
|
126693
126745
|
*/
|
|
126694
126746
|
interface SlideLayoutCollectionLoadOptions {
|
|
126695
126747
|
/**
|
|
126696
|
-
Specifying `$all` for the
|
|
126748
|
+
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`).
|
|
126697
126749
|
*/
|
|
126698
126750
|
$all?: boolean;
|
|
126699
126751
|
/**
|
|
@@ -126719,7 +126771,7 @@ declare namespace PowerPoint {
|
|
|
126719
126771
|
*/
|
|
126720
126772
|
interface SlideMasterLoadOptions {
|
|
126721
126773
|
/**
|
|
126722
|
-
Specifying `$all` for the
|
|
126774
|
+
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`).
|
|
126723
126775
|
*/
|
|
126724
126776
|
$all?: boolean;
|
|
126725
126777
|
/**
|
|
@@ -126745,7 +126797,7 @@ declare namespace PowerPoint {
|
|
|
126745
126797
|
*/
|
|
126746
126798
|
interface TagLoadOptions {
|
|
126747
126799
|
/**
|
|
126748
|
-
Specifying `$all` for the
|
|
126800
|
+
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`).
|
|
126749
126801
|
*/
|
|
126750
126802
|
$all?: boolean;
|
|
126751
126803
|
/**
|
|
@@ -126771,7 +126823,7 @@ declare namespace PowerPoint {
|
|
|
126771
126823
|
*/
|
|
126772
126824
|
interface TagCollectionLoadOptions {
|
|
126773
126825
|
/**
|
|
126774
|
-
Specifying `$all` for the
|
|
126826
|
+
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`).
|
|
126775
126827
|
*/
|
|
126776
126828
|
$all?: boolean;
|
|
126777
126829
|
/**
|
|
@@ -126797,7 +126849,7 @@ declare namespace PowerPoint {
|
|
|
126797
126849
|
*/
|
|
126798
126850
|
interface SlideLoadOptions {
|
|
126799
126851
|
/**
|
|
126800
|
-
Specifying `$all` for the
|
|
126852
|
+
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`).
|
|
126801
126853
|
*/
|
|
126802
126854
|
$all?: boolean;
|
|
126803
126855
|
/**
|
|
@@ -126830,7 +126882,7 @@ declare namespace PowerPoint {
|
|
|
126830
126882
|
*/
|
|
126831
126883
|
interface ShapeFillLoadOptions {
|
|
126832
126884
|
/**
|
|
126833
|
-
Specifying `$all` for the
|
|
126885
|
+
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`).
|
|
126834
126886
|
*/
|
|
126835
126887
|
$all?: boolean;
|
|
126836
126888
|
/**
|
|
@@ -126863,7 +126915,7 @@ declare namespace PowerPoint {
|
|
|
126863
126915
|
*/
|
|
126864
126916
|
interface ShapeLineFormatLoadOptions {
|
|
126865
126917
|
/**
|
|
126866
|
-
Specifying `$all` for the
|
|
126918
|
+
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`).
|
|
126867
126919
|
*/
|
|
126868
126920
|
$all?: boolean;
|
|
126869
126921
|
/**
|
|
@@ -126917,7 +126969,7 @@ declare namespace PowerPoint {
|
|
|
126917
126969
|
*/
|
|
126918
126970
|
interface BulletFormatLoadOptions {
|
|
126919
126971
|
/**
|
|
126920
|
-
Specifying `$all` for the
|
|
126972
|
+
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`).
|
|
126921
126973
|
*/
|
|
126922
126974
|
$all?: boolean;
|
|
126923
126975
|
/**
|
|
@@ -126936,7 +126988,7 @@ declare namespace PowerPoint {
|
|
|
126936
126988
|
*/
|
|
126937
126989
|
interface ParagraphFormatLoadOptions {
|
|
126938
126990
|
/**
|
|
126939
|
-
Specifying `$all` for the
|
|
126991
|
+
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`).
|
|
126940
126992
|
*/
|
|
126941
126993
|
$all?: boolean;
|
|
126942
126994
|
/**
|
|
@@ -126962,7 +127014,7 @@ declare namespace PowerPoint {
|
|
|
126962
127014
|
*/
|
|
126963
127015
|
interface ShapeFontLoadOptions {
|
|
126964
127016
|
/**
|
|
126965
|
-
Specifying `$all` for the
|
|
127017
|
+
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`).
|
|
126966
127018
|
*/
|
|
126967
127019
|
$all?: boolean;
|
|
126968
127020
|
/**
|
|
@@ -127016,7 +127068,7 @@ declare namespace PowerPoint {
|
|
|
127016
127068
|
*/
|
|
127017
127069
|
interface TextRangeLoadOptions {
|
|
127018
127070
|
/**
|
|
127019
|
-
Specifying `$all` for the
|
|
127071
|
+
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`).
|
|
127020
127072
|
*/
|
|
127021
127073
|
$all?: boolean;
|
|
127022
127074
|
/**
|
|
@@ -127065,7 +127117,7 @@ declare namespace PowerPoint {
|
|
|
127065
127117
|
*/
|
|
127066
127118
|
interface TextFrameLoadOptions {
|
|
127067
127119
|
/**
|
|
127068
|
-
Specifying `$all` for the
|
|
127120
|
+
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`).
|
|
127069
127121
|
*/
|
|
127070
127122
|
$all?: boolean;
|
|
127071
127123
|
/**
|
|
@@ -127140,7 +127192,7 @@ declare namespace PowerPoint {
|
|
|
127140
127192
|
*/
|
|
127141
127193
|
interface ShapeLoadOptions {
|
|
127142
127194
|
/**
|
|
127143
|
-
Specifying `$all` for the
|
|
127195
|
+
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`).
|
|
127144
127196
|
*/
|
|
127145
127197
|
$all?: boolean;
|
|
127146
127198
|
/**
|
|
@@ -127218,11 +127270,11 @@ declare namespace PowerPoint {
|
|
|
127218
127270
|
* Represents a collection of shapes.
|
|
127219
127271
|
*
|
|
127220
127272
|
* @remarks
|
|
127221
|
-
* [Api set: PowerPointApi 1.
|
|
127273
|
+
* [Api set: PowerPointApi 1.5]
|
|
127222
127274
|
*/
|
|
127223
127275
|
interface ShapeScopedCollectionLoadOptions {
|
|
127224
127276
|
/**
|
|
127225
|
-
Specifying `$all` for the
|
|
127277
|
+
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`).
|
|
127226
127278
|
*/
|
|
127227
127279
|
$all?: boolean;
|
|
127228
127280
|
/**
|
|
@@ -127304,7 +127356,7 @@ declare namespace PowerPoint {
|
|
|
127304
127356
|
*/
|
|
127305
127357
|
interface SlideCollectionLoadOptions {
|
|
127306
127358
|
/**
|
|
127307
|
-
Specifying `$all` for the
|
|
127359
|
+
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`).
|
|
127308
127360
|
*/
|
|
127309
127361
|
$all?: boolean;
|
|
127310
127362
|
/**
|
|
@@ -127333,11 +127385,11 @@ declare namespace PowerPoint {
|
|
|
127333
127385
|
* Represents a collection of slides in the presentation.
|
|
127334
127386
|
*
|
|
127335
127387
|
* @remarks
|
|
127336
|
-
* [Api set: PowerPointApi 1.
|
|
127388
|
+
* [Api set: PowerPointApi 1.5]
|
|
127337
127389
|
*/
|
|
127338
127390
|
interface SlideScopedCollectionLoadOptions {
|
|
127339
127391
|
/**
|
|
127340
|
-
Specifying `$all` for the
|
|
127392
|
+
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`).
|
|
127341
127393
|
*/
|
|
127342
127394
|
$all?: boolean;
|
|
127343
127395
|
/**
|
|
@@ -127370,7 +127422,7 @@ declare namespace PowerPoint {
|
|
|
127370
127422
|
*/
|
|
127371
127423
|
interface SlideMasterCollectionLoadOptions {
|
|
127372
127424
|
/**
|
|
127373
|
-
Specifying `$all` for the
|
|
127425
|
+
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`).
|
|
127374
127426
|
*/
|
|
127375
127427
|
$all?: boolean;
|
|
127376
127428
|
/**
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.497",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "4ebcf48da82c8acd80de4abca6c28db9ce7065fe27d680b4aee1f3e6eed5bfd0",
|
|
49
49
|
"typeScriptVersion": "4.8",
|
|
50
50
|
"nonNpm": true
|
|
51
51
|
}
|