@types/office-js-preview 1.0.290 → 1.0.293
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +1000 -390
- office-js-preview/package.json +2 -2
office-js-preview/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
|
/**
|
|
@@ -551,7 +551,7 @@ declare namespace Office {
|
|
|
551
551
|
*
|
|
552
552
|
* @remarks
|
|
553
553
|
*
|
|
554
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
554
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
555
555
|
* @beta
|
|
556
556
|
*
|
|
557
557
|
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
|
|
@@ -566,7 +566,7 @@ declare namespace Office {
|
|
|
566
566
|
*
|
|
567
567
|
* @remarks
|
|
568
568
|
*
|
|
569
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
569
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
570
570
|
* @beta
|
|
571
571
|
*
|
|
572
572
|
* @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
|
|
@@ -577,7 +577,7 @@ declare namespace Office {
|
|
|
577
577
|
*
|
|
578
578
|
* @remarks
|
|
579
579
|
*
|
|
580
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
580
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/keyboard-shortcuts-requirement-sets | KeyboardShortcuts 1.1}
|
|
581
581
|
* @beta
|
|
582
582
|
*
|
|
583
583
|
* @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
|
|
@@ -599,7 +599,7 @@ declare namespace Office {
|
|
|
599
599
|
*
|
|
600
600
|
* @remarks
|
|
601
601
|
*
|
|
602
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
602
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
603
603
|
*/
|
|
604
604
|
interface Addin {
|
|
605
605
|
/**
|
|
@@ -607,14 +607,14 @@ declare namespace Office {
|
|
|
607
607
|
* @param behavior - Specifies startup behavior of the add-in.
|
|
608
608
|
*
|
|
609
609
|
* @remarks
|
|
610
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
610
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
611
611
|
*/
|
|
612
612
|
setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;
|
|
613
613
|
/**
|
|
614
614
|
* Gets the current startup behavior for the add-in.
|
|
615
615
|
*
|
|
616
616
|
* @remarks
|
|
617
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
617
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
618
618
|
*/
|
|
619
619
|
getStartupBehavior(): Promise<Office.StartupBehavior>;
|
|
620
620
|
/**
|
|
@@ -622,7 +622,7 @@ declare namespace Office {
|
|
|
622
622
|
* @returns A promise that is resolved when the UI is shown.
|
|
623
623
|
*
|
|
624
624
|
* @remarks
|
|
625
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
625
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
626
626
|
*/
|
|
627
627
|
showAsTaskpane(): Promise<void>;
|
|
628
628
|
/**
|
|
@@ -630,7 +630,7 @@ declare namespace Office {
|
|
|
630
630
|
* @returns A promise that is resolved when the UI is hidden.
|
|
631
631
|
*
|
|
632
632
|
* @remarks
|
|
633
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
633
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
634
634
|
*/
|
|
635
635
|
hide(): Promise<void>;
|
|
636
636
|
/**
|
|
@@ -639,7 +639,7 @@ declare namespace Office {
|
|
|
639
639
|
* @returns A promise that resolves to a function when the handler is added. Calling it removes the handler.
|
|
640
640
|
*
|
|
641
641
|
* @remarks
|
|
642
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
642
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
643
643
|
*/
|
|
644
644
|
onVisibilityModeChanged(
|
|
645
645
|
handler: (message: VisibilityModeChangedMessage) => void,
|
|
@@ -703,7 +703,7 @@ declare namespace Office {
|
|
|
703
703
|
*
|
|
704
704
|
* @remarks
|
|
705
705
|
*
|
|
706
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
706
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
707
707
|
*/
|
|
708
708
|
interface Ribbon {
|
|
709
709
|
/**
|
|
@@ -711,7 +711,7 @@ declare namespace Office {
|
|
|
711
711
|
*
|
|
712
712
|
* @remarks
|
|
713
713
|
*
|
|
714
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
714
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.2}
|
|
715
715
|
*
|
|
716
716
|
* 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.
|
|
717
717
|
* For more information and code examples, see {@link https://docs.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
@@ -724,7 +724,7 @@ declare namespace Office {
|
|
|
724
724
|
*
|
|
725
725
|
* @remarks
|
|
726
726
|
*
|
|
727
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
727
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
728
728
|
*
|
|
729
729
|
* 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.
|
|
730
730
|
*
|
|
@@ -739,7 +739,7 @@ declare namespace Office {
|
|
|
739
739
|
*
|
|
740
740
|
* @remarks
|
|
741
741
|
*
|
|
742
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
742
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
743
743
|
*/
|
|
744
744
|
interface RibbonUpdaterData {
|
|
745
745
|
/**
|
|
@@ -752,7 +752,7 @@ declare namespace Office {
|
|
|
752
752
|
*
|
|
753
753
|
* @remarks
|
|
754
754
|
*
|
|
755
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
755
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
756
756
|
*/
|
|
757
757
|
interface Tab {
|
|
758
758
|
/**
|
|
@@ -772,7 +772,7 @@ declare namespace Office {
|
|
|
772
772
|
*
|
|
773
773
|
* @remarks
|
|
774
774
|
*
|
|
775
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
775
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.2}
|
|
776
776
|
*/
|
|
777
777
|
visible?: boolean;
|
|
778
778
|
/**
|
|
@@ -782,14 +782,14 @@ declare namespace Office {
|
|
|
782
782
|
*
|
|
783
783
|
* 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.
|
|
784
784
|
*
|
|
785
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
785
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
786
786
|
*/
|
|
787
787
|
groups?: Group[];
|
|
788
788
|
}
|
|
789
789
|
/**
|
|
790
790
|
* Represents a group of controls on a ribbon tab.
|
|
791
791
|
*
|
|
792
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
792
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
793
793
|
*/
|
|
794
794
|
interface Group {
|
|
795
795
|
/**
|
|
@@ -813,7 +813,7 @@ declare namespace Office {
|
|
|
813
813
|
*
|
|
814
814
|
* @remarks
|
|
815
815
|
*
|
|
816
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
816
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
817
817
|
*/
|
|
818
818
|
interface Control {
|
|
819
819
|
/**
|
|
@@ -1025,7 +1025,7 @@ declare namespace Office {
|
|
|
1025
1025
|
*
|
|
1026
1026
|
* @remarks
|
|
1027
1027
|
*
|
|
1028
|
-
* See {@link https://docs.microsoft.com/
|
|
1028
|
+
* 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.
|
|
1029
1029
|
*
|
|
1030
1030
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: Restricted
|
|
1031
1031
|
*
|
|
@@ -1037,7 +1037,7 @@ declare namespace Office {
|
|
|
1037
1037
|
*
|
|
1038
1038
|
* @remarks
|
|
1039
1039
|
*
|
|
1040
|
-
* This property is supported in Outlook only in {@link https://docs.microsoft.com/
|
|
1040
|
+
* 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.
|
|
1041
1041
|
*/
|
|
1042
1042
|
source:Source;
|
|
1043
1043
|
|
|
@@ -1048,8 +1048,8 @@ declare namespace Office {
|
|
|
1048
1048
|
*
|
|
1049
1049
|
* - A UI-less button (i.e., an add-in command defined with an `Action` element where the `xsi:type` attribute is set to `ExecuteFunction`)
|
|
1050
1050
|
*
|
|
1051
|
-
* - An {@link https://docs.microsoft.com/
|
|
1052
|
-
* {@link https://docs.microsoft.com/
|
|
1051
|
+
* - An {@link https://docs.microsoft.com/javascript/api/manifest/event | event} defined in the
|
|
1052
|
+
* {@link https://docs.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point},
|
|
1053
1053
|
* e.g., an `ItemSend` event
|
|
1054
1054
|
*
|
|
1055
1055
|
* [Api set: Mailbox 1.3]
|
|
@@ -1113,7 +1113,7 @@ declare namespace Office {
|
|
|
1113
1113
|
*
|
|
1114
1114
|
* @remarks
|
|
1115
1115
|
*
|
|
1116
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1116
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1117
1117
|
*
|
|
1118
1118
|
* You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
|
|
1119
1119
|
*
|
|
@@ -1128,7 +1128,7 @@ declare namespace Office {
|
|
|
1128
1128
|
*
|
|
1129
1129
|
* @remarks
|
|
1130
1130
|
*
|
|
1131
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1131
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1132
1132
|
*
|
|
1133
1133
|
* You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
|
|
1134
1134
|
*
|
|
@@ -1146,9 +1146,9 @@ declare namespace Office {
|
|
|
1146
1146
|
*
|
|
1147
1147
|
* **Requirement sets**:
|
|
1148
1148
|
*
|
|
1149
|
-
* - {@link https://docs.microsoft.com/
|
|
1149
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1150
1150
|
*
|
|
1151
|
-
* - {@link https://docs.microsoft.com/
|
|
1151
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
|
|
1152
1152
|
*
|
|
1153
1153
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
1154
1154
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
@@ -1247,9 +1247,9 @@ declare namespace Office {
|
|
|
1247
1247
|
*
|
|
1248
1248
|
* **Requirement sets**:
|
|
1249
1249
|
*
|
|
1250
|
-
* - {@link https://docs.microsoft.com/
|
|
1250
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1251
1251
|
*
|
|
1252
|
-
* - {@link https://docs.microsoft.com/
|
|
1252
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4}
|
|
1253
1253
|
*
|
|
1254
1254
|
* This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
|
|
1255
1255
|
* for Outlook. For more on how to specify a requirement set in your manifest, see
|
|
@@ -1345,9 +1345,9 @@ declare namespace Office {
|
|
|
1345
1345
|
*
|
|
1346
1346
|
* **Requirement sets**:
|
|
1347
1347
|
*
|
|
1348
|
-
* - {@link https://docs.microsoft.com/
|
|
1348
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1349
1349
|
*
|
|
1350
|
-
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/
|
|
1350
|
+
* - 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.
|
|
1351
1351
|
*
|
|
1352
1352
|
* @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.
|
|
1353
1353
|
* @param messageOptions Optional. Provides options for how to send the message.
|
|
@@ -1362,9 +1362,9 @@ declare namespace Office {
|
|
|
1362
1362
|
*
|
|
1363
1363
|
* **Requirement sets**:
|
|
1364
1364
|
*
|
|
1365
|
-
* - {@link https://docs.microsoft.com/
|
|
1365
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1366
1366
|
*
|
|
1367
|
-
* - {@link https://docs.microsoft.com/
|
|
1367
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.5}
|
|
1368
1368
|
*
|
|
1369
1369
|
* The behavior of this method is specified by the following:
|
|
1370
1370
|
*
|
|
@@ -1381,7 +1381,7 @@ declare namespace Office {
|
|
|
1381
1381
|
*
|
|
1382
1382
|
* @remarks
|
|
1383
1383
|
*
|
|
1384
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1384
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/open-browser-window-api-requirement-sets | OpenBrowserWindowApi 1.1}
|
|
1385
1385
|
*
|
|
1386
1386
|
* @param url The full URL to be opened including protocol (e.g., https), and port number, if any.
|
|
1387
1387
|
*/
|
|
@@ -1463,7 +1463,7 @@ declare namespace Office {
|
|
|
1463
1463
|
*
|
|
1464
1464
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1465
1465
|
*
|
|
1466
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1466
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1467
1467
|
*
|
|
1468
1468
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
|
|
1469
1469
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
@@ -1488,7 +1488,7 @@ declare namespace Office {
|
|
|
1488
1488
|
*
|
|
1489
1489
|
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
|
|
1490
1490
|
*
|
|
1491
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1491
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1492
1492
|
*
|
|
1493
1493
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
|
|
1494
1494
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
@@ -1510,7 +1510,7 @@ declare namespace Office {
|
|
|
1510
1510
|
*
|
|
1511
1511
|
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
|
|
1512
1512
|
*
|
|
1513
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1513
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/identity-api-requirement-sets | IdentityAPI 1.3}
|
|
1514
1514
|
*
|
|
1515
1515
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
1516
1516
|
* @returns Promise to the access token.
|
|
@@ -1959,7 +1959,7 @@ declare namespace Office {
|
|
|
1959
1959
|
*
|
|
1960
1960
|
* @remarks
|
|
1961
1961
|
*
|
|
1962
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
1962
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi}
|
|
1963
1963
|
*/
|
|
1964
1964
|
interface Dialog {
|
|
1965
1965
|
/**
|
|
@@ -1976,7 +1976,7 @@ declare namespace Office {
|
|
|
1976
1976
|
* - DialogEventReceived. Triggered when the dialog box has been closed or otherwise unloaded.
|
|
1977
1977
|
*
|
|
1978
1978
|
* @param eventType Must be either DialogMessageReceived or DialogEventReceived.
|
|
1979
|
-
* @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/
|
|
1979
|
+
* @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}.
|
|
1980
1980
|
*/
|
|
1981
1981
|
addEventHandler(eventType: Office.EventType, handler: (args: {message: string, origin: string | undefined} | {error: number}) => void): void;
|
|
1982
1982
|
/**
|
|
@@ -1988,11 +1988,11 @@ declare namespace Office {
|
|
|
1988
1988
|
*
|
|
1989
1989
|
* **Requirement sets**:
|
|
1990
1990
|
*
|
|
1991
|
-
* - {@link https://docs.microsoft.com/
|
|
1991
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi 1.2}
|
|
1992
1992
|
*
|
|
1993
|
-
* - {@link https://docs.microsoft.com/
|
|
1993
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.9}
|
|
1994
1994
|
*
|
|
1995
|
-
* - If the `messageOptions` parameter is used, {@link https://docs.microsoft.com/
|
|
1995
|
+
* - 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.
|
|
1996
1996
|
*
|
|
1997
1997
|
* @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.
|
|
1998
1998
|
* @param messageOptions Optional. Provides options for how to send the message.
|
|
@@ -2069,21 +2069,21 @@ declare namespace Office {
|
|
|
2069
2069
|
*
|
|
2070
2070
|
* Application and platform support for each `CoercionType` is specified in the following requirement set descriptions.
|
|
2071
2071
|
*
|
|
2072
|
-
* - {@link https://docs.microsoft.com/
|
|
2072
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
2073
2073
|
*
|
|
2074
|
-
* - {@link https://docs.microsoft.com/
|
|
2074
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion 1.1} (when using `Office.CoercionType.Image`)
|
|
2075
2075
|
*
|
|
2076
|
-
* - {@link https://docs.microsoft.com/
|
|
2076
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2077
2077
|
*
|
|
2078
|
-
* - {@link https://docs.microsoft.com/
|
|
2078
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2079
2079
|
*
|
|
2080
|
-
* - {@link https://docs.microsoft.com/
|
|
2080
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
2081
2081
|
*
|
|
2082
|
-
* - {@link https://docs.microsoft.com/
|
|
2082
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2083
2083
|
*
|
|
2084
|
-
* - {@link https://docs.microsoft.com/
|
|
2084
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2085
2085
|
*
|
|
2086
|
-
* - {@link https://docs.microsoft.com/
|
|
2086
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
2087
2087
|
*
|
|
2088
2088
|
*/
|
|
2089
2089
|
enum CoercionType {
|
|
@@ -2503,11 +2503,11 @@ declare namespace Office {
|
|
|
2503
2503
|
*
|
|
2504
2504
|
* **Requirement sets**:
|
|
2505
2505
|
*
|
|
2506
|
-
* - {@link https://docs.microsoft.com/
|
|
2506
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2507
2507
|
*
|
|
2508
|
-
* - {@link https://docs.microsoft.com/
|
|
2508
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2509
2509
|
*
|
|
2510
|
-
* - {@link https://docs.microsoft.com/
|
|
2510
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2511
2511
|
*/
|
|
2512
2512
|
interface Binding {
|
|
2513
2513
|
/**
|
|
@@ -2528,7 +2528,7 @@ declare namespace Office {
|
|
|
2528
2528
|
*
|
|
2529
2529
|
* @remarks
|
|
2530
2530
|
*
|
|
2531
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2531
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2532
2532
|
*
|
|
2533
2533
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
2534
2534
|
*
|
|
@@ -2544,7 +2544,7 @@ declare namespace Office {
|
|
|
2544
2544
|
*
|
|
2545
2545
|
* @remarks
|
|
2546
2546
|
*
|
|
2547
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2547
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2548
2548
|
*
|
|
2549
2549
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
2550
2550
|
*
|
|
@@ -2560,21 +2560,21 @@ declare namespace Office {
|
|
|
2560
2560
|
*
|
|
2561
2561
|
* **Requirement sets**:
|
|
2562
2562
|
*
|
|
2563
|
-
* - {@link https://docs.microsoft.com/
|
|
2563
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2564
2564
|
*
|
|
2565
|
-
* - {@link https://docs.microsoft.com/
|
|
2565
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2566
2566
|
*
|
|
2567
|
-
* - {@link https://docs.microsoft.com/
|
|
2567
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2568
2568
|
*
|
|
2569
|
-
* - {@link https://docs.microsoft.com/
|
|
2569
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2570
2570
|
*
|
|
2571
|
-
* - {@link https://docs.microsoft.com/
|
|
2571
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2572
2572
|
*
|
|
2573
|
-
* - {@link https://docs.microsoft.com/
|
|
2573
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2574
2574
|
*
|
|
2575
|
-
* - {@link https://docs.microsoft.com/
|
|
2575
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2576
2576
|
*
|
|
2577
|
-
* - {@link https://docs.microsoft.com/
|
|
2577
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2578
2578
|
*
|
|
2579
2579
|
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
|
|
2580
2580
|
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
|
|
@@ -2592,21 +2592,21 @@ declare namespace Office {
|
|
|
2592
2592
|
*
|
|
2593
2593
|
* **Requirement sets**:
|
|
2594
2594
|
*
|
|
2595
|
-
* - {@link https://docs.microsoft.com/
|
|
2595
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2596
2596
|
*
|
|
2597
|
-
* - {@link https://docs.microsoft.com/
|
|
2597
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2598
2598
|
*
|
|
2599
|
-
* - {@link https://docs.microsoft.com/
|
|
2599
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2600
2600
|
*
|
|
2601
|
-
* - {@link https://docs.microsoft.com/
|
|
2601
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2602
2602
|
*
|
|
2603
|
-
* - {@link https://docs.microsoft.com/
|
|
2603
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2604
2604
|
*
|
|
2605
|
-
* - {@link https://docs.microsoft.com/
|
|
2605
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2606
2606
|
*
|
|
2607
|
-
* - {@link https://docs.microsoft.com/
|
|
2607
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2608
2608
|
*
|
|
2609
|
-
* - {@link https://docs.microsoft.com/
|
|
2609
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2610
2610
|
*
|
|
2611
2611
|
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow,
|
|
2612
2612
|
* startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
|
|
@@ -2621,7 +2621,7 @@ declare namespace Office {
|
|
|
2621
2621
|
*
|
|
2622
2622
|
* @remarks
|
|
2623
2623
|
*
|
|
2624
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2624
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2625
2625
|
*
|
|
2626
2626
|
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
|
|
2627
2627
|
* @param options Provides options to determine which event handler or handlers are removed.
|
|
@@ -2633,7 +2633,7 @@ declare namespace Office {
|
|
|
2633
2633
|
*
|
|
2634
2634
|
* @remarks
|
|
2635
2635
|
*
|
|
2636
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
2636
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#bindingevents | BindingEvents}
|
|
2637
2637
|
*
|
|
2638
2638
|
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
|
|
2639
2639
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -2646,21 +2646,21 @@ declare namespace Office {
|
|
|
2646
2646
|
*
|
|
2647
2647
|
* **Requirement sets**:
|
|
2648
2648
|
*
|
|
2649
|
-
* - {@link https://docs.microsoft.com/
|
|
2649
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2650
2650
|
*
|
|
2651
|
-
* - {@link https://docs.microsoft.com/
|
|
2651
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2652
2652
|
*
|
|
2653
|
-
* - {@link https://docs.microsoft.com/
|
|
2653
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2654
2654
|
*
|
|
2655
|
-
* - {@link https://docs.microsoft.com/
|
|
2655
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2656
2656
|
*
|
|
2657
|
-
* - {@link https://docs.microsoft.com/
|
|
2657
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2658
2658
|
*
|
|
2659
|
-
* - {@link https://docs.microsoft.com/
|
|
2659
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2660
2660
|
*
|
|
2661
|
-
* - {@link https://docs.microsoft.com/
|
|
2661
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2662
2662
|
*
|
|
2663
|
-
* - {@link https://docs.microsoft.com/
|
|
2663
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2664
2664
|
*
|
|
2665
2665
|
* 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
|
|
2666
2666
|
* described in the following table.
|
|
@@ -2793,21 +2793,21 @@ declare namespace Office {
|
|
|
2793
2793
|
*
|
|
2794
2794
|
* **Requirement sets**:
|
|
2795
2795
|
*
|
|
2796
|
-
* - {@link https://docs.microsoft.com/
|
|
2796
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
2797
2797
|
*
|
|
2798
|
-
* - {@link https://docs.microsoft.com/
|
|
2798
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
2799
2799
|
*
|
|
2800
|
-
* - {@link https://docs.microsoft.com/
|
|
2800
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
2801
2801
|
*
|
|
2802
|
-
* - {@link https://docs.microsoft.com/
|
|
2802
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
2803
2803
|
*
|
|
2804
|
-
* - {@link https://docs.microsoft.com/
|
|
2804
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
2805
2805
|
*
|
|
2806
|
-
* - {@link https://docs.microsoft.com/
|
|
2806
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
2807
2807
|
*
|
|
2808
|
-
* - {@link https://docs.microsoft.com/
|
|
2808
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
2809
2809
|
*
|
|
2810
|
-
* - {@link https://docs.microsoft.com/
|
|
2810
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
2811
2811
|
*
|
|
2812
2812
|
* 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
|
|
2813
2813
|
* described in the following table.
|
|
@@ -3017,11 +3017,11 @@ declare namespace Office {
|
|
|
3017
3017
|
*
|
|
3018
3018
|
* **Requirement sets**:
|
|
3019
3019
|
*
|
|
3020
|
-
* - {@link https://docs.microsoft.com/
|
|
3020
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3021
3021
|
*
|
|
3022
|
-
* - {@link https://docs.microsoft.com/
|
|
3022
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3023
3023
|
*
|
|
3024
|
-
* - {@link https://docs.microsoft.com/
|
|
3024
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3025
3025
|
*
|
|
3026
3026
|
* For Excel, the itemName parameter can refer to a named range or a table.
|
|
3027
3027
|
*
|
|
@@ -3053,9 +3053,9 @@ declare namespace Office {
|
|
|
3053
3053
|
*
|
|
3054
3054
|
* @remarks
|
|
3055
3055
|
*
|
|
3056
|
-
* {@link https://docs.microsoft.com/
|
|
3057
|
-
* {@link https://docs.microsoft.com/
|
|
3058
|
-
* {@link https://docs.microsoft.com/
|
|
3056
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings},
|
|
3057
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings},
|
|
3058
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3059
3059
|
*
|
|
3060
3060
|
* For Excel, the itemName parameter can refer to a named range or a table.
|
|
3061
3061
|
*
|
|
@@ -3086,7 +3086,7 @@ declare namespace Office {
|
|
|
3086
3086
|
*
|
|
3087
3087
|
* @remarks
|
|
3088
3088
|
*
|
|
3089
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3089
|
+
* **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}
|
|
3090
3090
|
*
|
|
3091
3091
|
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
|
|
3092
3092
|
* The method fails if the specified selection cannot be bound.
|
|
@@ -3103,7 +3103,7 @@ declare namespace Office {
|
|
|
3103
3103
|
*
|
|
3104
3104
|
* @remarks
|
|
3105
3105
|
*
|
|
3106
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3106
|
+
* **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}
|
|
3107
3107
|
*
|
|
3108
3108
|
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id.
|
|
3109
3109
|
* The method fails if the specified selection cannot be bound.
|
|
@@ -3121,11 +3121,11 @@ declare namespace Office {
|
|
|
3121
3121
|
*
|
|
3122
3122
|
* **Requirement sets**:
|
|
3123
3123
|
*
|
|
3124
|
-
* - {@link https://docs.microsoft.com/
|
|
3124
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3125
3125
|
*
|
|
3126
|
-
* - {@link https://docs.microsoft.com/
|
|
3126
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3127
3127
|
*
|
|
3128
|
-
* - {@link https://docs.microsoft.com/
|
|
3128
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3129
3129
|
*
|
|
3130
3130
|
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
|
|
3131
3131
|
*
|
|
@@ -3148,11 +3148,11 @@ declare namespace Office {
|
|
|
3148
3148
|
*
|
|
3149
3149
|
* **Requirement sets**:
|
|
3150
3150
|
*
|
|
3151
|
-
* - {@link https://docs.microsoft.com/
|
|
3151
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3152
3152
|
*
|
|
3153
|
-
* - {@link https://docs.microsoft.com/
|
|
3153
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3154
3154
|
*
|
|
3155
|
-
* - {@link https://docs.microsoft.com/
|
|
3155
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3156
3156
|
*
|
|
3157
3157
|
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
|
|
3158
3158
|
*
|
|
@@ -3174,11 +3174,11 @@ declare namespace Office {
|
|
|
3174
3174
|
*
|
|
3175
3175
|
* **Requirement sets**:
|
|
3176
3176
|
*
|
|
3177
|
-
* - {@link https://docs.microsoft.com/
|
|
3177
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3178
3178
|
*
|
|
3179
|
-
* - {@link https://docs.microsoft.com/
|
|
3179
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3180
3180
|
*
|
|
3181
|
-
* - {@link https://docs.microsoft.com/
|
|
3181
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3182
3182
|
*
|
|
3183
3183
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3184
3184
|
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3192,11 +3192,11 @@ declare namespace Office {
|
|
|
3192
3192
|
*
|
|
3193
3193
|
* **Requirement sets**:
|
|
3194
3194
|
*
|
|
3195
|
-
* - {@link https://docs.microsoft.com/
|
|
3195
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3196
3196
|
*
|
|
3197
|
-
* - {@link https://docs.microsoft.com/
|
|
3197
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3198
3198
|
*
|
|
3199
|
-
* - {@link https://docs.microsoft.com/
|
|
3199
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3200
3200
|
*
|
|
3201
3201
|
* @param callback A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3202
3202
|
* The `value` property of the result is an array that contains each binding created for the referenced Bindings object.
|
|
@@ -3209,11 +3209,11 @@ declare namespace Office {
|
|
|
3209
3209
|
*
|
|
3210
3210
|
* **Requirement sets**:
|
|
3211
3211
|
*
|
|
3212
|
-
* - {@link https://docs.microsoft.com/
|
|
3212
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3213
3213
|
*
|
|
3214
|
-
* - {@link https://docs.microsoft.com/
|
|
3214
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3215
3215
|
*
|
|
3216
|
-
* - {@link https://docs.microsoft.com/
|
|
3216
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3217
3217
|
*
|
|
3218
3218
|
* Fails if the specified id does not exist.
|
|
3219
3219
|
*
|
|
@@ -3230,11 +3230,11 @@ declare namespace Office {
|
|
|
3230
3230
|
*
|
|
3231
3231
|
* **Requirement sets**:
|
|
3232
3232
|
*
|
|
3233
|
-
* - {@link https://docs.microsoft.com/
|
|
3233
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3234
3234
|
*
|
|
3235
|
-
* - {@link https://docs.microsoft.com/
|
|
3235
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3236
3236
|
*
|
|
3237
|
-
* - {@link https://docs.microsoft.com/
|
|
3237
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3238
3238
|
*
|
|
3239
3239
|
* Fails if the specified id does not exist.
|
|
3240
3240
|
*
|
|
@@ -3250,11 +3250,11 @@ declare namespace Office {
|
|
|
3250
3250
|
*
|
|
3251
3251
|
* **Requirement sets**:
|
|
3252
3252
|
*
|
|
3253
|
-
* - {@link https://docs.microsoft.com/
|
|
3253
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3254
3254
|
*
|
|
3255
|
-
* - {@link https://docs.microsoft.com/
|
|
3255
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3256
3256
|
*
|
|
3257
|
-
* - {@link https://docs.microsoft.com/
|
|
3257
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3258
3258
|
*
|
|
3259
3259
|
* Fails if the specified id does not exist.
|
|
3260
3260
|
*
|
|
@@ -3270,11 +3270,11 @@ declare namespace Office {
|
|
|
3270
3270
|
*
|
|
3271
3271
|
* **Requirement sets**:
|
|
3272
3272
|
*
|
|
3273
|
-
* - {@link https://docs.microsoft.com/
|
|
3273
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixbindings | MatrixBindings}
|
|
3274
3274
|
*
|
|
3275
|
-
* - {@link https://docs.microsoft.com/
|
|
3275
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablebindings | TableBindings}
|
|
3276
3276
|
*
|
|
3277
|
-
* - {@link https://docs.microsoft.com/
|
|
3277
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textbindings | TextBindings}
|
|
3278
3278
|
*
|
|
3279
3279
|
* Fails if the specified id does not exist.
|
|
3280
3280
|
*
|
|
@@ -3308,7 +3308,7 @@ declare namespace Office {
|
|
|
3308
3308
|
*
|
|
3309
3309
|
* @remarks
|
|
3310
3310
|
*
|
|
3311
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3311
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3312
3312
|
*
|
|
3313
3313
|
* @param xPath The XPath expression that specifies the nodes to get. Required.
|
|
3314
3314
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3321,7 +3321,7 @@ declare namespace Office {
|
|
|
3321
3321
|
*
|
|
3322
3322
|
* @remarks
|
|
3323
3323
|
*
|
|
3324
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3324
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3325
3325
|
*
|
|
3326
3326
|
* @param xPath The XPath expression that specifies the nodes to get. Required.
|
|
3327
3327
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3333,7 +3333,7 @@ declare namespace Office {
|
|
|
3333
3333
|
*
|
|
3334
3334
|
* @remarks
|
|
3335
3335
|
*
|
|
3336
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3336
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3337
3337
|
*
|
|
3338
3338
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3339
3339
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3345,7 +3345,7 @@ declare namespace Office {
|
|
|
3345
3345
|
*
|
|
3346
3346
|
* @remarks
|
|
3347
3347
|
*
|
|
3348
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3348
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3349
3349
|
*
|
|
3350
3350
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3351
3351
|
* The `value` property of the result is a string that contains the value of the referenced node.
|
|
@@ -3356,7 +3356,7 @@ declare namespace Office {
|
|
|
3356
3356
|
*
|
|
3357
3357
|
* @remarks
|
|
3358
3358
|
*
|
|
3359
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3359
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3360
3360
|
*
|
|
3361
3361
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3362
3362
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3368,7 +3368,7 @@ declare namespace Office {
|
|
|
3368
3368
|
*
|
|
3369
3369
|
* @remarks
|
|
3370
3370
|
*
|
|
3371
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3371
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3372
3372
|
*
|
|
3373
3373
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3374
3374
|
* The `value` property of the result is a string that contains the inner text of the referenced nodes.
|
|
@@ -3379,7 +3379,7 @@ declare namespace Office {
|
|
|
3379
3379
|
*
|
|
3380
3380
|
* @remarks
|
|
3381
3381
|
*
|
|
3382
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3382
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3383
3383
|
*
|
|
3384
3384
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3385
3385
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3391,7 +3391,7 @@ declare namespace Office {
|
|
|
3391
3391
|
*
|
|
3392
3392
|
* @remarks
|
|
3393
3393
|
*
|
|
3394
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3394
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3395
3395
|
*
|
|
3396
3396
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3397
3397
|
* The `value` property of the result is a string that contains the XML of the referenced node.
|
|
@@ -3402,7 +3402,7 @@ declare namespace Office {
|
|
|
3402
3402
|
*
|
|
3403
3403
|
* @remarks
|
|
3404
3404
|
*
|
|
3405
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3405
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3406
3406
|
*
|
|
3407
3407
|
* @param value The value to be set on the node
|
|
3408
3408
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3414,7 +3414,7 @@ declare namespace Office {
|
|
|
3414
3414
|
*
|
|
3415
3415
|
* @remarks
|
|
3416
3416
|
*
|
|
3417
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3417
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3418
3418
|
*
|
|
3419
3419
|
* @param value The value to be set on the node
|
|
3420
3420
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3425,7 +3425,7 @@ declare namespace Office {
|
|
|
3425
3425
|
*
|
|
3426
3426
|
* @remarks
|
|
3427
3427
|
*
|
|
3428
|
-
* **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}
|
|
3429
3429
|
*
|
|
3430
3430
|
* @param text Required. The text value of the XML node.
|
|
3431
3431
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3437,7 +3437,7 @@ declare namespace Office {
|
|
|
3437
3437
|
*
|
|
3438
3438
|
* @remarks
|
|
3439
3439
|
*
|
|
3440
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3440
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3441
3441
|
*
|
|
3442
3442
|
* @param text Required. The text value of the XML node.
|
|
3443
3443
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3448,7 +3448,7 @@ declare namespace Office {
|
|
|
3448
3448
|
*
|
|
3449
3449
|
* @remarks
|
|
3450
3450
|
*
|
|
3451
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3451
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3452
3452
|
*
|
|
3453
3453
|
* @param xml The XML to be set on the node
|
|
3454
3454
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3460,7 +3460,7 @@ declare namespace Office {
|
|
|
3460
3460
|
*
|
|
3461
3461
|
* @remarks
|
|
3462
3462
|
*
|
|
3463
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3463
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3464
3464
|
*
|
|
3465
3465
|
* @param xml The XML to be set on the node
|
|
3466
3466
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3492,7 +3492,7 @@ declare namespace Office {
|
|
|
3492
3492
|
*
|
|
3493
3493
|
* @remarks
|
|
3494
3494
|
*
|
|
3495
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3495
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3496
3496
|
*
|
|
3497
3497
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3498
3498
|
*
|
|
@@ -3509,7 +3509,7 @@ declare namespace Office {
|
|
|
3509
3509
|
*
|
|
3510
3510
|
* @remarks
|
|
3511
3511
|
*
|
|
3512
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3512
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3513
3513
|
*
|
|
3514
3514
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3515
3515
|
*
|
|
@@ -3525,7 +3525,7 @@ declare namespace Office {
|
|
|
3525
3525
|
*
|
|
3526
3526
|
* @remarks
|
|
3527
3527
|
*
|
|
3528
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3528
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3529
3529
|
*
|
|
3530
3530
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3531
3531
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3536,7 +3536,7 @@ declare namespace Office {
|
|
|
3536
3536
|
*
|
|
3537
3537
|
* @remarks
|
|
3538
3538
|
*
|
|
3539
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3539
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3540
3540
|
*
|
|
3541
3541
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3542
3542
|
*/
|
|
@@ -3546,7 +3546,7 @@ declare namespace Office {
|
|
|
3546
3546
|
*
|
|
3547
3547
|
* @remarks
|
|
3548
3548
|
*
|
|
3549
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3549
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3550
3550
|
*
|
|
3551
3551
|
* @param xPath An XPath expression that specifies the nodes you want returned. Required.
|
|
3552
3552
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3559,7 +3559,7 @@ declare namespace Office {
|
|
|
3559
3559
|
*
|
|
3560
3560
|
* @remarks
|
|
3561
3561
|
*
|
|
3562
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3562
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3563
3563
|
*
|
|
3564
3564
|
* @param xPath An XPath expression that specifies the nodes you want returned. Required.
|
|
3565
3565
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3571,7 +3571,7 @@ declare namespace Office {
|
|
|
3571
3571
|
*
|
|
3572
3572
|
* @remarks
|
|
3573
3573
|
*
|
|
3574
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3574
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3575
3575
|
*
|
|
3576
3576
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
3577
3577
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3583,7 +3583,7 @@ declare namespace Office {
|
|
|
3583
3583
|
*
|
|
3584
3584
|
* @remarks
|
|
3585
3585
|
*
|
|
3586
|
-
* **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}
|
|
3587
3587
|
*
|
|
3588
3588
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
3589
3589
|
* The `value` property of the result is a string that contains the XML of the referenced CustomXmlPart object.
|
|
@@ -3594,7 +3594,7 @@ declare namespace Office {
|
|
|
3594
3594
|
*
|
|
3595
3595
|
* @remarks
|
|
3596
3596
|
*
|
|
3597
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3597
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3598
3598
|
*
|
|
3599
3599
|
* @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as
|
|
3600
3600
|
* `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`.
|
|
@@ -3608,7 +3608,7 @@ declare namespace Office {
|
|
|
3608
3608
|
*
|
|
3609
3609
|
* @remarks
|
|
3610
3610
|
*
|
|
3611
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3611
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3612
3612
|
*
|
|
3613
3613
|
* @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as
|
|
3614
3614
|
* `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`.
|
|
@@ -3691,7 +3691,7 @@ declare namespace Office {
|
|
|
3691
3691
|
*
|
|
3692
3692
|
* @remarks
|
|
3693
3693
|
*
|
|
3694
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3694
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3695
3695
|
*
|
|
3696
3696
|
* @param xml The XML to add to the newly created custom XML part.
|
|
3697
3697
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3704,7 +3704,7 @@ declare namespace Office {
|
|
|
3704
3704
|
*
|
|
3705
3705
|
* @remarks
|
|
3706
3706
|
*
|
|
3707
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3707
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3708
3708
|
*
|
|
3709
3709
|
* @param xml The XML to add to the newly created custom XML part.
|
|
3710
3710
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3716,7 +3716,7 @@ declare namespace Office {
|
|
|
3716
3716
|
*
|
|
3717
3717
|
* @remarks
|
|
3718
3718
|
*
|
|
3719
|
-
* **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}
|
|
3720
3720
|
*
|
|
3721
3721
|
* @param id The GUID of the custom XML part, including opening and closing braces.
|
|
3722
3722
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3730,7 +3730,7 @@ declare namespace Office {
|
|
|
3730
3730
|
*
|
|
3731
3731
|
* @remarks
|
|
3732
3732
|
*
|
|
3733
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3733
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3734
3734
|
*
|
|
3735
3735
|
* @param id The GUID of the custom XML part, including opening and closing braces.
|
|
3736
3736
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3743,7 +3743,7 @@ declare namespace Office {
|
|
|
3743
3743
|
*
|
|
3744
3744
|
* @remarks
|
|
3745
3745
|
*
|
|
3746
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3746
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3747
3747
|
*
|
|
3748
3748
|
* @param ns The namespace URI.
|
|
3749
3749
|
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
|
|
@@ -3756,7 +3756,7 @@ declare namespace Office {
|
|
|
3756
3756
|
*
|
|
3757
3757
|
* @remarks
|
|
3758
3758
|
*
|
|
3759
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3759
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3760
3760
|
*
|
|
3761
3761
|
* @param ns The namespace URI.
|
|
3762
3762
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -3777,7 +3777,7 @@ declare namespace Office {
|
|
|
3777
3777
|
*
|
|
3778
3778
|
* @remarks
|
|
3779
3779
|
*
|
|
3780
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3780
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3781
3781
|
*
|
|
3782
3782
|
* If no namespace is assigned to the requested prefix, the method returns an empty string ("").
|
|
3783
3783
|
*
|
|
@@ -3792,7 +3792,7 @@ declare namespace Office {
|
|
|
3792
3792
|
*
|
|
3793
3793
|
* @remarks
|
|
3794
3794
|
*
|
|
3795
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3795
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3796
3796
|
*
|
|
3797
3797
|
* If no namespace is assigned to the requested prefix, the method returns an empty string ("").
|
|
3798
3798
|
*
|
|
@@ -3806,7 +3806,7 @@ declare namespace Office {
|
|
|
3806
3806
|
*
|
|
3807
3807
|
* @remarks
|
|
3808
3808
|
*
|
|
3809
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3809
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3810
3810
|
*
|
|
3811
3811
|
* If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one
|
|
3812
3812
|
* added or used by the data store internally, in which case it will return an error.
|
|
@@ -3822,7 +3822,7 @@ declare namespace Office {
|
|
|
3822
3822
|
*
|
|
3823
3823
|
* @remarks
|
|
3824
3824
|
*
|
|
3825
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3825
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3826
3826
|
*
|
|
3827
3827
|
* If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one
|
|
3828
3828
|
* added or used by the data store internally, in which case it will return an error.
|
|
@@ -3837,7 +3837,7 @@ declare namespace Office {
|
|
|
3837
3837
|
*
|
|
3838
3838
|
* @remarks
|
|
3839
3839
|
*
|
|
3840
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3840
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3841
3841
|
*
|
|
3842
3842
|
* If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in
|
|
3843
3843
|
* the namespace manager, the method returns the first prefix that matches the supplied namespace.
|
|
@@ -3853,7 +3853,7 @@ declare namespace Office {
|
|
|
3853
3853
|
*
|
|
3854
3854
|
* @remarks
|
|
3855
3855
|
*
|
|
3856
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3856
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
|
|
3857
3857
|
*
|
|
3858
3858
|
* If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in
|
|
3859
3859
|
* the namespace manager, the method returns the first prefix that matches the supplied namespace.
|
|
@@ -3902,7 +3902,7 @@ declare namespace Office {
|
|
|
3902
3902
|
*
|
|
3903
3903
|
* @remarks
|
|
3904
3904
|
*
|
|
3905
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3905
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
3906
3906
|
*
|
|
3907
3907
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3908
3908
|
*
|
|
@@ -3918,7 +3918,7 @@ declare namespace Office {
|
|
|
3918
3918
|
*
|
|
3919
3919
|
* @remarks
|
|
3920
3920
|
*
|
|
3921
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3921
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
3922
3922
|
*
|
|
3923
3923
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
3924
3924
|
*
|
|
@@ -3933,7 +3933,7 @@ declare namespace Office {
|
|
|
3933
3933
|
*
|
|
3934
3934
|
* @remarks
|
|
3935
3935
|
*
|
|
3936
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3936
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#activeview | ActiveView}
|
|
3937
3937
|
*
|
|
3938
3938
|
* Can trigger an event when the view changes.
|
|
3939
3939
|
*
|
|
@@ -3949,7 +3949,7 @@ declare namespace Office {
|
|
|
3949
3949
|
*
|
|
3950
3950
|
* @remarks
|
|
3951
3951
|
*
|
|
3952
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
3952
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#activeview | ActiveView}
|
|
3953
3953
|
*
|
|
3954
3954
|
* Can trigger an event when the view changes.
|
|
3955
3955
|
*
|
|
@@ -3967,11 +3967,11 @@ declare namespace Office {
|
|
|
3967
3967
|
*
|
|
3968
3968
|
* **Requirement sets**:
|
|
3969
3969
|
*
|
|
3970
|
-
* - {@link https://docs.microsoft.com/
|
|
3970
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`)
|
|
3971
3971
|
*
|
|
3972
|
-
* - {@link https://docs.microsoft.com/
|
|
3972
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
3973
3973
|
*
|
|
3974
|
-
* - {@link https://docs.microsoft.com/
|
|
3974
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`)
|
|
3975
3975
|
*
|
|
3976
3976
|
* For add-ins running in Office host applications other than Office on iPad, the `getFileAsync` method supports getting files in slices of up
|
|
3977
3977
|
* 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
|
|
@@ -4002,11 +4002,11 @@ declare namespace Office {
|
|
|
4002
4002
|
*
|
|
4003
4003
|
* **Requirement sets**:
|
|
4004
4004
|
*
|
|
4005
|
-
* - {@link https://docs.microsoft.com/
|
|
4005
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#compressedfile | CompressedFile} (when using `Office.FileType.Compressed`)
|
|
4006
4006
|
*
|
|
4007
|
-
* - {@link https://docs.microsoft.com/
|
|
4007
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
4008
4008
|
*
|
|
4009
|
-
* - {@link https://docs.microsoft.com/
|
|
4009
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textfile | TextFile} (when using `Office.FileType.Text`)
|
|
4010
4010
|
*
|
|
4011
4011
|
* For add-ins running in Office host applications other than Office on iPad, the `getFileAsync` method supports getting files in slices of up
|
|
4012
4012
|
* 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
|
|
@@ -4033,7 +4033,7 @@ declare namespace Office {
|
|
|
4033
4033
|
*
|
|
4034
4034
|
* @remarks
|
|
4035
4035
|
*
|
|
4036
|
-
* **Requirement sets**: {@link https://docs.microsoft.com/
|
|
4036
|
+
* **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}
|
|
4037
4037
|
*
|
|
4038
4038
|
* You get the file's URL with the url property `asyncResult.value.url`.
|
|
4039
4039
|
*
|
|
@@ -4047,7 +4047,7 @@ declare namespace Office {
|
|
|
4047
4047
|
*
|
|
4048
4048
|
* @remarks
|
|
4049
4049
|
*
|
|
4050
|
-
* **Requirement sets**: {@link https://docs.microsoft.com/
|
|
4050
|
+
* **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}
|
|
4051
4051
|
*
|
|
4052
4052
|
* You get the file's URL with the url property `asyncResult.value.url`.
|
|
4053
4053
|
*
|
|
@@ -4062,17 +4062,17 @@ declare namespace Office {
|
|
|
4062
4062
|
*
|
|
4063
4063
|
* **Requirement sets**:
|
|
4064
4064
|
*
|
|
4065
|
-
* - {@link https://docs.microsoft.com/
|
|
4065
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
4066
4066
|
*
|
|
4067
|
-
* - {@link https://docs.microsoft.com/
|
|
4067
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4068
4068
|
*
|
|
4069
|
-
* - {@link https://docs.microsoft.com/
|
|
4069
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4070
4070
|
*
|
|
4071
|
-
* - {@link https://docs.microsoft.com/
|
|
4071
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4072
4072
|
*
|
|
4073
|
-
* - {@link https://docs.microsoft.com/
|
|
4073
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4074
4074
|
*
|
|
4075
|
-
* - {@link https://docs.microsoft.com/
|
|
4075
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4076
4076
|
*
|
|
4077
4077
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
4078
4078
|
* the following information.
|
|
@@ -4154,17 +4154,17 @@ declare namespace Office {
|
|
|
4154
4154
|
*
|
|
4155
4155
|
* **Requirement sets**:
|
|
4156
4156
|
*
|
|
4157
|
-
* - {@link https://docs.microsoft.com/
|
|
4157
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
4158
4158
|
*
|
|
4159
|
-
* - {@link https://docs.microsoft.com/
|
|
4159
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4160
4160
|
*
|
|
4161
|
-
* - {@link https://docs.microsoft.com/
|
|
4161
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4162
4162
|
*
|
|
4163
|
-
* - {@link https://docs.microsoft.com/
|
|
4163
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4164
4164
|
*
|
|
4165
|
-
* - {@link https://docs.microsoft.com/
|
|
4165
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4166
4166
|
*
|
|
4167
|
-
* - {@link https://docs.microsoft.com/
|
|
4167
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4168
4168
|
*
|
|
4169
4169
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
4170
4170
|
* the following information.
|
|
@@ -4241,7 +4241,7 @@ declare namespace Office {
|
|
|
4241
4241
|
*
|
|
4242
4242
|
* @remarks
|
|
4243
4243
|
*
|
|
4244
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4244
|
+
* **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}
|
|
4245
4245
|
*
|
|
4246
4246
|
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
|
|
4247
4247
|
*
|
|
@@ -4268,7 +4268,7 @@ declare namespace Office {
|
|
|
4268
4268
|
*
|
|
4269
4269
|
* @remarks
|
|
4270
4270
|
*
|
|
4271
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4271
|
+
* **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}
|
|
4272
4272
|
*
|
|
4273
4273
|
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
|
|
4274
4274
|
*
|
|
@@ -4294,7 +4294,7 @@ declare namespace Office {
|
|
|
4294
4294
|
*
|
|
4295
4295
|
* @remarks
|
|
4296
4296
|
*
|
|
4297
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4297
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
4298
4298
|
*
|
|
4299
4299
|
* @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'.
|
|
4300
4300
|
* @param options Provides options to determine which event handler or handlers are removed.
|
|
@@ -4306,7 +4306,7 @@ declare namespace Office {
|
|
|
4306
4306
|
*
|
|
4307
4307
|
* @remarks
|
|
4308
4308
|
*
|
|
4309
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
4309
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#documentevents | DocumentEvents}
|
|
4310
4310
|
*
|
|
4311
4311
|
* @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'.
|
|
4312
4312
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -4319,21 +4319,21 @@ declare namespace Office {
|
|
|
4319
4319
|
*
|
|
4320
4320
|
* **Requirement sets**:
|
|
4321
4321
|
*
|
|
4322
|
-
* - {@link https://docs.microsoft.com/
|
|
4322
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
4323
4323
|
*
|
|
4324
|
-
* - {@link https://docs.microsoft.com/
|
|
4324
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion 1.1} (when using `Office.CoercionType.Image`)
|
|
4325
4325
|
*
|
|
4326
|
-
* - {@link https://docs.microsoft.com/
|
|
4326
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4327
4327
|
*
|
|
4328
|
-
* - {@link https://docs.microsoft.com/
|
|
4328
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4329
4329
|
*
|
|
4330
|
-
* - {@link https://docs.microsoft.com/
|
|
4330
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4331
4331
|
*
|
|
4332
|
-
* - {@link https://docs.microsoft.com/
|
|
4332
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4333
4333
|
*
|
|
4334
|
-
* - {@link https://docs.microsoft.com/
|
|
4334
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4335
4335
|
*
|
|
4336
|
-
* - {@link https://docs.microsoft.com/
|
|
4336
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
4337
4337
|
*
|
|
4338
4338
|
* **Application-specific behaviors**
|
|
4339
4339
|
*
|
|
@@ -4509,21 +4509,21 @@ declare namespace Office {
|
|
|
4509
4509
|
*
|
|
4510
4510
|
* **Requirement sets**:
|
|
4511
4511
|
*
|
|
4512
|
-
* - {@link https://docs.microsoft.com/
|
|
4512
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion}, (when using `Office.CoercionType.Html`)
|
|
4513
4513
|
*
|
|
4514
|
-
* - {@link https://docs.microsoft.com/
|
|
4514
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets | ImageCoercion} (when using `Office.CoercionType.Image`)
|
|
4515
4515
|
*
|
|
4516
|
-
* - {@link https://docs.microsoft.com/
|
|
4516
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
4517
4517
|
*
|
|
4518
|
-
* - {@link https://docs.microsoft.com/
|
|
4518
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
4519
4519
|
*
|
|
4520
|
-
* - {@link https://docs.microsoft.com/
|
|
4520
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
4521
4521
|
*
|
|
4522
|
-
* - {@link https://docs.microsoft.com/
|
|
4522
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
4523
4523
|
*
|
|
4524
|
-
* - {@link https://docs.microsoft.com/
|
|
4524
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
4525
4525
|
*
|
|
4526
|
-
* - {@link https://docs.microsoft.com/
|
|
4526
|
+
* - {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12 | ImageCoercion 1.2} (when using `Office.CoercionType.XmlSvg`)
|
|
4527
4527
|
*
|
|
4528
4528
|
* **Application-specific behaviors**
|
|
4529
4529
|
*
|
|
@@ -5009,7 +5009,7 @@ declare namespace Office {
|
|
|
5009
5009
|
*
|
|
5010
5010
|
* @remarks
|
|
5011
5011
|
*
|
|
5012
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5012
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
5013
5013
|
*
|
|
5014
5014
|
* No more than two documents are allowed to be in memory; otherwise the Document.getFileAsync operation will fail. Use the File.closeAsync
|
|
5015
5015
|
* method to close the file when you are finished working with it.
|
|
@@ -5048,7 +5048,7 @@ declare namespace Office {
|
|
|
5048
5048
|
*
|
|
5049
5049
|
* @remarks
|
|
5050
5050
|
*
|
|
5051
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5051
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#file | File}
|
|
5052
5052
|
*
|
|
5053
5053
|
* In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following
|
|
5054
5054
|
* information.
|
|
@@ -5132,7 +5132,7 @@ declare namespace Office {
|
|
|
5132
5132
|
*
|
|
5133
5133
|
* @remarks
|
|
5134
5134
|
*
|
|
5135
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5135
|
+
* **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}
|
|
5136
5136
|
*
|
|
5137
5137
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
5138
5138
|
*
|
|
@@ -5174,7 +5174,7 @@ declare namespace Office {
|
|
|
5174
5174
|
*
|
|
5175
5175
|
* @remarks
|
|
5176
5176
|
*
|
|
5177
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5177
|
+
* **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}
|
|
5178
5178
|
*
|
|
5179
5179
|
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
|
|
5180
5180
|
*
|
|
@@ -5211,7 +5211,7 @@ declare namespace Office {
|
|
|
5211
5211
|
*
|
|
5212
5212
|
* @remarks
|
|
5213
5213
|
*
|
|
5214
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5214
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5215
5215
|
*
|
|
5216
5216
|
* @param settingName The case-sensitive name of the setting to retrieve.
|
|
5217
5217
|
* @returns An object that has property names mapped to JSON serialized values.
|
|
@@ -5222,7 +5222,7 @@ declare namespace Office {
|
|
|
5222
5222
|
*
|
|
5223
5223
|
* @remarks
|
|
5224
5224
|
*
|
|
5225
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5225
|
+
* **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}
|
|
5226
5226
|
*
|
|
5227
5227
|
* This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against
|
|
5228
5228
|
* 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
|
|
@@ -5269,7 +5269,7 @@ declare namespace Office {
|
|
|
5269
5269
|
*
|
|
5270
5270
|
* @remarks
|
|
5271
5271
|
*
|
|
5272
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5272
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5273
5273
|
*
|
|
5274
5274
|
* null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.
|
|
5275
5275
|
*
|
|
@@ -5281,7 +5281,7 @@ declare namespace Office {
|
|
|
5281
5281
|
*
|
|
5282
5282
|
* @remarks
|
|
5283
5283
|
*
|
|
5284
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5284
|
+
* **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}
|
|
5285
5285
|
*
|
|
5286
5286
|
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
|
|
5287
5287
|
* will be removed.
|
|
@@ -5302,7 +5302,7 @@ declare namespace Office {
|
|
|
5302
5302
|
*
|
|
5303
5303
|
* @remarks
|
|
5304
5304
|
*
|
|
5305
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5305
|
+
* **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}
|
|
5306
5306
|
*
|
|
5307
5307
|
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
|
|
5308
5308
|
* will be removed.
|
|
@@ -5322,7 +5322,7 @@ declare namespace Office {
|
|
|
5322
5322
|
*
|
|
5323
5323
|
* @remarks
|
|
5324
5324
|
*
|
|
5325
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5325
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5326
5326
|
*
|
|
5327
5327
|
* 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
|
|
5328
5328
|
* 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
|
|
@@ -5365,7 +5365,7 @@ declare namespace Office {
|
|
|
5365
5365
|
*
|
|
5366
5366
|
* @remarks
|
|
5367
5367
|
*
|
|
5368
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5368
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5369
5369
|
*
|
|
5370
5370
|
* 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
|
|
5371
5371
|
* 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
|
|
@@ -5412,7 +5412,7 @@ declare namespace Office {
|
|
|
5412
5412
|
*
|
|
5413
5413
|
* @remarks
|
|
5414
5414
|
*
|
|
5415
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5415
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
|
|
5416
5416
|
*
|
|
5417
5417
|
* 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
|
|
5418
5418
|
* 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
|
|
@@ -5456,7 +5456,7 @@ declare namespace Office {
|
|
|
5456
5456
|
*
|
|
5457
5457
|
* @remarks
|
|
5458
5458
|
*
|
|
5459
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5459
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1}
|
|
5460
5460
|
*/
|
|
5461
5461
|
interface DialogMessageOptions {
|
|
5462
5462
|
/**
|
|
@@ -5481,7 +5481,7 @@ declare namespace Office {
|
|
|
5481
5481
|
*
|
|
5482
5482
|
* @remarks
|
|
5483
5483
|
*
|
|
5484
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
5484
|
+
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1}.
|
|
5485
5485
|
* The property is `undefined` on clients that do not support this requirement set.
|
|
5486
5486
|
*/
|
|
5487
5487
|
origin: string | undefined;
|
|
@@ -6001,7 +6001,7 @@ declare namespace Office {
|
|
|
6001
6001
|
*
|
|
6002
6002
|
* @remarks
|
|
6003
6003
|
*
|
|
6004
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
6004
|
+
* **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}
|
|
6005
6005
|
*
|
|
6006
6006
|
* In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.
|
|
6007
6007
|
*
|
|
@@ -6039,7 +6039,7 @@ declare namespace Office {
|
|
|
6039
6039
|
*
|
|
6040
6040
|
* @remarks
|
|
6041
6041
|
*
|
|
6042
|
-
* **Requirement set**: {@link https://docs.microsoft.com/
|
|
6042
|
+
* **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}
|
|
6043
6043
|
*
|
|
6044
6044
|
* In the callback function passed to the goToByIdAsync method, you can use the properties of the AsyncResult object to return the following information.
|
|
6045
6045
|
*
|
|
@@ -9550,7 +9550,7 @@ declare namespace Office {
|
|
|
9550
9550
|
*
|
|
9551
9551
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9552
9552
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9553
|
-
* {@link https://docs.microsoft.com/
|
|
9553
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
9554
9554
|
*
|
|
9555
9555
|
* Child interfaces:
|
|
9556
9556
|
*
|
|
@@ -9565,7 +9565,7 @@ declare namespace Office {
|
|
|
9565
9565
|
*
|
|
9566
9566
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
9567
9567
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
9568
|
-
* {@link https://docs.microsoft.com/
|
|
9568
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
9569
9569
|
*
|
|
9570
9570
|
* Parent interfaces:
|
|
9571
9571
|
*
|
|
@@ -9966,7 +9966,7 @@ declare namespace Office {
|
|
|
9966
9966
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
9967
9967
|
*
|
|
9968
9968
|
* For supported events, refer to the Item object model
|
|
9969
|
-
* {@link https://docs.microsoft.com/
|
|
9969
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
9970
9970
|
*
|
|
9971
9971
|
* @remarks
|
|
9972
9972
|
* [Api set: Mailbox 1.7]
|
|
@@ -9988,7 +9988,7 @@ declare namespace Office {
|
|
|
9988
9988
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
9989
9989
|
*
|
|
9990
9990
|
* For supported events, refer to the Item object model
|
|
9991
|
-
* {@link https://docs.microsoft.com/
|
|
9991
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
9992
9992
|
*
|
|
9993
9993
|
* @remarks
|
|
9994
9994
|
* [Api set: Mailbox 1.7]
|
|
@@ -10540,7 +10540,7 @@ declare namespace Office {
|
|
|
10540
10540
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10541
10541
|
*
|
|
10542
10542
|
* For supported events, refer to the Item object model
|
|
10543
|
-
* {@link https://docs.microsoft.com/
|
|
10543
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
10544
10544
|
*
|
|
10545
10545
|
* @remarks
|
|
10546
10546
|
* [Api set: Mailbox 1.7]
|
|
@@ -10560,7 +10560,7 @@ declare namespace Office {
|
|
|
10560
10560
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
10561
10561
|
*
|
|
10562
10562
|
* For supported events, refer to the Item object model
|
|
10563
|
-
* {@link https://docs.microsoft.com/
|
|
10563
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
10564
10564
|
*
|
|
10565
10565
|
* @remarks
|
|
10566
10566
|
* [Api set: Mailbox 1.7]
|
|
@@ -10884,7 +10884,7 @@ declare namespace Office {
|
|
|
10884
10884
|
*
|
|
10885
10885
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
10886
10886
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
10887
|
-
* {@link https://docs.microsoft.com/
|
|
10887
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
10888
10888
|
*
|
|
10889
10889
|
* Parent interfaces:
|
|
10890
10890
|
*
|
|
@@ -11230,7 +11230,7 @@ declare namespace Office {
|
|
|
11230
11230
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11231
11231
|
*
|
|
11232
11232
|
* For supported events, refer to the Item object model
|
|
11233
|
-
* {@link https://docs.microsoft.com/
|
|
11233
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
11234
11234
|
*
|
|
11235
11235
|
* @remarks
|
|
11236
11236
|
* [Api set: Mailbox 1.7]
|
|
@@ -11252,7 +11252,7 @@ declare namespace Office {
|
|
|
11252
11252
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
11253
11253
|
*
|
|
11254
11254
|
* For supported events, refer to the Item object model
|
|
11255
|
-
* {@link https://docs.microsoft.com/
|
|
11255
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
11256
11256
|
*
|
|
11257
11257
|
* @remarks
|
|
11258
11258
|
* [Api set: Mailbox 1.7]
|
|
@@ -11788,7 +11788,7 @@ declare namespace Office {
|
|
|
11788
11788
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11789
11789
|
*
|
|
11790
11790
|
* For supported events, refer to the Item object model
|
|
11791
|
-
* {@link https://docs.microsoft.com/
|
|
11791
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
11792
11792
|
*
|
|
11793
11793
|
* @remarks
|
|
11794
11794
|
* [Api set: Mailbox 1.7]
|
|
@@ -11808,7 +11808,7 @@ declare namespace Office {
|
|
|
11808
11808
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
11809
11809
|
*
|
|
11810
11810
|
* For supported events, refer to the Item object model
|
|
11811
|
-
* {@link https://docs.microsoft.com/
|
|
11811
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
11812
11812
|
*
|
|
11813
11813
|
* @remarks
|
|
11814
11814
|
* [Api set: Mailbox 1.7]
|
|
@@ -13401,7 +13401,7 @@ declare namespace Office {
|
|
|
13401
13401
|
* You can determine the type of the item by using the `itemType` property.
|
|
13402
13402
|
*
|
|
13403
13403
|
* To see the full member list, refer to the
|
|
13404
|
-
* {@link https://docs.microsoft.com/
|
|
13404
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
13405
13405
|
*
|
|
13406
13406
|
* If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
|
|
13407
13407
|
*
|
|
@@ -13426,7 +13426,7 @@ declare namespace Office {
|
|
|
13426
13426
|
*
|
|
13427
13427
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13428
13428
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13429
|
-
* {@link https://docs.microsoft.com/
|
|
13429
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
13430
13430
|
*
|
|
13431
13431
|
* Child interfaces:
|
|
13432
13432
|
*
|
|
@@ -13441,7 +13441,7 @@ declare namespace Office {
|
|
|
13441
13441
|
*
|
|
13442
13442
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
13443
13443
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
13444
|
-
* {@link https://docs.microsoft.com/
|
|
13444
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
13445
13445
|
*
|
|
13446
13446
|
* Child interfaces:
|
|
13447
13447
|
*
|
|
@@ -13757,7 +13757,7 @@ declare namespace Office {
|
|
|
13757
13757
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13758
13758
|
*
|
|
13759
13759
|
* For supported events, refer to the Mailbox object model
|
|
13760
|
-
* {@link https://docs.microsoft.com/
|
|
13760
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
|
|
13761
13761
|
*
|
|
13762
13762
|
* @remarks
|
|
13763
13763
|
* [Api set: Mailbox 1.5]
|
|
@@ -13778,7 +13778,7 @@ declare namespace Office {
|
|
|
13778
13778
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
13779
13779
|
*
|
|
13780
13780
|
* For supported events, refer to the Mailbox object model
|
|
13781
|
-
* {@link https://docs.microsoft.com/
|
|
13781
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
|
|
13782
13782
|
*
|
|
13783
13783
|
* @remarks
|
|
13784
13784
|
* [Api set: Mailbox 1.5]
|
|
@@ -14481,7 +14481,7 @@ declare namespace Office {
|
|
|
14481
14481
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14482
14482
|
*
|
|
14483
14483
|
* For supported events, refer to the Mailbox object model
|
|
14484
|
-
* {@link https://docs.microsoft.com/
|
|
14484
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
|
|
14485
14485
|
*
|
|
14486
14486
|
* @remarks
|
|
14487
14487
|
* [Api set: Mailbox 1.5]
|
|
@@ -14500,7 +14500,7 @@ declare namespace Office {
|
|
|
14500
14500
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
14501
14501
|
*
|
|
14502
14502
|
* For supported events, refer to the Mailbox object model
|
|
14503
|
-
* {@link https://docs.microsoft.com/
|
|
14503
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox#events | events section}.
|
|
14504
14504
|
*
|
|
14505
14505
|
* @remarks
|
|
14506
14506
|
* [Api set: Mailbox 1.5]
|
|
@@ -14692,7 +14692,7 @@ declare namespace Office {
|
|
|
14692
14692
|
*
|
|
14693
14693
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14694
14694
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14695
|
-
* {@link https://docs.microsoft.com/
|
|
14695
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14696
14696
|
*
|
|
14697
14697
|
* Child interfaces:
|
|
14698
14698
|
*
|
|
@@ -14707,7 +14707,7 @@ declare namespace Office {
|
|
|
14707
14707
|
*
|
|
14708
14708
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
14709
14709
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
14710
|
-
* {@link https://docs.microsoft.com/
|
|
14710
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
14711
14711
|
*
|
|
14712
14712
|
* Parent interfaces:
|
|
14713
14713
|
*
|
|
@@ -15065,7 +15065,7 @@ declare namespace Office {
|
|
|
15065
15065
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15066
15066
|
*
|
|
15067
15067
|
* For supported events, refer to the Item object model
|
|
15068
|
-
* {@link https://docs.microsoft.com/
|
|
15068
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
15069
15069
|
*
|
|
15070
15070
|
* @remarks
|
|
15071
15071
|
* [Api set: Mailbox 1.7]
|
|
@@ -15087,7 +15087,7 @@ declare namespace Office {
|
|
|
15087
15087
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
15088
15088
|
*
|
|
15089
15089
|
* For supported events, refer to the Item object model
|
|
15090
|
-
* {@link https://docs.microsoft.com/
|
|
15090
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
15091
15091
|
*
|
|
15092
15092
|
* @remarks
|
|
15093
15093
|
* [Api set: Mailbox 1.7]
|
|
@@ -15717,7 +15717,7 @@ declare namespace Office {
|
|
|
15717
15717
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15718
15718
|
*
|
|
15719
15719
|
* For supported events, refer to the Item object model
|
|
15720
|
-
* {@link https://docs.microsoft.com/
|
|
15720
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
15721
15721
|
*
|
|
15722
15722
|
* @remarks
|
|
15723
15723
|
* [Api set: Mailbox 1.7]
|
|
@@ -15737,7 +15737,7 @@ declare namespace Office {
|
|
|
15737
15737
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
15738
15738
|
*
|
|
15739
15739
|
* For supported events, refer to the Item object model
|
|
15740
|
-
* {@link https://docs.microsoft.com/
|
|
15740
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
15741
15741
|
*
|
|
15742
15742
|
* @remarks
|
|
15743
15743
|
* [Api set: Mailbox 1.7]
|
|
@@ -15881,7 +15881,7 @@ declare namespace Office {
|
|
|
15881
15881
|
*
|
|
15882
15882
|
* **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
|
|
15883
15883
|
* You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
|
|
15884
|
-
* {@link https://docs.microsoft.com/
|
|
15884
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item | Object Model} page.
|
|
15885
15885
|
*
|
|
15886
15886
|
* Parent interfaces:
|
|
15887
15887
|
*
|
|
@@ -16252,7 +16252,7 @@ declare namespace Office {
|
|
|
16252
16252
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16253
16253
|
*
|
|
16254
16254
|
* For supported events, refer to the Item object model
|
|
16255
|
-
* {@link https://docs.microsoft.com/
|
|
16255
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
16256
16256
|
*
|
|
16257
16257
|
* @remarks
|
|
16258
16258
|
* [Api set: Mailbox 1.7]
|
|
@@ -16274,7 +16274,7 @@ declare namespace Office {
|
|
|
16274
16274
|
* Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
|
|
16275
16275
|
*
|
|
16276
16276
|
* For supported events, refer to the Item object model
|
|
16277
|
-
* {@link https://docs.microsoft.com/
|
|
16277
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
16278
16278
|
*
|
|
16279
16279
|
* @remarks
|
|
16280
16280
|
* [Api set: Mailbox 1.7]
|
|
@@ -16851,7 +16851,7 @@ declare namespace Office {
|
|
|
16851
16851
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16852
16852
|
*
|
|
16853
16853
|
* For supported events, refer to the Item object model
|
|
16854
|
-
* {@link https://docs.microsoft.com/
|
|
16854
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
16855
16855
|
*
|
|
16856
16856
|
* @remarks
|
|
16857
16857
|
* [Api set: Mailbox 1.7]
|
|
@@ -16871,7 +16871,7 @@ declare namespace Office {
|
|
|
16871
16871
|
* Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
|
|
16872
16872
|
*
|
|
16873
16873
|
* For supported events, refer to the Item object model
|
|
16874
|
-
* {@link https://docs.microsoft.com/
|
|
16874
|
+
* {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#events | events section}.
|
|
16875
16875
|
*
|
|
16876
16876
|
* @remarks
|
|
16877
16877
|
* [Api set: Mailbox 1.7]
|
|
@@ -19191,15 +19191,17 @@ declare namespace Excel {
|
|
|
19191
19191
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19192
19192
|
* @beta
|
|
19193
19193
|
*/
|
|
19194
|
-
type: CellValueType.array | "Array";
|
|
19194
|
+
type: CellValueType.array | ReferenceValueType.array | "Array";
|
|
19195
19195
|
/**
|
|
19196
19196
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19197
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
19198
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
19197
19199
|
*
|
|
19198
19200
|
* @remarks
|
|
19199
19201
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19200
19202
|
* @beta
|
|
19201
19203
|
*/
|
|
19202
|
-
basicValue?: "#VALUE!";
|
|
19204
|
+
basicValue?: "#VALUE!" | string;
|
|
19203
19205
|
/**
|
|
19204
19206
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19205
19207
|
*
|
|
@@ -19216,6 +19218,14 @@ declare namespace Excel {
|
|
|
19216
19218
|
* @beta
|
|
19217
19219
|
*/
|
|
19218
19220
|
elements: CellValue[][];
|
|
19221
|
+
/**
|
|
19222
|
+
* Represents the cell values which are referenced within `ArrayCellValue.elements`.
|
|
19223
|
+
*
|
|
19224
|
+
* @remarks
|
|
19225
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19226
|
+
* @beta
|
|
19227
|
+
*/
|
|
19228
|
+
referencedValues?: ReferencedValue[];
|
|
19219
19229
|
}
|
|
19220
19230
|
/**
|
|
19221
19231
|
* Represents types of #BLOCKED! errors.
|
|
@@ -19308,12 +19318,14 @@ declare namespace Excel {
|
|
|
19308
19318
|
type: CellValueType.error | "Error";
|
|
19309
19319
|
/**
|
|
19310
19320
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19321
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
19322
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
19311
19323
|
*
|
|
19312
19324
|
* @remarks
|
|
19313
19325
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19314
19326
|
* @beta
|
|
19315
19327
|
*/
|
|
19316
|
-
basicValue?: "#BLOCKED!";
|
|
19328
|
+
basicValue?: "#BLOCKED!" | string;
|
|
19317
19329
|
/**
|
|
19318
19330
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19319
19331
|
*
|
|
@@ -19423,12 +19435,14 @@ declare namespace Excel {
|
|
|
19423
19435
|
type: CellValueType.error | "Error";
|
|
19424
19436
|
/**
|
|
19425
19437
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19438
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
19439
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
19426
19440
|
*
|
|
19427
19441
|
* @remarks
|
|
19428
19442
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19429
19443
|
* @beta
|
|
19430
19444
|
*/
|
|
19431
|
-
basicValue?: "#BUSY!";
|
|
19445
|
+
basicValue?: "#BUSY!" | string;
|
|
19432
19446
|
/**
|
|
19433
19447
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19434
19448
|
*
|
|
@@ -19545,12 +19559,14 @@ declare namespace Excel {
|
|
|
19545
19559
|
type: CellValueType.error | "Error";
|
|
19546
19560
|
/**
|
|
19547
19561
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19562
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
19563
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
19548
19564
|
*
|
|
19549
19565
|
* @remarks
|
|
19550
19566
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19551
19567
|
* @beta
|
|
19552
19568
|
*/
|
|
19553
|
-
basicValue?: "#CALC!";
|
|
19569
|
+
basicValue?: "#CALC!" | string;
|
|
19554
19570
|
/**
|
|
19555
19571
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19556
19572
|
*
|
|
@@ -19728,6 +19744,121 @@ declare namespace Excel {
|
|
|
19728
19744
|
*/
|
|
19729
19745
|
type CardLayout = EntityCardLayout;
|
|
19730
19746
|
/**
|
|
19747
|
+
* Represents a reference into `referencedValues`. One scenario for using this reference is to avoid duplicating cell value objects (such as an `EntityCellValue`). Define a cell value object once in `referencedValues`, and then refer to that cell value from many places by using a `ReferenceCellValue` where the duplicated value would have appeared.
|
|
19748
|
+
*
|
|
19749
|
+
* @remarks
|
|
19750
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19751
|
+
* @beta
|
|
19752
|
+
*/
|
|
19753
|
+
interface ReferenceCellValue {
|
|
19754
|
+
/**
|
|
19755
|
+
* Represents the type of this cell value.
|
|
19756
|
+
*
|
|
19757
|
+
* @remarks
|
|
19758
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19759
|
+
* @beta
|
|
19760
|
+
*/
|
|
19761
|
+
type: CellValueType.reference | "Reference";
|
|
19762
|
+
/**
|
|
19763
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19764
|
+
*
|
|
19765
|
+
* @remarks
|
|
19766
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19767
|
+
* @beta
|
|
19768
|
+
*/
|
|
19769
|
+
basicValue?: boolean | number | string;
|
|
19770
|
+
/**
|
|
19771
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19772
|
+
*
|
|
19773
|
+
* @remarks
|
|
19774
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19775
|
+
* @beta
|
|
19776
|
+
*/
|
|
19777
|
+
basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
|
|
19778
|
+
/**
|
|
19779
|
+
* Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`.
|
|
19780
|
+
*
|
|
19781
|
+
* @remarks
|
|
19782
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19783
|
+
* @beta
|
|
19784
|
+
*/
|
|
19785
|
+
reference: number;
|
|
19786
|
+
}
|
|
19787
|
+
/**
|
|
19788
|
+
* Represents a reference to the value which contains `referencedValues`.
|
|
19789
|
+
*
|
|
19790
|
+
* @remarks
|
|
19791
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19792
|
+
* @beta
|
|
19793
|
+
*/
|
|
19794
|
+
interface RootReferenceCellValue {
|
|
19795
|
+
/**
|
|
19796
|
+
* Represents the type of this cell value.
|
|
19797
|
+
*
|
|
19798
|
+
* @remarks
|
|
19799
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19800
|
+
* @beta
|
|
19801
|
+
*/
|
|
19802
|
+
type: ReferenceValueType.root | "Root";
|
|
19803
|
+
/**
|
|
19804
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19805
|
+
*
|
|
19806
|
+
* @remarks
|
|
19807
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19808
|
+
* @beta
|
|
19809
|
+
*/
|
|
19810
|
+
basicValue?: boolean | number | string;
|
|
19811
|
+
/**
|
|
19812
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19813
|
+
*
|
|
19814
|
+
* @remarks
|
|
19815
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19816
|
+
* @beta
|
|
19817
|
+
*/
|
|
19818
|
+
basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
|
|
19819
|
+
}
|
|
19820
|
+
/**
|
|
19821
|
+
* Represents the types of the `ReferenceValue` object.
|
|
19822
|
+
*
|
|
19823
|
+
* @remarks
|
|
19824
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19825
|
+
* @beta
|
|
19826
|
+
*/
|
|
19827
|
+
enum ReferenceValueType {
|
|
19828
|
+
/**
|
|
19829
|
+
* Represents an `ArrayCellValue`.
|
|
19830
|
+
*
|
|
19831
|
+
* @remarks
|
|
19832
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19833
|
+
* @beta
|
|
19834
|
+
*/
|
|
19835
|
+
array = "Array",
|
|
19836
|
+
/**
|
|
19837
|
+
* Represents an `EntityCellValue`.
|
|
19838
|
+
*
|
|
19839
|
+
* @remarks
|
|
19840
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19841
|
+
* @beta
|
|
19842
|
+
*/
|
|
19843
|
+
entity = "Entity",
|
|
19844
|
+
/**
|
|
19845
|
+
* Represents a `RootReferenceCellValue`.
|
|
19846
|
+
*
|
|
19847
|
+
* @remarks
|
|
19848
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19849
|
+
* @beta
|
|
19850
|
+
*/
|
|
19851
|
+
root = "Root"
|
|
19852
|
+
}
|
|
19853
|
+
/**
|
|
19854
|
+
* Represents the value in a cell.
|
|
19855
|
+
*
|
|
19856
|
+
* @remarks
|
|
19857
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19858
|
+
* @beta
|
|
19859
|
+
*/
|
|
19860
|
+
type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue;
|
|
19861
|
+
/**
|
|
19731
19862
|
* Represents the types of the `CellValue` object.
|
|
19732
19863
|
*
|
|
19733
19864
|
* @remarks
|
|
@@ -19800,6 +19931,14 @@ declare namespace Excel {
|
|
|
19800
19931
|
*/
|
|
19801
19932
|
linkedEntity = "LinkedEntity",
|
|
19802
19933
|
/**
|
|
19934
|
+
* Represents a `ReferenceCellValue`.
|
|
19935
|
+
*
|
|
19936
|
+
* @remarks
|
|
19937
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19938
|
+
* @beta
|
|
19939
|
+
*/
|
|
19940
|
+
reference = "Reference",
|
|
19941
|
+
/**
|
|
19803
19942
|
* Represents a `StringCellValue`.
|
|
19804
19943
|
*
|
|
19805
19944
|
* @remarks
|
|
@@ -19831,7 +19970,15 @@ declare namespace Excel {
|
|
|
19831
19970
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19832
19971
|
* @beta
|
|
19833
19972
|
*/
|
|
19834
|
-
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue &
|
|
19973
|
+
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & CellValueExtraProperties;
|
|
19974
|
+
/**
|
|
19975
|
+
* These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
|
|
19976
|
+
*
|
|
19977
|
+
* @remarks
|
|
19978
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19979
|
+
* @beta
|
|
19980
|
+
*/
|
|
19981
|
+
interface CellValueExtraProperties {
|
|
19835
19982
|
/**
|
|
19836
19983
|
* Represents whether this `CellValue` will be used to overwrite a cell.
|
|
19837
19984
|
* When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
|
|
@@ -19851,7 +19998,7 @@ declare namespace Excel {
|
|
|
19851
19998
|
* @beta
|
|
19852
19999
|
*/
|
|
19853
20000
|
writableNote?: string;
|
|
19854
|
-
}
|
|
20001
|
+
}
|
|
19855
20002
|
/**
|
|
19856
20003
|
* Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type.
|
|
19857
20004
|
*
|
|
@@ -19859,16 +20006,7 @@ declare namespace Excel {
|
|
|
19859
20006
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19860
20007
|
* @beta
|
|
19861
20008
|
*/
|
|
19862
|
-
type CellValueAndPropertyMetadata = CellValue &
|
|
19863
|
-
/**
|
|
19864
|
-
* Represents metadata about the property.
|
|
19865
|
-
*
|
|
19866
|
-
* @remarks
|
|
19867
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19868
|
-
* @beta
|
|
19869
|
-
*/
|
|
19870
|
-
propertyMetadata?: CellValuePropertyMetadata;
|
|
19871
|
-
};
|
|
20009
|
+
type CellValueAndPropertyMetadata = CellValue & EntityPropertyExtraProperties;
|
|
19872
20010
|
/**
|
|
19873
20011
|
* The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source.
|
|
19874
20012
|
*
|
|
@@ -19929,12 +20067,14 @@ declare namespace Excel {
|
|
|
19929
20067
|
type: CellValueType.error | "Error";
|
|
19930
20068
|
/**
|
|
19931
20069
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20070
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20071
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
19932
20072
|
*
|
|
19933
20073
|
* @remarks
|
|
19934
20074
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19935
20075
|
* @beta
|
|
19936
20076
|
*/
|
|
19937
|
-
basicValue?: "#BUSY!";
|
|
20077
|
+
basicValue?: "#BUSY!" | string;
|
|
19938
20078
|
/**
|
|
19939
20079
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19940
20080
|
*
|
|
@@ -20231,12 +20371,14 @@ declare namespace Excel {
|
|
|
20231
20371
|
type: CellValueType.error | "Error";
|
|
20232
20372
|
/**
|
|
20233
20373
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20374
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20375
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20234
20376
|
*
|
|
20235
20377
|
* @remarks
|
|
20236
20378
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20237
20379
|
* @beta
|
|
20238
20380
|
*/
|
|
20239
|
-
basicValue?: "#CONNECT!";
|
|
20381
|
+
basicValue?: "#CONNECT!" | string;
|
|
20240
20382
|
/**
|
|
20241
20383
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20242
20384
|
*
|
|
@@ -20280,12 +20422,14 @@ declare namespace Excel {
|
|
|
20280
20422
|
type: CellValueType.error | "Error";
|
|
20281
20423
|
/**
|
|
20282
20424
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20425
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20426
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20283
20427
|
*
|
|
20284
20428
|
* @remarks
|
|
20285
20429
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20286
20430
|
* @beta
|
|
20287
20431
|
*/
|
|
20288
|
-
basicValue?: "#DIV/0!";
|
|
20432
|
+
basicValue?: "#DIV/0!" | string;
|
|
20289
20433
|
/**
|
|
20290
20434
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20291
20435
|
*
|
|
@@ -20378,6 +20522,23 @@ declare namespace Excel {
|
|
|
20378
20522
|
*/
|
|
20379
20523
|
type EntityPropertyType = CellValueAndPropertyMetadata | CellValue;
|
|
20380
20524
|
/**
|
|
20525
|
+
* Properties used by `CellValueAndPropertyMetadata`. These properties refer to the metadata and not to a `CellValue`.
|
|
20526
|
+
*
|
|
20527
|
+
* @remarks
|
|
20528
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20529
|
+
* @beta
|
|
20530
|
+
*/
|
|
20531
|
+
interface EntityPropertyExtraProperties {
|
|
20532
|
+
/**
|
|
20533
|
+
* Represents metadata about the property.
|
|
20534
|
+
*
|
|
20535
|
+
* @remarks
|
|
20536
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20537
|
+
* @beta
|
|
20538
|
+
*/
|
|
20539
|
+
propertyMetadata?: CellValuePropertyMetadata;
|
|
20540
|
+
}
|
|
20541
|
+
/**
|
|
20381
20542
|
* Represents an schemaless set of properties.
|
|
20382
20543
|
*
|
|
20383
20544
|
* @remarks
|
|
@@ -20392,15 +20553,17 @@ declare namespace Excel {
|
|
|
20392
20553
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20393
20554
|
* @beta
|
|
20394
20555
|
*/
|
|
20395
|
-
type: CellValueType.entity | "Entity";
|
|
20556
|
+
type: CellValueType.entity | ReferenceValueType.entity | "Entity";
|
|
20396
20557
|
/**
|
|
20397
20558
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20559
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20560
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20398
20561
|
*
|
|
20399
20562
|
* @remarks
|
|
20400
20563
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20401
20564
|
* @beta
|
|
20402
20565
|
*/
|
|
20403
|
-
basicValue?: "#VALUE!";
|
|
20566
|
+
basicValue?: "#VALUE!" | string;
|
|
20404
20567
|
/**
|
|
20405
20568
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20406
20569
|
*
|
|
@@ -20427,6 +20590,40 @@ declare namespace Excel {
|
|
|
20427
20590
|
properties?: {
|
|
20428
20591
|
[key: string]: EntityPropertyType;
|
|
20429
20592
|
};
|
|
20593
|
+
/**
|
|
20594
|
+
* Represents layout information for views of this entity.
|
|
20595
|
+
*
|
|
20596
|
+
* @remarks
|
|
20597
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20598
|
+
* @beta
|
|
20599
|
+
*/
|
|
20600
|
+
layouts?: EntityViewLayouts;
|
|
20601
|
+
/**
|
|
20602
|
+
* Represents information that describes the service that provided the data in this `EntityCellValue`.
|
|
20603
|
+
* This information can be used for branding in entity cards.
|
|
20604
|
+
*
|
|
20605
|
+
* @remarks
|
|
20606
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20607
|
+
* @beta
|
|
20608
|
+
*/
|
|
20609
|
+
provider?: CellValueProviderAttributes;
|
|
20610
|
+
/**
|
|
20611
|
+
* Represents the cell values which are referenced within `EntityCellValue.properties`.
|
|
20612
|
+
*
|
|
20613
|
+
* @remarks
|
|
20614
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20615
|
+
* @beta
|
|
20616
|
+
*/
|
|
20617
|
+
referencedValues?: ReferencedValue[];
|
|
20618
|
+
}
|
|
20619
|
+
/**
|
|
20620
|
+
* Represents layout information for various views of the entity.
|
|
20621
|
+
*
|
|
20622
|
+
* @remarks
|
|
20623
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20624
|
+
* @beta
|
|
20625
|
+
*/
|
|
20626
|
+
interface EntityViewLayouts {
|
|
20430
20627
|
/**
|
|
20431
20628
|
* Represents the layout of this entity in card view.
|
|
20432
20629
|
* If the `CardLayout` object does not have a layout property, it is assumed to be "Entity".
|
|
@@ -20435,7 +20632,7 @@ declare namespace Excel {
|
|
|
20435
20632
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20436
20633
|
* @beta
|
|
20437
20634
|
*/
|
|
20438
|
-
|
|
20635
|
+
card?: CardLayout;
|
|
20439
20636
|
}
|
|
20440
20637
|
/**
|
|
20441
20638
|
* Represents a card layout best used for an entity.
|
|
@@ -20446,7 +20643,7 @@ declare namespace Excel {
|
|
|
20446
20643
|
*/
|
|
20447
20644
|
interface EntityCardLayout extends CardLayoutStandardProperties {
|
|
20448
20645
|
/**
|
|
20449
|
-
*
|
|
20646
|
+
* Represents the type of this layout.
|
|
20450
20647
|
*
|
|
20451
20648
|
* @remarks
|
|
20452
20649
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -20642,12 +20839,14 @@ declare namespace Excel {
|
|
|
20642
20839
|
type: CellValueType.error | "Error";
|
|
20643
20840
|
/**
|
|
20644
20841
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20842
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20843
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20645
20844
|
*
|
|
20646
20845
|
* @remarks
|
|
20647
20846
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20648
20847
|
* @beta
|
|
20649
20848
|
*/
|
|
20650
|
-
basicValue?: "#FIELD!";
|
|
20849
|
+
basicValue?: "#FIELD!" | string;
|
|
20651
20850
|
/**
|
|
20652
20851
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20653
20852
|
*
|
|
@@ -20708,7 +20907,9 @@ declare namespace Excel {
|
|
|
20708
20907
|
basicType?: RangeValueType.double | "Double";
|
|
20709
20908
|
/**
|
|
20710
20909
|
* Returns the number format string that is used to display this value.
|
|
20711
|
-
*
|
|
20910
|
+
* When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale.
|
|
20911
|
+
* Number format strings must conform to Excel guidelines.
|
|
20912
|
+
* To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
20712
20913
|
*
|
|
20713
20914
|
* @remarks
|
|
20714
20915
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -20734,12 +20935,14 @@ declare namespace Excel {
|
|
|
20734
20935
|
type: CellValueType.error | "Error";
|
|
20735
20936
|
/**
|
|
20736
20937
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20938
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
20939
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20737
20940
|
*
|
|
20738
20941
|
* @remarks
|
|
20739
20942
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20740
20943
|
* @beta
|
|
20741
20944
|
*/
|
|
20742
|
-
basicValue?: "#GETTING_DATA";
|
|
20945
|
+
basicValue?: "#GETTING_DATA" | string;
|
|
20743
20946
|
/**
|
|
20744
20947
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20745
20948
|
*
|
|
@@ -20816,12 +21019,14 @@ declare namespace Excel {
|
|
|
20816
21019
|
type: CellValueType.linkedEntity | "LinkedEntity";
|
|
20817
21020
|
/**
|
|
20818
21021
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21022
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21023
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20819
21024
|
*
|
|
20820
21025
|
* @remarks
|
|
20821
21026
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20822
21027
|
* @beta
|
|
20823
21028
|
*/
|
|
20824
|
-
basicValue?: "#VALUE!";
|
|
21029
|
+
basicValue?: "#VALUE!" | string;
|
|
20825
21030
|
/**
|
|
20826
21031
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20827
21032
|
*
|
|
@@ -20847,7 +21052,7 @@ declare namespace Excel {
|
|
|
20847
21052
|
*/
|
|
20848
21053
|
text?: string;
|
|
20849
21054
|
/**
|
|
20850
|
-
* Represents the properties of this entity and their metadata.
|
|
21055
|
+
* Represents the properties of this linked entity and their metadata.
|
|
20851
21056
|
*
|
|
20852
21057
|
* @remarks
|
|
20853
21058
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -20859,7 +21064,16 @@ declare namespace Excel {
|
|
|
20859
21064
|
};
|
|
20860
21065
|
};
|
|
20861
21066
|
/**
|
|
20862
|
-
* Represents
|
|
21067
|
+
* Represents the layout of this linked entity in card view.
|
|
21068
|
+
* If the `CardLayout` object doesn't have a layout property, it default value is "Entity".
|
|
21069
|
+
*
|
|
21070
|
+
* @remarks
|
|
21071
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21072
|
+
* @beta
|
|
21073
|
+
*/
|
|
21074
|
+
cardLayout?: CardLayout;
|
|
21075
|
+
/**
|
|
21076
|
+
* Represents information that describes the service that provided data in this `LinkedEntityCellValue`.
|
|
20863
21077
|
* This information can be used for branding in entity cards.
|
|
20864
21078
|
*
|
|
20865
21079
|
* @remarks
|
|
@@ -20886,12 +21100,14 @@ declare namespace Excel {
|
|
|
20886
21100
|
type: CellValueType.error | "Error";
|
|
20887
21101
|
/**
|
|
20888
21102
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21103
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21104
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20889
21105
|
*
|
|
20890
21106
|
* @remarks
|
|
20891
21107
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20892
21108
|
* @beta
|
|
20893
21109
|
*/
|
|
20894
|
-
basicValue?: "#N/A!";
|
|
21110
|
+
basicValue?: "#N/A!" | string;
|
|
20895
21111
|
/**
|
|
20896
21112
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20897
21113
|
*
|
|
@@ -20927,12 +21143,14 @@ declare namespace Excel {
|
|
|
20927
21143
|
type: CellValueType.error | "Error";
|
|
20928
21144
|
/**
|
|
20929
21145
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21146
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21147
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20930
21148
|
*
|
|
20931
21149
|
* @remarks
|
|
20932
21150
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20933
21151
|
* @beta
|
|
20934
21152
|
*/
|
|
20935
|
-
basicValue?: "#NAME?";
|
|
21153
|
+
basicValue?: "#NAME?" | string;
|
|
20936
21154
|
/**
|
|
20937
21155
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20938
21156
|
*
|
|
@@ -20968,12 +21186,14 @@ declare namespace Excel {
|
|
|
20968
21186
|
type: CellValueType.error | "Error";
|
|
20969
21187
|
/**
|
|
20970
21188
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21189
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21190
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
20971
21191
|
*
|
|
20972
21192
|
* @remarks
|
|
20973
21193
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20974
21194
|
* @beta
|
|
20975
21195
|
*/
|
|
20976
|
-
basicValue?: "#NULL!";
|
|
21196
|
+
basicValue?: "#NULL!" | string;
|
|
20977
21197
|
/**
|
|
20978
21198
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20979
21199
|
*
|
|
@@ -21009,12 +21229,14 @@ declare namespace Excel {
|
|
|
21009
21229
|
type: CellValueType.error | "Error";
|
|
21010
21230
|
/**
|
|
21011
21231
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21232
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21233
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21012
21234
|
*
|
|
21013
21235
|
* @remarks
|
|
21014
21236
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21015
21237
|
* @beta
|
|
21016
21238
|
*/
|
|
21017
|
-
basicValue?: "#NUM!";
|
|
21239
|
+
basicValue?: "#NUM!" | string;
|
|
21018
21240
|
/**
|
|
21019
21241
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21020
21242
|
*
|
|
@@ -21049,78 +21271,6 @@ declare namespace Excel {
|
|
|
21049
21271
|
*/
|
|
21050
21272
|
unknown = "Unknown",
|
|
21051
21273
|
/**
|
|
21052
|
-
* An error caused by a column_index_num parameter of VLOOKUP that's greater than the number of columns in the table_array parameter. Displays as error type #REF! in Excel.
|
|
21053
|
-
*
|
|
21054
|
-
* @remarks
|
|
21055
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21056
|
-
* @beta
|
|
21057
|
-
*/
|
|
21058
|
-
vlookupColumnIndexGreaterThanNumColumns = "VlookupColumnIndexGreaterThanNumColumns",
|
|
21059
|
-
/**
|
|
21060
|
-
* An error caused by a row_index_num parameter of HLOOKUP that's greater than the number of rows in the table_array parameter. Displays as error type #REF! in Excel.
|
|
21061
|
-
*
|
|
21062
|
-
* @remarks
|
|
21063
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21064
|
-
* @beta
|
|
21065
|
-
*/
|
|
21066
|
-
hlookupRowIndexGreaterThanNumRows = "HlookupRowIndexGreaterThanNumRows",
|
|
21067
|
-
/**
|
|
21068
|
-
* An error caused by the reference or name not existing in the linked workbook. Displays as error type #REF! in Excel.
|
|
21069
|
-
*
|
|
21070
|
-
* @remarks
|
|
21071
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21072
|
-
* @beta
|
|
21073
|
-
*/
|
|
21074
|
-
externalLinksRefNotExist = "ExternalLinksRefNotExist",
|
|
21075
|
-
/**
|
|
21076
|
-
* An error caused by a start_row parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
21077
|
-
*
|
|
21078
|
-
* @remarks
|
|
21079
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21080
|
-
* @beta
|
|
21081
|
-
*/
|
|
21082
|
-
subArrayStartRowOutOfBounds = "SubArrayStartRowOutOfBounds",
|
|
21083
|
-
/**
|
|
21084
|
-
* An error caused by a start_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
21085
|
-
*
|
|
21086
|
-
* @remarks
|
|
21087
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21088
|
-
* @beta
|
|
21089
|
-
*/
|
|
21090
|
-
subArrayStartColumnOutOfBounds = "SubArrayStartColumnOutOfBounds",
|
|
21091
|
-
/**
|
|
21092
|
-
* An error caused by an end_row parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
21093
|
-
*
|
|
21094
|
-
* @remarks
|
|
21095
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21096
|
-
* @beta
|
|
21097
|
-
*/
|
|
21098
|
-
subArrayEndRowOutOfBounds = "SubArrayEndRowOutOfBounds",
|
|
21099
|
-
/**
|
|
21100
|
-
* An error caused by an end_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
21101
|
-
*
|
|
21102
|
-
* @remarks
|
|
21103
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21104
|
-
* @beta
|
|
21105
|
-
*/
|
|
21106
|
-
subArrayEndColumnOutOfBounds = "SubArrayEndColumnOutOfBounds",
|
|
21107
|
-
/**
|
|
21108
|
-
* An error caused by an end_row parameter of SUBARRAY preceding the start_row parameter. Displays as error type #REF! in Excel.
|
|
21109
|
-
*
|
|
21110
|
-
* @remarks
|
|
21111
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21112
|
-
* @beta
|
|
21113
|
-
*/
|
|
21114
|
-
subArrayEndRowPrecedesStartRow = "SubArrayEndRowPrecedesStartRow",
|
|
21115
|
-
/**
|
|
21116
|
-
* An error caused by an end_column parameter of SUBARRAY preceding the start_column parameter. Displays as error type #REF! in Excel.
|
|
21117
|
-
*
|
|
21118
|
-
* @remarks
|
|
21119
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21120
|
-
* @beta
|
|
21121
|
-
*/
|
|
21122
|
-
subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn",
|
|
21123
|
-
/**
|
|
21124
21274
|
* An error caused by structured references from the linked workbook. Displays as error type #REF! in Excel.
|
|
21125
21275
|
*
|
|
21126
21276
|
* @remarks
|
|
@@ -21135,7 +21285,7 @@ declare namespace Excel {
|
|
|
21135
21285
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21136
21286
|
* @beta
|
|
21137
21287
|
*/
|
|
21138
|
-
|
|
21288
|
+
externalLinksCalculatedRef = "ExternalLinksCalculatedRef"
|
|
21139
21289
|
}
|
|
21140
21290
|
/**
|
|
21141
21291
|
* Represents the value of a cell containing a #REF! error.
|
|
@@ -21155,12 +21305,14 @@ declare namespace Excel {
|
|
|
21155
21305
|
type: CellValueType.error | "Error";
|
|
21156
21306
|
/**
|
|
21157
21307
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21308
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21309
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21158
21310
|
*
|
|
21159
21311
|
* @remarks
|
|
21160
21312
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21161
21313
|
* @beta
|
|
21162
21314
|
*/
|
|
21163
|
-
basicValue?: "#REF!";
|
|
21315
|
+
basicValue?: "#REF!" | string;
|
|
21164
21316
|
/**
|
|
21165
21317
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21166
21318
|
*
|
|
@@ -21184,7 +21336,7 @@ declare namespace Excel {
|
|
|
21184
21336
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21185
21337
|
* @beta
|
|
21186
21338
|
*/
|
|
21187
|
-
errorSubType?: RefErrorCellValueSubType | "Unknown" | "
|
|
21339
|
+
errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef";
|
|
21188
21340
|
}
|
|
21189
21341
|
/**
|
|
21190
21342
|
* Represents types of #SPILL! errors.
|
|
@@ -21269,12 +21421,14 @@ declare namespace Excel {
|
|
|
21269
21421
|
type: CellValueType.error | "Error";
|
|
21270
21422
|
/**
|
|
21271
21423
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21424
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21425
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21272
21426
|
*
|
|
21273
21427
|
* @remarks
|
|
21274
21428
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21275
21429
|
* @beta
|
|
21276
21430
|
*/
|
|
21277
|
-
basicValue?: "#SPILL!";
|
|
21431
|
+
basicValue?: "#SPILL!" | string;
|
|
21278
21432
|
/**
|
|
21279
21433
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21280
21434
|
*
|
|
@@ -21536,12 +21690,14 @@ declare namespace Excel {
|
|
|
21536
21690
|
type: CellValueType.error | "Error";
|
|
21537
21691
|
/**
|
|
21538
21692
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21693
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21694
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21539
21695
|
*
|
|
21540
21696
|
* @remarks
|
|
21541
21697
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21542
21698
|
* @beta
|
|
21543
21699
|
*/
|
|
21544
|
-
basicValue?: "#VALUE!";
|
|
21700
|
+
basicValue?: "#VALUE!" | string;
|
|
21545
21701
|
/**
|
|
21546
21702
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21547
21703
|
*
|
|
@@ -21619,12 +21775,14 @@ declare namespace Excel {
|
|
|
21619
21775
|
type: CellValueType.webImage | "WebImage";
|
|
21620
21776
|
/**
|
|
21621
21777
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21778
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21779
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21622
21780
|
*
|
|
21623
21781
|
* @remarks
|
|
21624
21782
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21625
21783
|
* @beta
|
|
21626
21784
|
*/
|
|
21627
|
-
basicValue?: "#VALUE!";
|
|
21785
|
+
basicValue?: "#VALUE!" | string;
|
|
21628
21786
|
/**
|
|
21629
21787
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21630
21788
|
*
|
|
@@ -28792,6 +28950,15 @@ declare namespace Excel {
|
|
|
28792
28950
|
* [Api set: ExcelApi 1.2]
|
|
28793
28951
|
*/
|
|
28794
28952
|
readonly protected: boolean;
|
|
28953
|
+
/**
|
|
28954
|
+
* Specifies the protection options settings saved in the worksheet.
|
|
28955
|
+
This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
|
|
28956
|
+
*
|
|
28957
|
+
* @remarks
|
|
28958
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
28959
|
+
* @beta
|
|
28960
|
+
*/
|
|
28961
|
+
readonly savedOptions: Excel.WorksheetProtectionOptions;
|
|
28795
28962
|
/**
|
|
28796
28963
|
* Specifies if the password can be used to unlock worksheet protection.
|
|
28797
28964
|
This method does not change the worksheet protection state.
|
|
@@ -29359,13 +29526,24 @@ declare namespace Excel {
|
|
|
29359
29526
|
values: any[][];
|
|
29360
29527
|
/**
|
|
29361
29528
|
* A JSON representation of the values in the cells in this range.
|
|
29362
|
-
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
|
|
29529
|
+
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
29530
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`.
|
|
29363
29531
|
*
|
|
29364
29532
|
* @remarks
|
|
29365
29533
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29366
29534
|
* @beta
|
|
29367
29535
|
*/
|
|
29368
29536
|
valuesAsJson: CellValue[][];
|
|
29537
|
+
/**
|
|
29538
|
+
* A JSON representation of the values in the cells in this range.
|
|
29539
|
+
Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
29540
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`.
|
|
29541
|
+
*
|
|
29542
|
+
* @remarks
|
|
29543
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
29544
|
+
* @beta
|
|
29545
|
+
*/
|
|
29546
|
+
valuesAsJsonLocal: CellValue[][];
|
|
29369
29547
|
/**
|
|
29370
29548
|
* Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
|
|
29371
29549
|
*
|
|
@@ -31196,13 +31374,24 @@ declare namespace Excel {
|
|
|
31196
31374
|
values: any[][];
|
|
31197
31375
|
/**
|
|
31198
31376
|
* A JSON representation of the values in the cells in this range.
|
|
31199
|
-
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
|
|
31377
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31378
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`.
|
|
31200
31379
|
*
|
|
31201
31380
|
* @remarks
|
|
31202
31381
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31203
31382
|
* @beta
|
|
31204
31383
|
*/
|
|
31205
31384
|
valuesAsJson: CellValue[][];
|
|
31385
|
+
/**
|
|
31386
|
+
* A JSON representation of the values in the cells in this range.
|
|
31387
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31388
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`.
|
|
31389
|
+
*
|
|
31390
|
+
* @remarks
|
|
31391
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31392
|
+
* @beta
|
|
31393
|
+
*/
|
|
31394
|
+
valuesAsJsonLocal: CellValue[][];
|
|
31206
31395
|
/**
|
|
31207
31396
|
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
31208
31397
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -31601,13 +31790,24 @@ declare namespace Excel {
|
|
|
31601
31790
|
readonly value: any;
|
|
31602
31791
|
/**
|
|
31603
31792
|
* A JSON representation of the values in this named item.
|
|
31604
|
-
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
|
|
31793
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31794
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`.
|
|
31605
31795
|
*
|
|
31606
31796
|
* @remarks
|
|
31607
31797
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31608
31798
|
* @beta
|
|
31609
31799
|
*/
|
|
31610
31800
|
readonly valueAsJson: CellValue;
|
|
31801
|
+
/**
|
|
31802
|
+
* A JSON representation of the values in this named item.
|
|
31803
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31804
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`.
|
|
31805
|
+
*
|
|
31806
|
+
* @remarks
|
|
31807
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31808
|
+
* @beta
|
|
31809
|
+
*/
|
|
31810
|
+
readonly valueAsJsonLocal: CellValue[][];
|
|
31611
31811
|
/**
|
|
31612
31812
|
* Specifies if the object is visible.
|
|
31613
31813
|
*
|
|
@@ -31696,14 +31896,25 @@ declare namespace Excel {
|
|
|
31696
31896
|
*/
|
|
31697
31897
|
readonly values: any[][];
|
|
31698
31898
|
/**
|
|
31699
|
-
* A JSON representation of the values in
|
|
31700
|
-
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
|
|
31899
|
+
* A JSON representation of the values in this named item array.
|
|
31900
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31901
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`.
|
|
31701
31902
|
*
|
|
31702
31903
|
* @remarks
|
|
31703
31904
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31704
31905
|
* @beta
|
|
31705
31906
|
*/
|
|
31706
31907
|
readonly valuesAsJson: CellValue[][];
|
|
31908
|
+
/**
|
|
31909
|
+
* A JSON representation of the values in this named item array.
|
|
31910
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
31911
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`.
|
|
31912
|
+
*
|
|
31913
|
+
* @remarks
|
|
31914
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
31915
|
+
* @beta
|
|
31916
|
+
*/
|
|
31917
|
+
readonly valuesAsJsonLocal: CellValue[][];
|
|
31707
31918
|
/**
|
|
31708
31919
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
31709
31920
|
*
|
|
@@ -32580,13 +32791,24 @@ declare namespace Excel {
|
|
|
32580
32791
|
values: any[][];
|
|
32581
32792
|
/**
|
|
32582
32793
|
* A JSON representation of the values in the cells in this table column.
|
|
32583
|
-
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
|
|
32794
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
32795
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`.
|
|
32584
32796
|
*
|
|
32585
32797
|
* @remarks
|
|
32586
32798
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
32587
32799
|
* @beta
|
|
32588
32800
|
*/
|
|
32589
32801
|
valuesAsJson: CellValue[][];
|
|
32802
|
+
/**
|
|
32803
|
+
* A JSON representation of the values in the cells in this table column.
|
|
32804
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
32805
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`.
|
|
32806
|
+
*
|
|
32807
|
+
* @remarks
|
|
32808
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
32809
|
+
* @beta
|
|
32810
|
+
*/
|
|
32811
|
+
valuesAsJsonLocal: CellValue[][];
|
|
32590
32812
|
/**
|
|
32591
32813
|
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
32592
32814
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -32689,10 +32911,11 @@ declare namespace Excel {
|
|
|
32689
32911
|
to point at the index for which it was created.
|
|
32690
32912
|
*
|
|
32691
32913
|
* @remarks
|
|
32692
|
-
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.]
|
|
32914
|
+
* [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; ExcelApi BETA (PREVIEW ONLY) for adding `alwaysInsert` parameter.]
|
|
32693
32915
|
*
|
|
32694
32916
|
* @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
|
|
32695
32917
|
* @param values Optional. A 2D array of unformatted values of the table row.
|
|
32918
|
+
* @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
|
|
32696
32919
|
*/
|
|
32697
32920
|
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
|
|
32698
32921
|
/**
|
|
@@ -32793,13 +33016,24 @@ declare namespace Excel {
|
|
|
32793
33016
|
values: any[][];
|
|
32794
33017
|
/**
|
|
32795
33018
|
* A JSON representation of the values in the cells in this table row.
|
|
32796
|
-
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
|
|
33019
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
33020
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`.
|
|
32797
33021
|
*
|
|
32798
33022
|
* @remarks
|
|
32799
33023
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
32800
33024
|
* @beta
|
|
32801
33025
|
*/
|
|
32802
33026
|
valuesAsJson: CellValue[][];
|
|
33027
|
+
/**
|
|
33028
|
+
* A JSON representation of the values in the cells in this table row.
|
|
33029
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
33030
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`.
|
|
33031
|
+
*
|
|
33032
|
+
* @remarks
|
|
33033
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
33034
|
+
* @beta
|
|
33035
|
+
*/
|
|
33036
|
+
valuesAsJsonLocal: CellValue[][];
|
|
32803
33037
|
/**
|
|
32804
33038
|
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
32805
33039
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
@@ -34870,6 +35104,46 @@ declare namespace Excel {
|
|
|
34870
35104
|
* [Api set: ExcelApi 1.7]
|
|
34871
35105
|
*/
|
|
34872
35106
|
delete(): void;
|
|
35107
|
+
/**
|
|
35108
|
+
* Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
|
|
35109
|
+
*
|
|
35110
|
+
* @remarks
|
|
35111
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35112
|
+
* @beta
|
|
35113
|
+
*
|
|
35114
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
35115
|
+
*/
|
|
35116
|
+
getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
|
|
35117
|
+
/**
|
|
35118
|
+
* Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
|
|
35119
|
+
*
|
|
35120
|
+
* @remarks
|
|
35121
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35122
|
+
* @beta
|
|
35123
|
+
*
|
|
35124
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
35125
|
+
*/
|
|
35126
|
+
getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;
|
|
35127
|
+
/**
|
|
35128
|
+
* Gets the data source type of the chart series.
|
|
35129
|
+
*
|
|
35130
|
+
* @remarks
|
|
35131
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35132
|
+
* @beta
|
|
35133
|
+
*
|
|
35134
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
35135
|
+
*/
|
|
35136
|
+
getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
|
|
35137
|
+
/**
|
|
35138
|
+
* Gets the data source type of the chart series.
|
|
35139
|
+
*
|
|
35140
|
+
* @remarks
|
|
35141
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35142
|
+
* @beta
|
|
35143
|
+
*
|
|
35144
|
+
* @param dimension The dimension of the axis where the data is from.
|
|
35145
|
+
*/
|
|
35146
|
+
getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
|
|
34873
35147
|
/**
|
|
34874
35148
|
* Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series.
|
|
34875
35149
|
*
|
|
@@ -37315,6 +37589,22 @@ declare namespace Excel {
|
|
|
37315
37589
|
class ChartFill extends OfficeExtension.ClientObject {
|
|
37316
37590
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
37317
37591
|
context: RequestContext;
|
|
37592
|
+
/**
|
|
37593
|
+
* Sets and gets the uniform color fill formatting of a chart element.
|
|
37594
|
+
*
|
|
37595
|
+
* @remarks
|
|
37596
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
37597
|
+
* @beta
|
|
37598
|
+
*/
|
|
37599
|
+
solidColor: string;
|
|
37600
|
+
/**
|
|
37601
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
37602
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
37603
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
37604
|
+
*/
|
|
37605
|
+
set(properties: Interfaces.ChartFillUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
37606
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
37607
|
+
set(properties: Excel.ChartFill): void;
|
|
37318
37608
|
/**
|
|
37319
37609
|
* Clears the fill color of a chart element.
|
|
37320
37610
|
*
|
|
@@ -48820,6 +49110,35 @@ declare namespace Excel {
|
|
|
48820
49110
|
*/
|
|
48821
49111
|
rows = "Rows"
|
|
48822
49112
|
}
|
|
49113
|
+
/**
|
|
49114
|
+
* Specifies whether the series data range is local range, external range, list or unknown.
|
|
49115
|
+
*
|
|
49116
|
+
* @remarks
|
|
49117
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
49118
|
+
* @beta
|
|
49119
|
+
*/
|
|
49120
|
+
enum ChartDataSourceType {
|
|
49121
|
+
/**
|
|
49122
|
+
* @remarks
|
|
49123
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
49124
|
+
*/
|
|
49125
|
+
localRange = "LocalRange",
|
|
49126
|
+
/**
|
|
49127
|
+
* @remarks
|
|
49128
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
49129
|
+
*/
|
|
49130
|
+
externalRange = "ExternalRange",
|
|
49131
|
+
/**
|
|
49132
|
+
* @remarks
|
|
49133
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
49134
|
+
*/
|
|
49135
|
+
list = "List",
|
|
49136
|
+
/**
|
|
49137
|
+
* @remarks
|
|
49138
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
49139
|
+
*/
|
|
49140
|
+
unknown = "Unknown"
|
|
49141
|
+
}
|
|
48823
49142
|
/**
|
|
48824
49143
|
* Represents the horizontal alignment for the specified object.
|
|
48825
49144
|
*
|
|
@@ -59368,13 +59687,24 @@ declare namespace Excel {
|
|
|
59368
59687
|
values?: any[][];
|
|
59369
59688
|
/**
|
|
59370
59689
|
* A JSON representation of the values in the cells in this range.
|
|
59371
|
-
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
|
|
59690
|
+
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59691
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`.
|
|
59372
59692
|
*
|
|
59373
59693
|
* @remarks
|
|
59374
59694
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59375
59695
|
* @beta
|
|
59376
59696
|
*/
|
|
59377
59697
|
valuesAsJson?: CellValue[][];
|
|
59698
|
+
/**
|
|
59699
|
+
* A JSON representation of the values in the cells in this range.
|
|
59700
|
+
Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59701
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`.
|
|
59702
|
+
*
|
|
59703
|
+
* @remarks
|
|
59704
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59705
|
+
* @beta
|
|
59706
|
+
*/
|
|
59707
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
59378
59708
|
}
|
|
59379
59709
|
/** An interface for updating data on the RangeAreas object, for use in `rangeAreas.set({ ... })`. */
|
|
59380
59710
|
interface RangeAreasUpdateData {
|
|
@@ -59441,13 +59771,24 @@ declare namespace Excel {
|
|
|
59441
59771
|
values?: any[][];
|
|
59442
59772
|
/**
|
|
59443
59773
|
* A JSON representation of the values in the cells in this range.
|
|
59444
|
-
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
|
|
59774
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59775
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`.
|
|
59445
59776
|
*
|
|
59446
59777
|
* @remarks
|
|
59447
59778
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59448
59779
|
* @beta
|
|
59449
59780
|
*/
|
|
59450
59781
|
valuesAsJson?: CellValue[][];
|
|
59782
|
+
/**
|
|
59783
|
+
* A JSON representation of the values in the cells in this range.
|
|
59784
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59785
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`.
|
|
59786
|
+
*
|
|
59787
|
+
* @remarks
|
|
59788
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59789
|
+
* @beta
|
|
59790
|
+
*/
|
|
59791
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
59451
59792
|
}
|
|
59452
59793
|
/** An interface for updating data on the RangeViewCollection object, for use in `rangeViewCollection.set({ ... })`. */
|
|
59453
59794
|
interface RangeViewCollectionUpdateData {
|
|
@@ -59606,13 +59947,24 @@ declare namespace Excel {
|
|
|
59606
59947
|
values?: any[][];
|
|
59607
59948
|
/**
|
|
59608
59949
|
* A JSON representation of the values in the cells in this table column.
|
|
59609
|
-
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
|
|
59950
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59951
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`.
|
|
59610
59952
|
*
|
|
59611
59953
|
* @remarks
|
|
59612
59954
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59613
59955
|
* @beta
|
|
59614
59956
|
*/
|
|
59615
59957
|
valuesAsJson?: CellValue[][];
|
|
59958
|
+
/**
|
|
59959
|
+
* A JSON representation of the values in the cells in this table column.
|
|
59960
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59961
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`.
|
|
59962
|
+
*
|
|
59963
|
+
* @remarks
|
|
59964
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59965
|
+
* @beta
|
|
59966
|
+
*/
|
|
59967
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
59616
59968
|
}
|
|
59617
59969
|
/** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */
|
|
59618
59970
|
interface TableRowCollectionUpdateData {
|
|
@@ -59630,13 +59982,24 @@ declare namespace Excel {
|
|
|
59630
59982
|
values?: any[][];
|
|
59631
59983
|
/**
|
|
59632
59984
|
* A JSON representation of the values in the cells in this table row.
|
|
59633
|
-
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
|
|
59985
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59986
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`.
|
|
59634
59987
|
*
|
|
59635
59988
|
* @remarks
|
|
59636
59989
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59637
59990
|
* @beta
|
|
59638
59991
|
*/
|
|
59639
59992
|
valuesAsJson?: CellValue[][];
|
|
59993
|
+
/**
|
|
59994
|
+
* A JSON representation of the values in the cells in this table row.
|
|
59995
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
59996
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`.
|
|
59997
|
+
*
|
|
59998
|
+
* @remarks
|
|
59999
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
60000
|
+
* @beta
|
|
60001
|
+
*/
|
|
60002
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
59640
60003
|
}
|
|
59641
60004
|
/** An interface for updating data on the DataValidation object, for use in `dataValidation.set({ ... })`. */
|
|
59642
60005
|
interface DataValidationUpdateData {
|
|
@@ -61526,6 +61889,17 @@ declare namespace Excel {
|
|
|
61526
61889
|
*/
|
|
61527
61890
|
font?: Excel.Interfaces.ChartFontUpdateData;
|
|
61528
61891
|
}
|
|
61892
|
+
/** An interface for updating data on the ChartFill object, for use in `chartFill.set({ ... })`. */
|
|
61893
|
+
interface ChartFillUpdateData {
|
|
61894
|
+
/**
|
|
61895
|
+
* Sets and gets the uniform color fill formatting of a chart element.
|
|
61896
|
+
*
|
|
61897
|
+
* @remarks
|
|
61898
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
61899
|
+
* @beta
|
|
61900
|
+
*/
|
|
61901
|
+
solidColor?: string;
|
|
61902
|
+
}
|
|
61529
61903
|
/** An interface for updating data on the ChartBorder object, for use in `chartBorder.set({ ... })`. */
|
|
61530
61904
|
interface ChartBorderUpdateData {
|
|
61531
61905
|
/**
|
|
@@ -64789,6 +65163,15 @@ declare namespace Excel {
|
|
|
64789
65163
|
* [Api set: ExcelApi 1.2]
|
|
64790
65164
|
*/
|
|
64791
65165
|
protected?: boolean;
|
|
65166
|
+
/**
|
|
65167
|
+
* Specifies the protection options settings saved in the worksheet.
|
|
65168
|
+
This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
|
|
65169
|
+
*
|
|
65170
|
+
* @remarks
|
|
65171
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65172
|
+
* @beta
|
|
65173
|
+
*/
|
|
65174
|
+
savedOptions?: Excel.WorksheetProtectionOptions;
|
|
64792
65175
|
}
|
|
64793
65176
|
/** An interface describing the data returned by calling `range.toJSON()`. */
|
|
64794
65177
|
interface RangeData {
|
|
@@ -65027,13 +65410,24 @@ declare namespace Excel {
|
|
|
65027
65410
|
values?: any[][];
|
|
65028
65411
|
/**
|
|
65029
65412
|
* A JSON representation of the values in the cells in this range.
|
|
65030
|
-
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
|
|
65413
|
+
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65414
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`.
|
|
65031
65415
|
*
|
|
65032
65416
|
* @remarks
|
|
65033
65417
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65034
65418
|
* @beta
|
|
65035
65419
|
*/
|
|
65036
65420
|
valuesAsJson?: CellValue[][];
|
|
65421
|
+
/**
|
|
65422
|
+
* A JSON representation of the values in the cells in this range.
|
|
65423
|
+
Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65424
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`.
|
|
65425
|
+
*
|
|
65426
|
+
* @remarks
|
|
65427
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65428
|
+
* @beta
|
|
65429
|
+
*/
|
|
65430
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
65037
65431
|
/**
|
|
65038
65432
|
* Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
|
|
65039
65433
|
*
|
|
@@ -65236,13 +65630,24 @@ declare namespace Excel {
|
|
|
65236
65630
|
values?: any[][];
|
|
65237
65631
|
/**
|
|
65238
65632
|
* A JSON representation of the values in the cells in this range.
|
|
65239
|
-
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
|
|
65633
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65634
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`.
|
|
65240
65635
|
*
|
|
65241
65636
|
* @remarks
|
|
65242
65637
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65243
65638
|
* @beta
|
|
65244
65639
|
*/
|
|
65245
65640
|
valuesAsJson?: CellValue[][];
|
|
65641
|
+
/**
|
|
65642
|
+
* A JSON representation of the values in the cells in this range.
|
|
65643
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65644
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`.
|
|
65645
|
+
*
|
|
65646
|
+
* @remarks
|
|
65647
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65648
|
+
* @beta
|
|
65649
|
+
*/
|
|
65650
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
65246
65651
|
}
|
|
65247
65652
|
/** An interface describing the data returned by calling `rangeViewCollection.toJSON()`. */
|
|
65248
65653
|
interface RangeViewCollectionData {
|
|
@@ -65326,13 +65731,24 @@ declare namespace Excel {
|
|
|
65326
65731
|
value?: any;
|
|
65327
65732
|
/**
|
|
65328
65733
|
* A JSON representation of the values in this named item.
|
|
65329
|
-
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
|
|
65734
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65735
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`.
|
|
65330
65736
|
*
|
|
65331
65737
|
* @remarks
|
|
65332
65738
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65333
65739
|
* @beta
|
|
65334
65740
|
*/
|
|
65335
65741
|
valueAsJson?: CellValue;
|
|
65742
|
+
/**
|
|
65743
|
+
* A JSON representation of the values in this named item.
|
|
65744
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65745
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`.
|
|
65746
|
+
*
|
|
65747
|
+
* @remarks
|
|
65748
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65749
|
+
* @beta
|
|
65750
|
+
*/
|
|
65751
|
+
valueAsJsonLocal?: CellValue[][];
|
|
65336
65752
|
/**
|
|
65337
65753
|
* Specifies if the object is visible.
|
|
65338
65754
|
*
|
|
@@ -65358,14 +65774,25 @@ declare namespace Excel {
|
|
|
65358
65774
|
*/
|
|
65359
65775
|
values?: any[][];
|
|
65360
65776
|
/**
|
|
65361
|
-
* A JSON representation of the values in
|
|
65362
|
-
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
|
|
65777
|
+
* A JSON representation of the values in this named item array.
|
|
65778
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65779
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`.
|
|
65363
65780
|
*
|
|
65364
65781
|
* @remarks
|
|
65365
65782
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65366
65783
|
* @beta
|
|
65367
65784
|
*/
|
|
65368
65785
|
valuesAsJson?: CellValue[][];
|
|
65786
|
+
/**
|
|
65787
|
+
* A JSON representation of the values in this named item array.
|
|
65788
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65789
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`.
|
|
65790
|
+
*
|
|
65791
|
+
* @remarks
|
|
65792
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65793
|
+
* @beta
|
|
65794
|
+
*/
|
|
65795
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
65369
65796
|
}
|
|
65370
65797
|
/** An interface describing the data returned by calling `binding.toJSON()`. */
|
|
65371
65798
|
interface BindingData {
|
|
@@ -65558,13 +65985,24 @@ declare namespace Excel {
|
|
|
65558
65985
|
values?: any[][];
|
|
65559
65986
|
/**
|
|
65560
65987
|
* A JSON representation of the values in the cells in this table column.
|
|
65561
|
-
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
|
|
65988
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65989
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`.
|
|
65562
65990
|
*
|
|
65563
65991
|
* @remarks
|
|
65564
65992
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65565
65993
|
* @beta
|
|
65566
65994
|
*/
|
|
65567
65995
|
valuesAsJson?: CellValue[][];
|
|
65996
|
+
/**
|
|
65997
|
+
* A JSON representation of the values in the cells in this table column.
|
|
65998
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
65999
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`.
|
|
66000
|
+
*
|
|
66001
|
+
* @remarks
|
|
66002
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
66003
|
+
* @beta
|
|
66004
|
+
*/
|
|
66005
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
65568
66006
|
}
|
|
65569
66007
|
/** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */
|
|
65570
66008
|
interface TableRowCollectionData {
|
|
@@ -65589,13 +66027,24 @@ declare namespace Excel {
|
|
|
65589
66027
|
values?: any[][];
|
|
65590
66028
|
/**
|
|
65591
66029
|
* A JSON representation of the values in the cells in this table row.
|
|
65592
|
-
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
|
|
66030
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
66031
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`.
|
|
65593
66032
|
*
|
|
65594
66033
|
* @remarks
|
|
65595
66034
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
65596
66035
|
* @beta
|
|
65597
66036
|
*/
|
|
65598
66037
|
valuesAsJson?: CellValue[][];
|
|
66038
|
+
/**
|
|
66039
|
+
* A JSON representation of the values in the cells in this table row.
|
|
66040
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
66041
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`.
|
|
66042
|
+
*
|
|
66043
|
+
* @remarks
|
|
66044
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
66045
|
+
* @beta
|
|
66046
|
+
*/
|
|
66047
|
+
valuesAsJsonLocal?: CellValue[][];
|
|
65599
66048
|
}
|
|
65600
66049
|
/** An interface describing the data returned by calling `dataValidation.toJSON()`. */
|
|
65601
66050
|
interface DataValidationData {
|
|
@@ -67678,6 +68127,17 @@ declare namespace Excel {
|
|
|
67678
68127
|
*/
|
|
67679
68128
|
font?: Excel.Interfaces.ChartFontData;
|
|
67680
68129
|
}
|
|
68130
|
+
/** An interface describing the data returned by calling `chartFill.toJSON()`. */
|
|
68131
|
+
interface ChartFillData {
|
|
68132
|
+
/**
|
|
68133
|
+
* Sets and gets the uniform color fill formatting of a chart element.
|
|
68134
|
+
*
|
|
68135
|
+
* @remarks
|
|
68136
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
68137
|
+
* @beta
|
|
68138
|
+
*/
|
|
68139
|
+
solidColor?: string;
|
|
68140
|
+
}
|
|
67681
68141
|
/** An interface describing the data returned by calling `chartBorder.toJSON()`. */
|
|
67682
68142
|
interface ChartBorderData {
|
|
67683
68143
|
/**
|
|
@@ -72148,6 +72608,15 @@ declare namespace Excel {
|
|
|
72148
72608
|
* [Api set: ExcelApi 1.2]
|
|
72149
72609
|
*/
|
|
72150
72610
|
protected?: boolean;
|
|
72611
|
+
/**
|
|
72612
|
+
* Specifies the protection options settings saved in the worksheet.
|
|
72613
|
+
This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
|
|
72614
|
+
*
|
|
72615
|
+
* @remarks
|
|
72616
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72617
|
+
* @beta
|
|
72618
|
+
*/
|
|
72619
|
+
savedOptions?: boolean;
|
|
72151
72620
|
}
|
|
72152
72621
|
/**
|
|
72153
72622
|
* Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
|
|
@@ -72396,13 +72865,24 @@ declare namespace Excel {
|
|
|
72396
72865
|
values?: boolean;
|
|
72397
72866
|
/**
|
|
72398
72867
|
* A JSON representation of the values in the cells in this range.
|
|
72399
|
-
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
|
|
72868
|
+
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
72869
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`.
|
|
72400
72870
|
*
|
|
72401
72871
|
* @remarks
|
|
72402
72872
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72403
72873
|
* @beta
|
|
72404
72874
|
*/
|
|
72405
72875
|
valuesAsJson?: boolean;
|
|
72876
|
+
/**
|
|
72877
|
+
* A JSON representation of the values in the cells in this range.
|
|
72878
|
+
Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
72879
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`.
|
|
72880
|
+
*
|
|
72881
|
+
* @remarks
|
|
72882
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72883
|
+
* @beta
|
|
72884
|
+
*/
|
|
72885
|
+
valuesAsJsonLocal?: boolean;
|
|
72406
72886
|
/**
|
|
72407
72887
|
* Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
|
|
72408
72888
|
*
|
|
@@ -72605,13 +73085,24 @@ declare namespace Excel {
|
|
|
72605
73085
|
values?: boolean;
|
|
72606
73086
|
/**
|
|
72607
73087
|
* A JSON representation of the values in the cells in this range.
|
|
72608
|
-
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
|
|
73088
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73089
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`.
|
|
72609
73090
|
*
|
|
72610
73091
|
* @remarks
|
|
72611
73092
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72612
73093
|
* @beta
|
|
72613
73094
|
*/
|
|
72614
73095
|
valuesAsJson?: boolean;
|
|
73096
|
+
/**
|
|
73097
|
+
* A JSON representation of the values in the cells in this range.
|
|
73098
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73099
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`.
|
|
73100
|
+
*
|
|
73101
|
+
* @remarks
|
|
73102
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73103
|
+
* @beta
|
|
73104
|
+
*/
|
|
73105
|
+
valuesAsJsonLocal?: boolean;
|
|
72615
73106
|
}
|
|
72616
73107
|
/**
|
|
72617
73108
|
* Represents a collection of `RangeView` objects.
|
|
@@ -72703,13 +73194,24 @@ declare namespace Excel {
|
|
|
72703
73194
|
values?: boolean;
|
|
72704
73195
|
/**
|
|
72705
73196
|
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
|
|
72706
|
-
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
|
|
73197
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73198
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`.
|
|
72707
73199
|
*
|
|
72708
73200
|
* @remarks
|
|
72709
73201
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72710
73202
|
* @beta
|
|
72711
73203
|
*/
|
|
72712
73204
|
valuesAsJson?: boolean;
|
|
73205
|
+
/**
|
|
73206
|
+
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
|
|
73207
|
+
Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73208
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`.
|
|
73209
|
+
*
|
|
73210
|
+
* @remarks
|
|
73211
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73212
|
+
* @beta
|
|
73213
|
+
*/
|
|
73214
|
+
valuesAsJsonLocal?: boolean;
|
|
72713
73215
|
}
|
|
72714
73216
|
/**
|
|
72715
73217
|
* Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.
|
|
@@ -72840,13 +73342,24 @@ declare namespace Excel {
|
|
|
72840
73342
|
value?: boolean;
|
|
72841
73343
|
/**
|
|
72842
73344
|
* For EACH ITEM in the collection: A JSON representation of the values in this named item.
|
|
72843
|
-
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
|
|
73345
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73346
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`.
|
|
72844
73347
|
*
|
|
72845
73348
|
* @remarks
|
|
72846
73349
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72847
73350
|
* @beta
|
|
72848
73351
|
*/
|
|
72849
73352
|
valueAsJson?: boolean;
|
|
73353
|
+
/**
|
|
73354
|
+
* For EACH ITEM in the collection: A JSON representation of the values in this named item.
|
|
73355
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73356
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`.
|
|
73357
|
+
*
|
|
73358
|
+
* @remarks
|
|
73359
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73360
|
+
* @beta
|
|
73361
|
+
*/
|
|
73362
|
+
valueAsJsonLocal?: boolean;
|
|
72850
73363
|
/**
|
|
72851
73364
|
* For EACH ITEM in the collection: Specifies if the object is visible.
|
|
72852
73365
|
*
|
|
@@ -72932,13 +73445,24 @@ declare namespace Excel {
|
|
|
72932
73445
|
value?: boolean;
|
|
72933
73446
|
/**
|
|
72934
73447
|
* A JSON representation of the values in this named item.
|
|
72935
|
-
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
|
|
73448
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73449
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`.
|
|
72936
73450
|
*
|
|
72937
73451
|
* @remarks
|
|
72938
73452
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72939
73453
|
* @beta
|
|
72940
73454
|
*/
|
|
72941
73455
|
valueAsJson?: boolean;
|
|
73456
|
+
/**
|
|
73457
|
+
* A JSON representation of the values in this named item.
|
|
73458
|
+
Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73459
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`.
|
|
73460
|
+
*
|
|
73461
|
+
* @remarks
|
|
73462
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73463
|
+
* @beta
|
|
73464
|
+
*/
|
|
73465
|
+
valueAsJsonLocal?: boolean;
|
|
72942
73466
|
/**
|
|
72943
73467
|
* Specifies if the object is visible.
|
|
72944
73468
|
*
|
|
@@ -72973,14 +73497,25 @@ declare namespace Excel {
|
|
|
72973
73497
|
*/
|
|
72974
73498
|
values?: boolean;
|
|
72975
73499
|
/**
|
|
72976
|
-
* A JSON representation of the values in
|
|
72977
|
-
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
|
|
73500
|
+
* A JSON representation of the values in this named item array.
|
|
73501
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73502
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`.
|
|
72978
73503
|
*
|
|
72979
73504
|
* @remarks
|
|
72980
73505
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
72981
73506
|
* @beta
|
|
72982
73507
|
*/
|
|
72983
73508
|
valuesAsJson?: boolean;
|
|
73509
|
+
/**
|
|
73510
|
+
* A JSON representation of the values in this named item array.
|
|
73511
|
+
Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
73512
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`.
|
|
73513
|
+
*
|
|
73514
|
+
* @remarks
|
|
73515
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73516
|
+
* @beta
|
|
73517
|
+
*/
|
|
73518
|
+
valuesAsJsonLocal?: boolean;
|
|
72984
73519
|
}
|
|
72985
73520
|
/**
|
|
72986
73521
|
* Represents an Office.js binding that is defined in the workbook.
|
|
@@ -73486,13 +74021,24 @@ declare namespace Excel {
|
|
|
73486
74021
|
values?: boolean;
|
|
73487
74022
|
/**
|
|
73488
74023
|
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this table column.
|
|
73489
|
-
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
|
|
74024
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74025
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`.
|
|
73490
74026
|
*
|
|
73491
74027
|
* @remarks
|
|
73492
74028
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73493
74029
|
* @beta
|
|
73494
74030
|
*/
|
|
73495
74031
|
valuesAsJson?: boolean;
|
|
74032
|
+
/**
|
|
74033
|
+
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this table column.
|
|
74034
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74035
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`.
|
|
74036
|
+
*
|
|
74037
|
+
* @remarks
|
|
74038
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
74039
|
+
* @beta
|
|
74040
|
+
*/
|
|
74041
|
+
valuesAsJsonLocal?: boolean;
|
|
73496
74042
|
}
|
|
73497
74043
|
/**
|
|
73498
74044
|
* Represents a column in a table.
|
|
@@ -73543,13 +74089,24 @@ declare namespace Excel {
|
|
|
73543
74089
|
values?: boolean;
|
|
73544
74090
|
/**
|
|
73545
74091
|
* A JSON representation of the values in the cells in this table column.
|
|
73546
|
-
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
|
|
74092
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74093
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`.
|
|
73547
74094
|
*
|
|
73548
74095
|
* @remarks
|
|
73549
74096
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73550
74097
|
* @beta
|
|
73551
74098
|
*/
|
|
73552
74099
|
valuesAsJson?: boolean;
|
|
74100
|
+
/**
|
|
74101
|
+
* A JSON representation of the values in the cells in this table column.
|
|
74102
|
+
Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74103
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`.
|
|
74104
|
+
*
|
|
74105
|
+
* @remarks
|
|
74106
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
74107
|
+
* @beta
|
|
74108
|
+
*/
|
|
74109
|
+
valuesAsJsonLocal?: boolean;
|
|
73553
74110
|
}
|
|
73554
74111
|
/**
|
|
73555
74112
|
* Represents a collection of all the rows that are part of the table.
|
|
@@ -73584,13 +74141,24 @@ declare namespace Excel {
|
|
|
73584
74141
|
values?: boolean;
|
|
73585
74142
|
/**
|
|
73586
74143
|
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this table row.
|
|
73587
|
-
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
|
|
74144
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74145
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`.
|
|
73588
74146
|
*
|
|
73589
74147
|
* @remarks
|
|
73590
74148
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73591
74149
|
* @beta
|
|
73592
74150
|
*/
|
|
73593
74151
|
valuesAsJson?: boolean;
|
|
74152
|
+
/**
|
|
74153
|
+
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this table row.
|
|
74154
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74155
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`.
|
|
74156
|
+
*
|
|
74157
|
+
* @remarks
|
|
74158
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
74159
|
+
* @beta
|
|
74160
|
+
*/
|
|
74161
|
+
valuesAsJsonLocal?: boolean;
|
|
73594
74162
|
}
|
|
73595
74163
|
/**
|
|
73596
74164
|
* Represents a row in a table.
|
|
@@ -73625,13 +74193,24 @@ declare namespace Excel {
|
|
|
73625
74193
|
values?: boolean;
|
|
73626
74194
|
/**
|
|
73627
74195
|
* A JSON representation of the values in the cells in this table row.
|
|
73628
|
-
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
|
|
74196
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74197
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`.
|
|
73629
74198
|
*
|
|
73630
74199
|
* @remarks
|
|
73631
74200
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
73632
74201
|
* @beta
|
|
73633
74202
|
*/
|
|
73634
74203
|
valuesAsJson?: boolean;
|
|
74204
|
+
/**
|
|
74205
|
+
* A JSON representation of the values in the cells in this table row.
|
|
74206
|
+
Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
74207
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`.
|
|
74208
|
+
*
|
|
74209
|
+
* @remarks
|
|
74210
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
74211
|
+
* @beta
|
|
74212
|
+
*/
|
|
74213
|
+
valuesAsJsonLocal?: boolean;
|
|
73635
74214
|
}
|
|
73636
74215
|
/**
|
|
73637
74216
|
* Represents the data validation applied to the current range.
|
|
@@ -76685,6 +77264,26 @@ declare namespace Excel {
|
|
|
76685
77264
|
*/
|
|
76686
77265
|
font?: Excel.Interfaces.ChartFontLoadOptions;
|
|
76687
77266
|
}
|
|
77267
|
+
/**
|
|
77268
|
+
* Represents the fill formatting for a chart element.
|
|
77269
|
+
*
|
|
77270
|
+
* @remarks
|
|
77271
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
77272
|
+
*/
|
|
77273
|
+
interface ChartFillLoadOptions {
|
|
77274
|
+
/**
|
|
77275
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
77276
|
+
*/
|
|
77277
|
+
$all?: boolean;
|
|
77278
|
+
/**
|
|
77279
|
+
* Sets and gets the uniform color fill formatting of a chart element.
|
|
77280
|
+
*
|
|
77281
|
+
* @remarks
|
|
77282
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
77283
|
+
* @beta
|
|
77284
|
+
*/
|
|
77285
|
+
solidColor?: boolean;
|
|
77286
|
+
}
|
|
76688
77287
|
/**
|
|
76689
77288
|
* Represents the border formatting of a chart element.
|
|
76690
77289
|
*
|
|
@@ -80607,13 +81206,24 @@ declare namespace Excel {
|
|
|
80607
81206
|
values?: boolean;
|
|
80608
81207
|
/**
|
|
80609
81208
|
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
|
|
80610
|
-
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
|
|
81209
|
+
Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
81210
|
+
Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`.
|
|
80611
81211
|
*
|
|
80612
81212
|
* @remarks
|
|
80613
81213
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
80614
81214
|
* @beta
|
|
80615
81215
|
*/
|
|
80616
81216
|
valuesAsJson?: boolean;
|
|
81217
|
+
/**
|
|
81218
|
+
* For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
|
|
81219
|
+
Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values.
|
|
81220
|
+
Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`.
|
|
81221
|
+
*
|
|
81222
|
+
* @remarks
|
|
81223
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81224
|
+
* @beta
|
|
81225
|
+
*/
|
|
81226
|
+
valuesAsJsonLocal?: boolean;
|
|
80617
81227
|
/**
|
|
80618
81228
|
* For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
|
|
80619
81229
|
*
|