@types/office-js 1.0.239 → 1.0.242
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 +226 -222
- office-js/package.json +3 -3
office-js/index.d.ts
CHANGED
|
@@ -533,7 +533,7 @@ declare namespace Office {
|
|
|
533
533
|
* Manages actions and keyboard shortcuts.
|
|
534
534
|
*
|
|
535
535
|
* @remarks
|
|
536
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
536
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
537
537
|
*/
|
|
538
538
|
interface Actions {
|
|
539
539
|
/**
|
|
@@ -543,7 +543,7 @@ declare namespace Office {
|
|
|
543
543
|
* @param actionFunction The function that is run when the action is invoked.
|
|
544
544
|
*
|
|
545
545
|
* @remarks
|
|
546
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
546
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
547
547
|
*/
|
|
548
548
|
associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
|
|
549
549
|
}
|
|
@@ -560,7 +560,7 @@ declare namespace Office {
|
|
|
560
560
|
* Represents add-in level functionality for operating or configuring various aspects of the add-in.
|
|
561
561
|
*
|
|
562
562
|
* @remarks
|
|
563
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
563
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
564
564
|
*/
|
|
565
565
|
interface Addin {
|
|
566
566
|
/**
|
|
@@ -568,14 +568,14 @@ declare namespace Office {
|
|
|
568
568
|
* @param behavior - Specifies startup behavior of the add-in.
|
|
569
569
|
*
|
|
570
570
|
* @remarks
|
|
571
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
571
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
572
572
|
*/
|
|
573
573
|
setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;
|
|
574
574
|
/**
|
|
575
575
|
* Gets the current startup behavior for the add-in.
|
|
576
576
|
*
|
|
577
577
|
* @remarks
|
|
578
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
578
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
579
579
|
*/
|
|
580
580
|
getStartupBehavior(): Promise<Office.StartupBehavior>;
|
|
581
581
|
/**
|
|
@@ -583,7 +583,7 @@ declare namespace Office {
|
|
|
583
583
|
* @returns A promise that is resolved when the UI is shown.
|
|
584
584
|
*
|
|
585
585
|
* @remarks
|
|
586
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
586
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
587
587
|
*/
|
|
588
588
|
showAsTaskpane(): Promise<void>;
|
|
589
589
|
/**
|
|
@@ -591,7 +591,7 @@ declare namespace Office {
|
|
|
591
591
|
* @returns A promise that is resolved when the UI is hidden.
|
|
592
592
|
*
|
|
593
593
|
* @remarks
|
|
594
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
594
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
595
595
|
*/
|
|
596
596
|
hide(): Promise<void>;
|
|
597
597
|
/**
|
|
@@ -600,7 +600,7 @@ declare namespace Office {
|
|
|
600
600
|
* @returns A promise that resolves to a function when the handler is added. Calling it removes the handler.
|
|
601
601
|
*
|
|
602
602
|
* @remarks
|
|
603
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
603
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
604
604
|
*/
|
|
605
605
|
onVisibilityModeChanged(
|
|
606
606
|
handler: (message: VisibilityModeChangedMessage) => void,
|
|
@@ -611,7 +611,7 @@ declare namespace Office {
|
|
|
611
611
|
*
|
|
612
612
|
* @remarks
|
|
613
613
|
*
|
|
614
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
614
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
615
615
|
*/
|
|
616
616
|
interface Ribbon {
|
|
617
617
|
/**
|
|
@@ -619,7 +619,7 @@ declare namespace Office {
|
|
|
619
619
|
*
|
|
620
620
|
* @remarks
|
|
621
621
|
*
|
|
622
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
622
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.2}
|
|
623
623
|
*
|
|
624
624
|
* This method only requests that the tab be registered. The actual registration is controlled by the Office application and may not be complete when the returned `Promise` object is resolved.
|
|
625
625
|
* For more information and code examples, see {@link https://docs.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
@@ -632,7 +632,7 @@ declare namespace Office {
|
|
|
632
632
|
*
|
|
633
633
|
* @remarks
|
|
634
634
|
*
|
|
635
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
635
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
636
636
|
*
|
|
637
637
|
* Note that this API is only to request an update. The actual UI update to the ribbon is controlled by the Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined by the completion of this API.
|
|
638
638
|
*
|
|
@@ -647,7 +647,7 @@ declare namespace Office {
|
|
|
647
647
|
*
|
|
648
648
|
* @remarks
|
|
649
649
|
*
|
|
650
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
650
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
651
651
|
*/
|
|
652
652
|
interface RibbonUpdaterData {
|
|
653
653
|
/**
|
|
@@ -660,7 +660,7 @@ declare namespace Office {
|
|
|
660
660
|
*
|
|
661
661
|
* @remarks
|
|
662
662
|
*
|
|
663
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
663
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
664
664
|
*/
|
|
665
665
|
interface Tab {
|
|
666
666
|
/**
|
|
@@ -680,7 +680,7 @@ declare namespace Office {
|
|
|
680
680
|
*
|
|
681
681
|
* @remarks
|
|
682
682
|
*
|
|
683
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
683
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.2}
|
|
684
684
|
*/
|
|
685
685
|
visible?: boolean;
|
|
686
686
|
/**
|
|
@@ -690,14 +690,14 @@ declare namespace Office {
|
|
|
690
690
|
*
|
|
691
691
|
* When the `Tab` object is part of an {@link Office.RibbonUpdaterData} object passed to the `requestUpdate` method of {@link Office.Ribbon}, the `controls` properties of the various {@link Office.Group} objects specify which controls have their enabled status changed; the `controls` property of the `Tab` object is ignored.
|
|
692
692
|
*
|
|
693
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
693
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
694
694
|
*/
|
|
695
695
|
groups?: Group[];
|
|
696
696
|
}
|
|
697
697
|
/**
|
|
698
698
|
* Represents a group of controls on a ribbon tab.
|
|
699
699
|
*
|
|
700
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
700
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
701
701
|
*/
|
|
702
702
|
interface Group {
|
|
703
703
|
/**
|
|
@@ -721,7 +721,7 @@ declare namespace Office {
|
|
|
721
721
|
*
|
|
722
722
|
* For code samples showing how to use a `Control` object and its properties, see {@link https://docs.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Enable and Disable Add-in Commands} and {@link https://docs.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
723
723
|
*
|
|
724
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
724
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
725
725
|
*/
|
|
726
726
|
interface Control {
|
|
727
727
|
/**
|
|
@@ -912,11 +912,11 @@ declare namespace Office {
|
|
|
912
912
|
*/
|
|
913
913
|
code: number;
|
|
914
914
|
/**
|
|
915
|
-
* Gets
|
|
915
|
+
* Gets a detailed description of the error.
|
|
916
916
|
*/
|
|
917
917
|
message: string;
|
|
918
918
|
/**
|
|
919
|
-
* Gets
|
|
919
|
+
* Gets the name of the error.
|
|
920
920
|
*/
|
|
921
921
|
name: string;
|
|
922
922
|
}
|
|
@@ -927,7 +927,7 @@ declare namespace Office {
|
|
|
927
927
|
*
|
|
928
928
|
* @remarks
|
|
929
929
|
*
|
|
930
|
-
* See {@link https://docs.microsoft.com/
|
|
930
|
+
* See {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
931
931
|
*
|
|
932
932
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
|
|
933
933
|
*
|
|
@@ -939,7 +939,7 @@ declare namespace Office {
|
|
|
939
939
|
*
|
|
940
940
|
* @remarks
|
|
941
941
|
*
|
|
942
|
-
* This property is supported in Outlook only in {@link https://docs.microsoft.com/
|
|
942
|
+
* This property is supported in Outlook only in {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | requirement set} Mailbox 1.3 and later.
|
|
943
943
|
*/
|
|
944
944
|
source:Source;
|
|
945
945
|
|
|
@@ -950,8 +950,8 @@ declare namespace Office {
|
|
|
950
950
|
*
|
|
951
951
|
* - A UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`)
|
|
952
952
|
*
|
|
953
|
-
* - An {@link https://docs.microsoft.com/
|
|
954
|
-
* {@link https://docs.microsoft.com/
|
|
953
|
+
* - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
|
|
954
|
+
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
|
|
955
955
|
* e.g., an `ItemSend` event
|
|
956
956
|
*
|
|
957
957
|
* [Api set: Mailbox 1.3]
|
|
@@ -1004,7 +1004,7 @@ declare namespace Office {
|
|
|
1004
1004
|
*
|
|
1005
1005
|
* @remarks
|
|
1006
1006
|
*
|
|
1007
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1007
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1008
1008
|
*
|
|
1009
1009
|
* You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
|
|
1010
1010
|
*
|
|
@@ -1019,7 +1019,7 @@ declare namespace Office {
|
|
|
1019
1019
|
*
|
|
1020
1020
|
* @remarks
|
|
1021
1021
|
*
|
|
1022
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1022
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1023
1023
|
*
|
|
1024
1024
|
* You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
|
|
1025
1025
|
*
|
|
@@ -1037,9 +1037,9 @@ declare namespace Office {
|
|
|
1037
1037
|
*
|
|
1038
1038
|
* **Requirement sets**:
|
|
1039
1039
|
*
|
|
1040
|
-
* - {@link https://docs.microsoft.com/
|
|
1040
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1041
1041
|
*
|
|
1042
|
-
* - {@link https://docs.microsoft.com/
|
|
1042
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
|
|
1043
1043
|
*
|
|
1044
1044
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
1045
1045
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
@@ -1138,9 +1138,9 @@ declare namespace Office {
|
|
|
1138
1138
|
*
|
|
1139
1139
|
* **Requirement sets**:
|
|
1140
1140
|
*
|
|
1141
|
-
* - {@link https://docs.microsoft.com/
|
|
1141
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1142
1142
|
*
|
|
1143
|
-
* - {@link https://docs.microsoft.com/
|
|
1143
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
|
|
1144
1144
|
*
|
|
1145
1145
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
1146
1146
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
@@ -1236,9 +1236,9 @@ declare namespace Office {
|
|
|
1236
1236
|
*
|
|
1237
1237
|
* **Requirement sets**:
|
|
1238
1238
|
*
|
|
1239
|
-
* - {@link https://docs.microsoft.com/
|
|
1239
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1240
1240
|
*
|
|
1241
|
-
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/
|
|
1241
|
+
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required.
|
|
1242
1242
|
*
|
|
1243
1243
|
* @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent.
|
|
1244
1244
|
* @param messageOptions Optional. Provides options for how to send the message.
|
|
@@ -1253,9 +1253,9 @@ declare namespace Office {
|
|
|
1253
1253
|
*
|
|
1254
1254
|
* **Requirement sets**:
|
|
1255
1255
|
*
|
|
1256
|
-
* - {@link https://docs.microsoft.com/
|
|
1256
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1257
1257
|
*
|
|
1258
|
-
* - {@link https://docs.microsoft.com/
|
|
1258
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.5}
|
|
1259
1259
|
*
|
|
1260
1260
|
* The behavior of this method is specified by the following:
|
|
1261
1261
|
*
|
|
@@ -1272,7 +1272,7 @@ declare namespace Office {
|
|
|
1272
1272
|
*
|
|
1273
1273
|
* @remarks
|
|
1274
1274
|
*
|
|
1275
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1275
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/open-browser-window-api-requirement-sets | OpenBrowserWindowApi 1.1}
|
|
1276
1276
|
*
|
|
1277
1277
|
* @param url The full URL to be opened including protocol (e.g., https), and port number, if any.
|
|
1278
1278
|
*/
|
|
@@ -1353,7 +1353,7 @@ declare namespace Office {
|
|
|
1353
1353
|
*
|
|
1354
1354
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1355
1355
|
*
|
|
1356
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1356
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1357
1357
|
*
|
|
1358
1358
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
|
|
1359
1359
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
@@ -1378,7 +1378,7 @@ declare namespace Office {
|
|
|
1378
1378
|
*
|
|
1379
1379
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1380
1380
|
*
|
|
1381
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1381
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1382
1382
|
*
|
|
1383
1383
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
|
|
1384
1384
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
@@ -1400,7 +1400,7 @@ declare namespace Office {
|
|
|
1400
1400
|
*
|
|
1401
1401
|
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1402
1402
|
*
|
|
1403
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1403
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1404
1404
|
*
|
|
1405
1405
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
1406
1406
|
* @returns Promise to the access token.
|
|
@@ -1849,7 +1849,7 @@ declare namespace Office {
|
|
|
1849
1849
|
*
|
|
1850
1850
|
* @remarks
|
|
1851
1851
|
*
|
|
1852
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1852
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1853
1853
|
*/
|
|
1854
1854
|
interface Dialog {
|
|
1855
1855
|
/**
|
|
@@ -1866,7 +1866,7 @@ declare namespace Office {
|
|
|
1866
1866
|
* - DialogEventReceived. Triggered when the dialog box has been closed or otherwise unloaded.
|
|
1867
1867
|
*
|
|
1868
1868
|
* @param eventType Must be either DialogMessageReceived or DialogEventReceived.
|
|
1869
|
-
* @param handler A function which accepts either an object with a `message` and `origin` property, if `eventType` is `DialogMessageReceived`, or an object with an `error` property, if `eventType` is `DialogEventReceived`. Note that the `origin` property is `undefined` on clients that don’t support {@link https://docs.microsoft.com/
|
|
1869
|
+
* @param handler A function which accepts either an object with a `message` and `origin` property, if `eventType` is `DialogMessageReceived`, or an object with an `error` property, if `eventType` is `DialogEventReceived`. Note that the `origin` property is `undefined` on clients that don’t support {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1}.
|
|
1870
1870
|
*/
|
|
1871
1871
|
addEventHandler(eventType: Office.EventType, handler: (args: {message: string, origin: string | undefined} | {error: number}) => void): void;
|
|
1872
1872
|
/**
|
|
@@ -1878,11 +1878,11 @@ declare namespace Office {
|
|
|
1878
1878
|
*
|
|
1879
1879
|
* **Requirement sets**:
|
|
1880
1880
|
*
|
|
1881
|
-
* - {@link https://docs.microsoft.com/
|
|
1881
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1882
1882
|
*
|
|
1883
|
-
* - {@link https://docs.microsoft.com/
|
|
1883
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.9}
|
|
1884
1884
|
*
|
|
1885
|
-
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/
|
|
1885
|
+
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required.
|
|
1886
1886
|
*
|
|
1887
1887
|
* @param message Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent.
|
|
1888
1888
|
* @param messageOptions Optional. Provides options for how to send the message.
|
|
@@ -1959,21 +1959,21 @@ declare namespace Office {
|
|
|
1959
1959
|
*
|
|
1960
1960
|
* Application and platform support for each `CoercionType` is specified in the following requirement set descriptions.
|
|
1961
1961
|
*
|
|
1962
|
-
* - {@link https://docs.microsoft.com/
|
|
1962
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
1963
1963
|
*
|
|
1964
|
-
* - {@link https://docs.microsoft.com/
|
|
1964
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion 1.1} (when using `Office.CoercionType.Image`)
|
|
1965
1965
|
*
|
|
1966
|
-
* - {@link https://docs.microsoft.com/
|
|
1966
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
1967
1967
|
*
|
|
1968
|
-
* - {@link https://docs.microsoft.com/
|
|
1968
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
1969
1969
|
*
|
|
1970
|
-
* - {@link https://docs.microsoft.com/
|
|
1970
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
1971
1971
|
*
|
|
1972
|
-
* - {@link https://docs.microsoft.com/
|
|
1972
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
1973
1973
|
*
|
|
1974
|
-
* - {@link https://docs.microsoft.com/
|
|
1974
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
1975
1975
|
*
|
|
1976
|
-
* - {@link https://docs.microsoft.com/
|
|
1976
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
1977
1977
|
*
|
|
1978
1978
|
*/
|
|
1979
1979
|
enum CoercionType {
|
|
@@ -2255,7 +2255,11 @@ declare namespace Office {
|
|
|
2255
2255
|
*/
|
|
2256
2256
|
Text,
|
|
2257
2257
|
/**
|
|
2258
|
-
* Returns the entire document (.pptx, .docx, or .
|
|
2258
|
+
* Returns the entire document (.pptx, .docx, .xlsx, or .xlsm) in Office Open XML (OOXML) format as a byte array.
|
|
2259
|
+
*
|
|
2260
|
+
* Note: The .xslm file type is supported in Excel on Windows and Mac. It's not supported in Excel on the web.
|
|
2261
|
+
* In Excel on Windows, the file slices from the `getFileAsync` method include the VBA signature files for .xslm file types. The VBA signature files are vbaProjectSignature.bin, vbaProbjectSignatureAgile.bin, and vbaProjectSignatureV3.bin.
|
|
2262
|
+
* In Excel on Mac, the file slices from the `getFileAsync` method don't include the VBA signature files, because this platform doesn't support the VBA signature feature.
|
|
2259
2263
|
*/
|
|
2260
2264
|
Compressed,
|
|
2261
2265
|
/**
|
|
@@ -2378,11 +2382,11 @@ declare namespace Office {
|
|
|
2378
2382
|
*
|
|
2379
2383
|
* **Requirement sets**:
|
|
2380
2384
|
*
|
|
2381
|
-
* - {@link https://docs.microsoft.com/
|
|
2385
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2382
2386
|
*
|
|
2383
|
-
* - {@link https://docs.microsoft.com/
|
|
2387
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2384
2388
|
*
|
|
2385
|
-
* - {@link https://docs.microsoft.com/
|
|
2389
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2386
2390
|
*/
|
|
2387
2391
|
interface Binding {
|
|
2388
2392
|
/**
|
|
@@ -2403,7 +2407,7 @@ declare namespace Office {
|
|
|
2403
2407
|
*
|
|
2404
2408
|
* @remarks
|
|
2405
2409
|
*
|
|
2406
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2410
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2407
2411
|
*
|
|
2408
2412
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
2409
2413
|
*
|
|
@@ -2419,7 +2423,7 @@ declare namespace Office {
|
|
|
2419
2423
|
*
|
|
2420
2424
|
* @remarks
|
|
2421
2425
|
*
|
|
2422
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2426
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2423
2427
|
*
|
|
2424
2428
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
2425
2429
|
*
|
|
@@ -2435,21 +2439,21 @@ declare namespace Office {
|
|
|
2435
2439
|
*
|
|
2436
2440
|
* **Requirement sets**:
|
|
2437
2441
|
*
|
|
2438
|
-
* - {@link https://docs.microsoft.com/
|
|
2442
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2439
2443
|
*
|
|
2440
|
-
* - {@link https://docs.microsoft.com/
|
|
2444
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2441
2445
|
*
|
|
2442
|
-
* - {@link https://docs.microsoft.com/
|
|
2446
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2443
2447
|
*
|
|
2444
|
-
* - {@link https://docs.microsoft.com/
|
|
2448
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2445
2449
|
*
|
|
2446
|
-
* - {@link https://docs.microsoft.com/
|
|
2450
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2447
2451
|
*
|
|
2448
|
-
* - {@link https://docs.microsoft.com/
|
|
2452
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2449
2453
|
*
|
|
2450
|
-
* - {@link https://docs.microsoft.com/
|
|
2454
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2451
2455
|
*
|
|
2452
|
-
* - {@link https://docs.microsoft.com/
|
|
2456
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2453
2457
|
*
|
|
2454
2458
|
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
|
|
2455
2459
|
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
|
|
@@ -2467,21 +2471,21 @@ declare namespace Office {
|
|
|
2467
2471
|
*
|
|
2468
2472
|
* **Requirement sets**:
|
|
2469
2473
|
*
|
|
2470
|
-
* - {@link https://docs.microsoft.com/
|
|
2474
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2471
2475
|
*
|
|
2472
|
-
* - {@link https://docs.microsoft.com/
|
|
2476
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2473
2477
|
*
|
|
2474
|
-
* - {@link https://docs.microsoft.com/
|
|
2478
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2475
2479
|
*
|
|
2476
|
-
* - {@link https://docs.microsoft.com/
|
|
2480
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2477
2481
|
*
|
|
2478
|
-
* - {@link https://docs.microsoft.com/
|
|
2482
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2479
2483
|
*
|
|
2480
|
-
* - {@link https://docs.microsoft.com/
|
|
2484
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2481
2485
|
*
|
|
2482
|
-
* - {@link https://docs.microsoft.com/
|
|
2486
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2483
2487
|
*
|
|
2484
|
-
* - {@link https://docs.microsoft.com/
|
|
2488
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2485
2489
|
*
|
|
2486
2490
|
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
|
|
2487
2491
|
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
|
|
@@ -2496,7 +2500,7 @@ declare namespace Office {
|
|
|
2496
2500
|
*
|
|
2497
2501
|
* @remarks
|
|
2498
2502
|
*
|
|
2499
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2503
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2500
2504
|
*
|
|
2501
2505
|
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
|
|
2502
2506
|
* @param options Provides options to determine which event handler or handlers are removed.
|
|
@@ -2508,7 +2512,7 @@ declare namespace Office {
|
|
|
2508
2512
|
*
|
|
2509
2513
|
* @remarks
|
|
2510
2514
|
*
|
|
2511
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2515
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2512
2516
|
*
|
|
2513
2517
|
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
|
|
2514
2518
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -2521,21 +2525,21 @@ declare namespace Office {
|
|
|
2521
2525
|
*
|
|
2522
2526
|
* **Requirement sets**:
|
|
2523
2527
|
*
|
|
2524
|
-
* - {@link https://docs.microsoft.com/
|
|
2528
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2525
2529
|
*
|
|
2526
|
-
* - {@link https://docs.microsoft.com/
|
|
2530
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2527
2531
|
*
|
|
2528
|
-
* - {@link https://docs.microsoft.com/
|
|
2532
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2529
2533
|
*
|
|
2530
|
-
* - {@link https://docs.microsoft.com/
|
|
2534
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2531
2535
|
*
|
|
2532
|
-
* - {@link https://docs.microsoft.com/
|
|
2536
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2533
2537
|
*
|
|
2534
|
-
* - {@link https://docs.microsoft.com/
|
|
2538
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2535
2539
|
*
|
|
2536
|
-
* - {@link https://docs.microsoft.com/
|
|
2540
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2537
2541
|
*
|
|
2538
|
-
* - {@link https://docs.microsoft.com/
|
|
2542
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2539
2543
|
*
|
|
2540
2544
|
* The value passed for data contains the data to be written in the binding. The kind of value passed determines what will be written as
|
|
2541
2545
|
* described in the following table.
|
|
@@ -2668,21 +2672,21 @@ declare namespace Office {
|
|
|
2668
2672
|
*
|
|
2669
2673
|
* **Requirement sets**:
|
|
2670
2674
|
*
|
|
2671
|
-
* - {@link https://docs.microsoft.com/
|
|
2675
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2672
2676
|
*
|
|
2673
|
-
* - {@link https://docs.microsoft.com/
|
|
2677
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2674
2678
|
*
|
|
2675
|
-
* - {@link https://docs.microsoft.com/
|
|
2679
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2676
2680
|
*
|
|
2677
|
-
* - {@link https://docs.microsoft.com/
|
|
2681
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2678
2682
|
*
|
|
2679
|
-
* - {@link https://docs.microsoft.com/
|
|
2683
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2680
2684
|
*
|
|
2681
|
-
* - {@link https://docs.microsoft.com/
|
|
2685
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2682
2686
|
*
|
|
2683
|
-
* - {@link https://docs.microsoft.com/
|
|
2687
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2684
2688
|
*
|
|
2685
|
-
* - {@link https://docs.microsoft.com/
|
|
2689
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2686
2690
|
*
|
|
2687
2691
|
* The value passed for data contains the data to be written in the binding. The kind of value passed determines what will be written as
|
|
2688
2692
|
* described in the following table.
|
|
@@ -2892,11 +2896,11 @@ declare namespace Office {
|
|
|
2892
2896
|
*
|
|
2893
2897
|
* **Requirement sets**:
|
|
2894
2898
|
*
|
|
2895
|
-
* - {@link https://docs.microsoft.com/
|
|
2899
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2896
2900
|
*
|
|
2897
|
-
* - {@link https://docs.microsoft.com/
|
|
2901
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2898
2902
|
*
|
|
2899
|
-
* - {@link https://docs.microsoft.com/
|
|
2903
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2900
2904
|
*
|
|
2901
2905
|
* For Excel, the itemName parameter can refer to a named range or a table.
|
|
2902
2906
|
*
|
|
@@ -2928,9 +2932,9 @@ declare namespace Office {
|
|
|
2928
2932
|
*
|
|
2929
2933
|
* @remarks
|
|
2930
2934
|
*
|
|
2931
|
-
* {@link https://docs.microsoft.com/
|
|
2932
|
-
* {@link https://docs.microsoft.com/
|
|
2933
|
-
* {@link https://docs.microsoft.com/
|
|
2935
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings},
|
|
2936
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings},
|
|
2937
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2934
2938
|
*
|
|
2935
2939
|
* For Excel, the itemName parameter can refer to a named range or a table.
|
|
2936
2940
|
*
|
|
@@ -2961,7 +2965,7 @@ declare namespace Office {
|
|
|
2961
2965
|
*
|
|
2962
2966
|
* @remarks
|
|
2963
2967
|
*
|
|
2964
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2968
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
2965
2969
|
*
|
|
2966
2970
|
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
|
|
2967
2971
|
* The method fails if the specified selection cannot be bound.
|
|
@@ -2978,7 +2982,7 @@ declare namespace Office {
|
|
|
2978
2982
|
*
|
|
2979
2983
|
* @remarks
|
|
2980
2984
|
*
|
|
2981
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2985
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
2982
2986
|
*
|
|
2983
2987
|
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
|
|
2984
2988
|
* The method fails if the specified selection cannot be bound.
|
|
@@ -2996,11 +3000,11 @@ declare namespace Office {
|
|
|
2996
3000
|
*
|
|
2997
3001
|
* **Requirement sets**:
|
|
2998
3002
|
*
|
|
2999
|
-
* - {@link https://docs.microsoft.com/
|
|
3003
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3000
3004
|
*
|
|
3001
|
-
* - {@link https://docs.microsoft.com/
|
|
3005
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3002
3006
|
*
|
|
3003
|
-
* - {@link https://docs.microsoft.com/
|
|
3007
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3004
3008
|
*
|
|
3005
3009
|
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
|
|
3006
3010
|
*
|
|
@@ -3023,11 +3027,11 @@ declare namespace Office {
|
|
|
3023
3027
|
*
|
|
3024
3028
|
* **Requirement sets**:
|
|
3025
3029
|
*
|
|
3026
|
-
* - {@link https://docs.microsoft.com/
|
|
3030
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3027
3031
|
*
|
|
3028
|
-
* - {@link https://docs.microsoft.com/
|
|
3032
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3029
3033
|
*
|
|
3030
|
-
* - {@link https://docs.microsoft.com/
|
|
3034
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3031
3035
|
*
|
|
3032
3036
|
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
|
|
3033
3037
|
*
|
|
@@ -3049,11 +3053,11 @@ declare namespace Office {
|
|
|
3049
3053
|
*
|
|
3050
3054
|
* **Requirement sets**:
|
|
3051
3055
|
*
|
|
3052
|
-
* - {@link https://docs.microsoft.com/
|
|
3056
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3053
3057
|
*
|
|
3054
|
-
* - {@link https://docs.microsoft.com/
|
|
3058
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3055
3059
|
*
|
|
3056
|
-
* - {@link https://docs.microsoft.com/
|
|
3060
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3057
3061
|
*
|
|
3058
3062
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3059
3063
|
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3067,11 +3071,11 @@ declare namespace Office {
|
|
|
3067
3071
|
*
|
|
3068
3072
|
* **Requirement sets**:
|
|
3069
3073
|
*
|
|
3070
|
-
* - {@link https://docs.microsoft.com/
|
|
3074
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3071
3075
|
*
|
|
3072
|
-
* - {@link https://docs.microsoft.com/
|
|
3076
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3073
3077
|
*
|
|
3074
|
-
* - {@link https://docs.microsoft.com/
|
|
3078
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3075
3079
|
*
|
|
3076
3080
|
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3077
3081
|
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
|
|
@@ -3084,11 +3088,11 @@ declare namespace Office {
|
|
|
3084
3088
|
*
|
|
3085
3089
|
* **Requirement sets**:
|
|
3086
3090
|
*
|
|
3087
|
-
* - {@link https://docs.microsoft.com/
|
|
3091
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3088
3092
|
*
|
|
3089
|
-
* - {@link https://docs.microsoft.com/
|
|
3093
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3090
3094
|
*
|
|
3091
|
-
* - {@link https://docs.microsoft.com/
|
|
3095
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3092
3096
|
*
|
|
3093
3097
|
* Fails if the specified id does not exist.
|
|
3094
3098
|
*
|
|
@@ -3105,11 +3109,11 @@ declare namespace Office {
|
|
|
3105
3109
|
*
|
|
3106
3110
|
* **Requirement sets**:
|
|
3107
3111
|
*
|
|
3108
|
-
* - {@link https://docs.microsoft.com/
|
|
3112
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3109
3113
|
*
|
|
3110
|
-
* - {@link https://docs.microsoft.com/
|
|
3114
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3111
3115
|
*
|
|
3112
|
-
* - {@link https://docs.microsoft.com/
|
|
3116
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3113
3117
|
*
|
|
3114
3118
|
* Fails if the specified id does not exist.
|
|
3115
3119
|
*
|
|
@@ -3125,11 +3129,11 @@ declare namespace Office {
|
|
|
3125
3129
|
*
|
|
3126
3130
|
* **Requirement sets**:
|
|
3127
3131
|
*
|
|
3128
|
-
* - {@link https://docs.microsoft.com/
|
|
3132
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3129
3133
|
*
|
|
3130
|
-
* - {@link https://docs.microsoft.com/
|
|
3134
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3131
3135
|
*
|
|
3132
|
-
* - {@link https://docs.microsoft.com/
|
|
3136
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3133
3137
|
*
|
|
3134
3138
|
* Fails if the specified id does not exist.
|
|
3135
3139
|
*
|
|
@@ -3145,11 +3149,11 @@ declare namespace Office {
|
|
|
3145
3149
|
*
|
|
3146
3150
|
* **Requirement sets**:
|
|
3147
3151
|
*
|
|
3148
|
-
* - {@link https://docs.microsoft.com/
|
|
3152
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3149
3153
|
*
|
|
3150
|
-
* - {@link https://docs.microsoft.com/
|
|
3154
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3151
3155
|
*
|
|
3152
|
-
* - {@link https://docs.microsoft.com/
|
|
3156
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3153
3157
|
*
|
|
3154
3158
|
* Fails if the specified id does not exist.
|
|
3155
3159
|
*
|
|
@@ -3183,7 +3187,7 @@ declare namespace Office {
|
|
|
3183
3187
|
*
|
|
3184
3188
|
* @remarks
|
|
3185
3189
|
*
|
|
3186
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3190
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3187
3191
|
*
|
|
3188
3192
|
* @param xPath The XPath expression that specifies the nodes to get. Required.
|
|
3189
3193
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3196,7 +3200,7 @@ declare namespace Office {
|
|
|
3196
3200
|
*
|
|
3197
3201
|
* @remarks
|
|
3198
3202
|
*
|
|
3199
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3203
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3200
3204
|
*
|
|
3201
3205
|
* @param xPath The XPath expression that specifies the nodes to get. Required.
|
|
3202
3206
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3208,7 +3212,7 @@ declare namespace Office {
|
|
|
3208
3212
|
*
|
|
3209
3213
|
* @remarks
|
|
3210
3214
|
*
|
|
3211
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3215
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3212
3216
|
*
|
|
3213
3217
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3214
3218
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3220,7 +3224,7 @@ declare namespace Office {
|
|
|
3220
3224
|
*
|
|
3221
3225
|
* @remarks
|
|
3222
3226
|
*
|
|
3223
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3227
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3224
3228
|
*
|
|
3225
3229
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3226
3230
|
* The `value` property of the result is a string that contains the value of the referenced node.
|
|
@@ -3231,7 +3235,7 @@ declare namespace Office {
|
|
|
3231
3235
|
*
|
|
3232
3236
|
* @remarks
|
|
3233
3237
|
*
|
|
3234
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3238
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3235
3239
|
*
|
|
3236
3240
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3237
3241
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3243,7 +3247,7 @@ declare namespace Office {
|
|
|
3243
3247
|
*
|
|
3244
3248
|
* @remarks
|
|
3245
3249
|
*
|
|
3246
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3250
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3247
3251
|
*
|
|
3248
3252
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3249
3253
|
* The `value` property of the result is a string that contains the inner text of the referenced nodes.
|
|
@@ -3254,7 +3258,7 @@ declare namespace Office {
|
|
|
3254
3258
|
*
|
|
3255
3259
|
* @remarks
|
|
3256
3260
|
*
|
|
3257
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3261
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3258
3262
|
*
|
|
3259
3263
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3260
3264
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3266,7 +3270,7 @@ declare namespace Office {
|
|
|
3266
3270
|
*
|
|
3267
3271
|
* @remarks
|
|
3268
3272
|
*
|
|
3269
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3273
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3270
3274
|
*
|
|
3271
3275
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3272
3276
|
* The `value` property of the result is a string that contains the XML of the referenced node.
|
|
@@ -3277,7 +3281,7 @@ declare namespace Office {
|
|
|
3277
3281
|
*
|
|
3278
3282
|
* @remarks
|
|
3279
3283
|
*
|
|
3280
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3284
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3281
3285
|
*
|
|
3282
3286
|
* @param value The value to be set on the node
|
|
3283
3287
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3289,7 +3293,7 @@ declare namespace Office {
|
|
|
3289
3293
|
*
|
|
3290
3294
|
* @remarks
|
|
3291
3295
|
*
|
|
3292
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3296
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3293
3297
|
*
|
|
3294
3298
|
* @param value The value to be set on the node
|
|
3295
3299
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3300,7 +3304,7 @@ declare namespace Office {
|
|
|
3300
3304
|
*
|
|
3301
3305
|
* @remarks
|
|
3302
3306
|
*
|
|
3303
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3307
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3304
3308
|
*
|
|
3305
3309
|
* @param text Required. The text value of the XML node.
|
|
3306
3310
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3312,7 +3316,7 @@ declare namespace Office {
|
|
|
3312
3316
|
*
|
|
3313
3317
|
* @remarks
|
|
3314
3318
|
*
|
|
3315
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3319
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3316
3320
|
*
|
|
3317
3321
|
* @param text Required. The text value of the XML node.
|
|
3318
3322
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3323,7 +3327,7 @@ declare namespace Office {
|
|
|
3323
3327
|
*
|
|
3324
3328
|
* @remarks
|
|
3325
3329
|
*
|
|
3326
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3330
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3327
3331
|
*
|
|
3328
3332
|
* @param xml The XML to be set on the node
|
|
3329
3333
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3335,7 +3339,7 @@ declare namespace Office {
|
|
|
3335
3339
|
*
|
|
3336
3340
|
* @remarks
|
|
3337
3341
|
*
|
|
3338
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3342
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3339
3343
|
*
|
|
3340
3344
|
* @param xml The XML to be set on the node
|
|
3341
3345
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3367,7 +3371,7 @@ declare namespace Office {
|
|
|
3367
3371
|
*
|
|
3368
3372
|
* @remarks
|
|
3369
3373
|
*
|
|
3370
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3374
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3371
3375
|
*
|
|
3372
3376
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3373
3377
|
*
|
|
@@ -3384,7 +3388,7 @@ declare namespace Office {
|
|
|
3384
3388
|
*
|
|
3385
3389
|
* @remarks
|
|
3386
3390
|
*
|
|
3387
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3391
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3388
3392
|
*
|
|
3389
3393
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3390
3394
|
*
|
|
@@ -3400,7 +3404,7 @@ declare namespace Office {
|
|
|
3400
3404
|
*
|
|
3401
3405
|
* @remarks
|
|
3402
3406
|
*
|
|
3403
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3407
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3404
3408
|
*
|
|
3405
3409
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3406
3410
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3411,7 +3415,7 @@ declare namespace Office {
|
|
|
3411
3415
|
*
|
|
3412
3416
|
* @remarks
|
|
3413
3417
|
*
|
|
3414
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3418
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3415
3419
|
*
|
|
3416
3420
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3417
3421
|
*/
|
|
@@ -3421,7 +3425,7 @@ declare namespace Office {
|
|
|
3421
3425
|
*
|
|
3422
3426
|
* @remarks
|
|
3423
3427
|
*
|
|
3424
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3428
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3425
3429
|
*
|
|
3426
3430
|
* @param xPath An XPath expression that specifies the nodes you want returned. Required.
|
|
3427
3431
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3434,7 +3438,7 @@ declare namespace Office {
|
|
|
3434
3438
|
*
|
|
3435
3439
|
* @remarks
|
|
3436
3440
|
*
|
|
3437
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3441
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3438
3442
|
*
|
|
3439
3443
|
* @param xPath An XPath expression that specifies the nodes you want returned. Required.
|
|
3440
3444
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3446,7 +3450,7 @@ declare namespace Office {
|
|
|
3446
3450
|
*
|
|
3447
3451
|
* @remarks
|
|
3448
3452
|
*
|
|
3449
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3453
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3450
3454
|
*
|
|
3451
3455
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3452
3456
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3458,7 +3462,7 @@ declare namespace Office {
|
|
|
3458
3462
|
*
|
|
3459
3463
|
* @remarks
|
|
3460
3464
|
*
|
|
3461
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3465
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3462
3466
|
*
|
|
3463
3467
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3464
3468
|
* The `value` property of the result is a string that contains the XML of the referenced CustomXmlPart object.
|
|
@@ -3469,7 +3473,7 @@ declare namespace Office {
|
|
|
3469
3473
|
*
|
|
3470
3474
|
* @remarks
|
|
3471
3475
|
*
|
|
3472
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3476
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3473
3477
|
*
|
|
3474
3478
|
* @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as
|
|
3475
3479
|
* `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`.
|
|
@@ -3483,7 +3487,7 @@ declare namespace Office {
|
|
|
3483
3487
|
*
|
|
3484
3488
|
* @remarks
|
|
3485
3489
|
*
|
|
3486
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3490
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3487
3491
|
*
|
|
3488
3492
|
* @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as
|
|
3489
3493
|
* `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`.
|
|
@@ -3566,7 +3570,7 @@ declare namespace Office {
|
|
|
3566
3570
|
*
|
|
3567
3571
|
* @remarks
|
|
3568
3572
|
*
|
|
3569
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3573
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3570
3574
|
*
|
|
3571
3575
|
* @param xml The XML to add to the newly created custom XML part.
|
|
3572
3576
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3579,7 +3583,7 @@ declare namespace Office {
|
|
|
3579
3583
|
*
|
|
3580
3584
|
* @remarks
|
|
3581
3585
|
*
|
|
3582
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3586
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3583
3587
|
*
|
|
3584
3588
|
* @param xml The XML to add to the newly created custom XML part.
|
|
3585
3589
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3591,7 +3595,7 @@ declare namespace Office {
|
|
|
3591
3595
|
*
|
|
3592
3596
|
* @remarks
|
|
3593
3597
|
*
|
|
3594
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3598
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3595
3599
|
*
|
|
3596
3600
|
* @param id The GUID of the custom XML part, including opening and closing braces.
|
|
3597
3601
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3605,7 +3609,7 @@ declare namespace Office {
|
|
|
3605
3609
|
*
|
|
3606
3610
|
* @remarks
|
|
3607
3611
|
*
|
|
3608
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3612
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3609
3613
|
*
|
|
3610
3614
|
* @param id The GUID of the custom XML part, including opening and closing braces.
|
|
3611
3615
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3618,7 +3622,7 @@ declare namespace Office {
|
|
|
3618
3622
|
*
|
|
3619
3623
|
* @remarks
|
|
3620
3624
|
*
|
|
3621
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3625
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3622
3626
|
*
|
|
3623
3627
|
* @param ns The namespace URI.
|
|
3624
3628
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3631,7 +3635,7 @@ declare namespace Office {
|
|
|
3631
3635
|
*
|
|
3632
3636
|
* @remarks
|
|
3633
3637
|
*
|
|
3634
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3638
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3635
3639
|
*
|
|
3636
3640
|
* @param ns The namespace URI.
|
|
3637
3641
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3652,7 +3656,7 @@ declare namespace Office {
|
|
|
3652
3656
|
*
|
|
3653
3657
|
* @remarks
|
|
3654
3658
|
*
|
|
3655
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3659
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3656
3660
|
*
|
|
3657
3661
|
* If no namespace is assigned to the requested prefix, the method returns an empty string ("").
|
|
3658
3662
|
*
|
|
@@ -3667,7 +3671,7 @@ declare namespace Office {
|
|
|
3667
3671
|
*
|
|
3668
3672
|
* @remarks
|
|
3669
3673
|
*
|
|
3670
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3674
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3671
3675
|
*
|
|
3672
3676
|
* If no namespace is assigned to the requested prefix, the method returns an empty string ("").
|
|
3673
3677
|
*
|
|
@@ -3681,7 +3685,7 @@ declare namespace Office {
|
|
|
3681
3685
|
*
|
|
3682
3686
|
* @remarks
|
|
3683
3687
|
*
|
|
3684
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3688
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3685
3689
|
*
|
|
3686
3690
|
* If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one
|
|
3687
3691
|
* added or used by the data store internally, in which case it will return an error.
|
|
@@ -3697,7 +3701,7 @@ declare namespace Office {
|
|
|
3697
3701
|
*
|
|
3698
3702
|
* @remarks
|
|
3699
3703
|
*
|
|
3700
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3704
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3701
3705
|
*
|
|
3702
3706
|
* If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one
|
|
3703
3707
|
* added or used by the data store internally, in which case it will return an error.
|
|
@@ -3712,7 +3716,7 @@ declare namespace Office {
|
|
|
3712
3716
|
*
|
|
3713
3717
|
* @remarks
|
|
3714
3718
|
*
|
|
3715
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3719
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3716
3720
|
*
|
|
3717
3721
|
* If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in
|
|
3718
3722
|
* the namespace manager, the method returns the first prefix that matches the supplied namespace.
|
|
@@ -3728,7 +3732,7 @@ declare namespace Office {
|
|
|
3728
3732
|
*
|
|
3729
3733
|
* @remarks
|
|
3730
3734
|
*
|
|
3731
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3735
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3732
3736
|
*
|
|
3733
3737
|
* If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in
|
|
3734
3738
|
* the namespace manager, the method returns the first prefix that matches the supplied namespace.
|
|
@@ -3777,7 +3781,7 @@ declare namespace Office {
|
|
|
3777
3781
|
*
|
|
3778
3782
|
* @remarks
|
|
3779
3783
|
*
|
|
3780
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3784
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
3781
3785
|
*
|
|
3782
3786
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3783
3787
|
*
|
|
@@ -3793,7 +3797,7 @@ declare namespace Office {
|
|
|
3793
3797
|
*
|
|
3794
3798
|
* @remarks
|
|
3795
3799
|
*
|
|
3796
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3800
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
3797
3801
|
*
|
|
3798
3802
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3799
3803
|
*
|
|
@@ -3808,7 +3812,7 @@ declare namespace Office {
|
|
|
3808
3812
|
*
|
|
3809
3813
|
* @remarks
|
|
3810
3814
|
*
|
|
3811
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3815
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#activeview | ActiveView}
|
|
3812
3816
|
*
|
|
3813
3817
|
* Can trigger an event when the view changes.
|
|
3814
3818
|
*
|
|
@@ -3824,7 +3828,7 @@ declare namespace Office {
|
|
|
3824
3828
|
*
|
|
3825
3829
|
* @remarks
|
|
3826
3830
|
*
|
|
3827
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3831
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#activeview | ActiveView}
|
|
3828
3832
|
*
|
|
3829
3833
|
* Can trigger an event when the view changes.
|
|
3830
3834
|
*
|
|
@@ -3842,11 +3846,11 @@ declare namespace Office {
|
|
|
3842
3846
|
*
|
|
3843
3847
|
* **Requirement sets**:
|
|
3844
3848
|
*
|
|
3845
|
-
* - {@link https://docs.microsoft.com/
|
|
3849
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`)
|
|
3846
3850
|
*
|
|
3847
|
-
* - {@link https://docs.microsoft.com/
|
|
3851
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
3848
3852
|
*
|
|
3849
|
-
* - {@link https://docs.microsoft.com/
|
|
3853
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`)
|
|
3850
3854
|
*
|
|
3851
3855
|
* For add-ins running in Office host applications other than Office on iPad, the `getFileAsync` method supports getting files in slices of up
|
|
3852
3856
|
* to 4194304 bytes (4 MB). For add-ins running in Office apps on iPad, the `getFileAsync` method supports getting files in slices of up to
|
|
@@ -3877,11 +3881,11 @@ declare namespace Office {
|
|
|
3877
3881
|
*
|
|
3878
3882
|
* **Requirement sets**:
|
|
3879
3883
|
*
|
|
3880
|
-
* - {@link https://docs.microsoft.com/
|
|
3884
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`)
|
|
3881
3885
|
*
|
|
3882
|
-
* - {@link https://docs.microsoft.com/
|
|
3886
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
3883
3887
|
*
|
|
3884
|
-
* - {@link https://docs.microsoft.com/
|
|
3888
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`)
|
|
3885
3889
|
*
|
|
3886
3890
|
* For add-ins running in Office host applications other than Office on iPad, the `getFileAsync` method supports getting files in slices of up
|
|
3887
3891
|
* to 4194304 bytes (4 MB). For add-ins running in Office on iPad apps, the `getFileAsync` method supports getting files in slices of up to
|
|
@@ -3908,7 +3912,7 @@ declare namespace Office {
|
|
|
3908
3912
|
*
|
|
3909
3913
|
* @remarks
|
|
3910
3914
|
*
|
|
3911
|
-
* **Requirement sets**: {@link https://docs.microsoft.com/
|
|
3915
|
+
* **Requirement sets**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
3912
3916
|
*
|
|
3913
3917
|
* You get the file's URL with the url property `asyncResult.value.url`.
|
|
3914
3918
|
*
|
|
@@ -3922,7 +3926,7 @@ declare namespace Office {
|
|
|
3922
3926
|
*
|
|
3923
3927
|
* @remarks
|
|
3924
3928
|
*
|
|
3925
|
-
* **Requirement sets**: {@link https://docs.microsoft.com/
|
|
3929
|
+
* **Requirement sets**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
3926
3930
|
*
|
|
3927
3931
|
* You get the file's URL with the url property `asyncResult.value.url`.
|
|
3928
3932
|
*
|
|
@@ -3937,17 +3941,17 @@ declare namespace Office {
|
|
|
3937
3941
|
*
|
|
3938
3942
|
* **Requirement sets**:
|
|
3939
3943
|
*
|
|
3940
|
-
* - {@link https://docs.microsoft.com/
|
|
3944
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
3941
3945
|
*
|
|
3942
|
-
* - {@link https://docs.microsoft.com/
|
|
3946
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
3943
3947
|
*
|
|
3944
|
-
* - {@link https://docs.microsoft.com/
|
|
3948
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
3945
3949
|
*
|
|
3946
|
-
* - {@link https://docs.microsoft.com/
|
|
3950
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
3947
3951
|
*
|
|
3948
|
-
* - {@link https://docs.microsoft.com/
|
|
3952
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
3949
3953
|
*
|
|
3950
|
-
* - {@link https://docs.microsoft.com/
|
|
3954
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
3951
3955
|
*
|
|
3952
3956
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
3953
3957
|
* the following information.
|
|
@@ -4007,7 +4011,7 @@ declare namespace Office {
|
|
|
4007
4011
|
* <td>`Office.CoercionType.SlideRange`</td>
|
|
4008
4012
|
* </tr>
|
|
4009
4013
|
* <tr>
|
|
4010
|
-
* <td>Excel, PowerPoint, and Word</td>
|
|
4014
|
+
* <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
|
|
4011
4015
|
* <td>`Office.CoercionType.XmlSvg`</td>
|
|
4012
4016
|
* </tr>
|
|
4013
4017
|
* </table>
|
|
@@ -4029,17 +4033,17 @@ declare namespace Office {
|
|
|
4029
4033
|
*
|
|
4030
4034
|
* **Requirement sets**:
|
|
4031
4035
|
*
|
|
4032
|
-
* - {@link https://docs.microsoft.com/
|
|
4036
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
4033
4037
|
*
|
|
4034
|
-
* - {@link https://docs.microsoft.com/
|
|
4038
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4035
4039
|
*
|
|
4036
|
-
* - {@link https://docs.microsoft.com/
|
|
4040
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4037
4041
|
*
|
|
4038
|
-
* - {@link https://docs.microsoft.com/
|
|
4042
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4039
4043
|
*
|
|
4040
|
-
* - {@link https://docs.microsoft.com/
|
|
4044
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4041
4045
|
*
|
|
4042
|
-
* - {@link https://docs.microsoft.com/
|
|
4046
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4043
4047
|
*
|
|
4044
4048
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
4045
4049
|
* the following information.
|
|
@@ -4099,7 +4103,7 @@ declare namespace Office {
|
|
|
4099
4103
|
* <td>`Office.CoercionType.SlideRange`</td>
|
|
4100
4104
|
* </tr>
|
|
4101
4105
|
* <tr>
|
|
4102
|
-
* <td>Excel, PowerPoint, and Word</td>
|
|
4106
|
+
* <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
|
|
4103
4107
|
* <td>`Office.CoercionType.XmlSvg`</td>
|
|
4104
4108
|
* </tr>
|
|
4105
4109
|
* </table>
|
|
@@ -4116,7 +4120,7 @@ declare namespace Office {
|
|
|
4116
4120
|
*
|
|
4117
4121
|
* @remarks
|
|
4118
4122
|
*
|
|
4119
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4123
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
4120
4124
|
*
|
|
4121
4125
|
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
|
|
4122
4126
|
*
|
|
@@ -4143,7 +4147,7 @@ declare namespace Office {
|
|
|
4143
4147
|
*
|
|
4144
4148
|
* @remarks
|
|
4145
4149
|
*
|
|
4146
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4150
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
4147
4151
|
*
|
|
4148
4152
|
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
|
|
4149
4153
|
*
|
|
@@ -4169,7 +4173,7 @@ declare namespace Office {
|
|
|
4169
4173
|
*
|
|
4170
4174
|
* @remarks
|
|
4171
4175
|
*
|
|
4172
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4176
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
4173
4177
|
*
|
|
4174
4178
|
* @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'.
|
|
4175
4179
|
* @param options Provides options to determine which event handler or handlers are removed.
|
|
@@ -4181,7 +4185,7 @@ declare namespace Office {
|
|
|
4181
4185
|
*
|
|
4182
4186
|
* @remarks
|
|
4183
4187
|
*
|
|
4184
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4188
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
4185
4189
|
*
|
|
4186
4190
|
* @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'.
|
|
4187
4191
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -4194,21 +4198,21 @@ declare namespace Office {
|
|
|
4194
4198
|
*
|
|
4195
4199
|
* **Requirement sets**:
|
|
4196
4200
|
*
|
|
4197
|
-
* - {@link https://docs.microsoft.com/
|
|
4201
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
4198
4202
|
*
|
|
4199
|
-
* - {@link https://docs.microsoft.com/
|
|
4203
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion 1.1} (when using `Office.CoercionType.Image`)
|
|
4200
4204
|
*
|
|
4201
|
-
* - {@link https://docs.microsoft.com/
|
|
4205
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4202
4206
|
*
|
|
4203
|
-
* - {@link https://docs.microsoft.com/
|
|
4207
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4204
4208
|
*
|
|
4205
|
-
* - {@link https://docs.microsoft.com/
|
|
4209
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4206
4210
|
*
|
|
4207
|
-
* - {@link https://docs.microsoft.com/
|
|
4211
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4208
4212
|
*
|
|
4209
|
-
* - {@link https://docs.microsoft.com/
|
|
4213
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4210
4214
|
*
|
|
4211
|
-
* - {@link https://docs.microsoft.com/
|
|
4215
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
4212
4216
|
*
|
|
4213
4217
|
* **Application-specific behaviors**
|
|
4214
4218
|
*
|
|
@@ -4339,7 +4343,7 @@ declare namespace Office {
|
|
|
4339
4343
|
* <td>`Office.CoercionType.SlideRange`</td>
|
|
4340
4344
|
* </tr>
|
|
4341
4345
|
* <tr>
|
|
4342
|
-
* <td>Excel, PowerPoint, and Word</td>
|
|
4346
|
+
* <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
|
|
4343
4347
|
* <td>`Office.CoercionType.XmlSvg`</td>
|
|
4344
4348
|
* </tr>
|
|
4345
4349
|
* </table>
|
|
@@ -4384,21 +4388,21 @@ declare namespace Office {
|
|
|
4384
4388
|
*
|
|
4385
4389
|
* **Requirement sets**:
|
|
4386
4390
|
*
|
|
4387
|
-
* - {@link https://docs.microsoft.com/
|
|
4391
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
4388
4392
|
*
|
|
4389
|
-
* - {@link https://docs.microsoft.com/
|
|
4393
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion} (when using `Office.CoercionType.Image`)
|
|
4390
4394
|
*
|
|
4391
|
-
* - {@link https://docs.microsoft.com/
|
|
4395
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4392
4396
|
*
|
|
4393
|
-
* - {@link https://docs.microsoft.com/
|
|
4397
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4394
4398
|
*
|
|
4395
|
-
* - {@link https://docs.microsoft.com/
|
|
4399
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4396
4400
|
*
|
|
4397
|
-
* - {@link https://docs.microsoft.com/
|
|
4401
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4398
4402
|
*
|
|
4399
|
-
* - {@link https://docs.microsoft.com/
|
|
4403
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4400
4404
|
*
|
|
4401
|
-
* - {@link https://docs.microsoft.com/
|
|
4405
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
4402
4406
|
*
|
|
4403
4407
|
* **Application-specific behaviors**
|
|
4404
4408
|
*
|
|
@@ -4528,7 +4532,7 @@ declare namespace Office {
|
|
|
4528
4532
|
* <td>`Office.CoercionType.SlideRange`</td>
|
|
4529
4533
|
* </tr>
|
|
4530
4534
|
* <tr>
|
|
4531
|
-
* <td>Excel, PowerPoint, and Word</td>
|
|
4535
|
+
* <td>Excel on Windows and Mac, PowerPoint on Windows, Mac, and the web, and Word on Windows and Mac</td>
|
|
4532
4536
|
* <td>`Office.CoercionType.XmlSvg`</td>
|
|
4533
4537
|
* </tr>
|
|
4534
4538
|
* </table>
|
|
@@ -4884,7 +4888,7 @@ declare namespace Office {
|
|
|
4884
4888
|
*
|
|
4885
4889
|
* @remarks
|
|
4886
4890
|
*
|
|
4887
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4891
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
4888
4892
|
*
|
|
4889
4893
|
* No more than two documents are allowed to be in memory; otherwise the Document.getFileAsync operation will fail. Use the File.closeAsync
|
|
4890
4894
|
* method to close the file when you are finished working with it.
|
|
@@ -4923,7 +4927,7 @@ declare namespace Office {
|
|
|
4923
4927
|
*
|
|
4924
4928
|
* @remarks
|
|
4925
4929
|
*
|
|
4926
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4930
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
4927
4931
|
*
|
|
4928
4932
|
* In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following
|
|
4929
4933
|
* information.
|
|
@@ -5007,7 +5011,7 @@ declare namespace Office {
|
|
|
5007
5011
|
*
|
|
5008
5012
|
* @remarks
|
|
5009
5013
|
*
|
|
5010
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5014
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5011
5015
|
*
|
|
5012
5016
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
5013
5017
|
*
|
|
@@ -5049,7 +5053,7 @@ declare namespace Office {
|
|
|
5049
5053
|
*
|
|
5050
5054
|
* @remarks
|
|
5051
5055
|
*
|
|
5052
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5056
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5053
5057
|
*
|
|
5054
5058
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
5055
5059
|
*
|
|
@@ -5086,7 +5090,7 @@ declare namespace Office {
|
|
|
5086
5090
|
*
|
|
5087
5091
|
* @remarks
|
|
5088
5092
|
*
|
|
5089
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5093
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5090
5094
|
*
|
|
5091
5095
|
* @param settingName The case-sensitive name of the setting to retrieve.
|
|
5092
5096
|
* @returns An object that has property names mapped to JSON serialized values.
|
|
@@ -5097,7 +5101,7 @@ declare namespace Office {
|
|
|
5097
5101
|
*
|
|
5098
5102
|
* @remarks
|
|
5099
5103
|
*
|
|
5100
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5104
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5101
5105
|
*
|
|
5102
5106
|
* This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against
|
|
5103
5107
|
* the same document. Because each add-in is working against an in-memory copy of the settings loaded from the document at the time the user
|
|
@@ -5144,7 +5148,7 @@ declare namespace Office {
|
|
|
5144
5148
|
*
|
|
5145
5149
|
* @remarks
|
|
5146
5150
|
*
|
|
5147
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5151
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5148
5152
|
*
|
|
5149
5153
|
* null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.
|
|
5150
5154
|
*
|
|
@@ -5156,7 +5160,7 @@ declare namespace Office {
|
|
|
5156
5160
|
*
|
|
5157
5161
|
* @remarks
|
|
5158
5162
|
*
|
|
5159
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5163
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5160
5164
|
*
|
|
5161
5165
|
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
|
|
5162
5166
|
* will be removed.
|
|
@@ -5177,7 +5181,7 @@ declare namespace Office {
|
|
|
5177
5181
|
*
|
|
5178
5182
|
* @remarks
|
|
5179
5183
|
*
|
|
5180
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5184
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5181
5185
|
*
|
|
5182
5186
|
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
|
|
5183
5187
|
* will be removed.
|
|
@@ -5197,7 +5201,7 @@ declare namespace Office {
|
|
|
5197
5201
|
*
|
|
5198
5202
|
* @remarks
|
|
5199
5203
|
*
|
|
5200
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5204
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5201
5205
|
*
|
|
5202
5206
|
* Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the
|
|
5203
5207
|
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
|
|
@@ -5240,7 +5244,7 @@ declare namespace Office {
|
|
|
5240
5244
|
*
|
|
5241
5245
|
* @remarks
|
|
5242
5246
|
*
|
|
5243
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5247
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5244
5248
|
*
|
|
5245
5249
|
* Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the
|
|
5246
5250
|
* set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
|
|
@@ -5287,7 +5291,7 @@ declare namespace Office {
|
|
|
5287
5291
|
*
|
|
5288
5292
|
* @remarks
|
|
5289
5293
|
*
|
|
5290
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5294
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5291
5295
|
*
|
|
5292
5296
|
* The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name
|
|
5293
5297
|
* in the in-memory copy of the settings property bag. After you call the Settings.saveAsync method, the value is stored in the document as
|
|
@@ -5331,7 +5335,7 @@ declare namespace Office {
|
|
|
5331
5335
|
*
|
|
5332
5336
|
* @remarks
|
|
5333
5337
|
*
|
|
5334
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5338
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1}
|
|
5335
5339
|
*/
|
|
5336
5340
|
interface DialogMessageOptions {
|
|
5337
5341
|
/**
|
|
@@ -5356,7 +5360,7 @@ declare namespace Office {
|
|
|
5356
5360
|
*
|
|
5357
5361
|
* @remarks
|
|
5358
5362
|
*
|
|
5359
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5363
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1}.
|
|
5360
5364
|
* The property is `undefined` on clients that do not support this requirement set.
|
|
5361
5365
|
*/
|
|
5362
5366
|
origin: string | undefined;
|
|
@@ -5876,7 +5880,7 @@ declare namespace Office {
|
|
|
5876
5880
|
*
|
|
5877
5881
|
* @remarks
|
|
5878
5882
|
*
|
|
5879
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5883
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5880
5884
|
*
|
|
5881
5885
|
* In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.
|
|
5882
5886
|
*
|
|
@@ -5914,7 +5918,7 @@ declare namespace Office {
|
|
|
5914
5918
|
*
|
|
5915
5919
|
* @remarks
|
|
5916
5920
|
*
|
|
5917
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5921
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
|
|
5918
5922
|
*
|
|
5919
5923
|
* In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.
|
|
5920
5924
|
*
|