@types/office-js 1.0.374 → 1.0.376
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +715 -886
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -351,11 +351,11 @@ declare namespace Office {
|
|
|
351
351
|
*/
|
|
352
352
|
enum VisibilityMode {
|
|
353
353
|
/**
|
|
354
|
-
* UI is
|
|
354
|
+
* UI is hidden.
|
|
355
355
|
*/
|
|
356
356
|
hidden = 'Hidden',
|
|
357
357
|
/**
|
|
358
|
-
* Displayed as
|
|
358
|
+
* Displayed as a task pane.
|
|
359
359
|
*/
|
|
360
360
|
taskpane = 'Taskpane',
|
|
361
361
|
}
|
|
@@ -8719,9 +8719,16 @@ declare namespace Office {
|
|
|
8719
8719
|
*
|
|
8720
8720
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
8721
8721
|
*
|
|
8722
|
-
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
8723
|
-
*
|
|
8724
|
-
*
|
|
8722
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
|
|
8723
|
+
* until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
8724
|
+
* The following APIs will also be retired.
|
|
8725
|
+
*
|
|
8726
|
+
* - `Office.context.mailbox.item.getEntities`
|
|
8727
|
+
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
8728
|
+
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
8729
|
+
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
8730
|
+
*
|
|
8731
|
+
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
8725
8732
|
*
|
|
8726
8733
|
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
8727
8734
|
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
@@ -11599,20 +11606,14 @@ declare namespace Office {
|
|
|
11599
11606
|
*
|
|
11600
11607
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11601
11608
|
*
|
|
11602
|
-
* **Important**:
|
|
11603
|
-
*
|
|
11604
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
11605
|
-
* entities in mail items to perform tasks on them.
|
|
11606
|
-
*
|
|
11607
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11608
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11609
|
-
* to activate the **Join Meeting** button.
|
|
11609
|
+
* **Important**:
|
|
11610
11610
|
*
|
|
11611
|
+
* - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
11612
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
11611
11613
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11612
11614
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11613
11615
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11614
|
-
*
|
|
11615
|
-
* For more information, see
|
|
11616
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
11616
11617
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11617
11618
|
*
|
|
11618
11619
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
@@ -11636,18 +11637,12 @@ declare namespace Office {
|
|
|
11636
11637
|
*
|
|
11637
11638
|
* **Important**:
|
|
11638
11639
|
*
|
|
11639
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
11640
|
-
* entities in mail items to perform tasks on them.
|
|
11641
|
-
*
|
|
11642
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11643
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11644
|
-
* to activate the **Join Meeting** button.
|
|
11645
|
-
*
|
|
11640
|
+
* - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
11641
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
11646
11642
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11647
11643
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11648
11644
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11649
|
-
*
|
|
11650
|
-
* For more information, see
|
|
11645
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
11651
11646
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11652
11647
|
*
|
|
11653
11648
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
@@ -11719,18 +11714,12 @@ declare namespace Office {
|
|
|
11719
11714
|
*
|
|
11720
11715
|
* **Important**:
|
|
11721
11716
|
*
|
|
11722
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
11723
|
-
* entities in mail items to perform tasks on them.
|
|
11724
|
-
*
|
|
11725
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11726
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11727
|
-
* to activate the **Join Meeting** button.
|
|
11728
|
-
*
|
|
11717
|
+
* - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
11718
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
11729
11719
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11730
11720
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11731
11721
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11732
|
-
*
|
|
11733
|
-
* For more information, see
|
|
11722
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
11734
11723
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11735
11724
|
*
|
|
11736
11725
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -11795,17 +11784,10 @@ declare namespace Office {
|
|
|
11795
11784
|
* **Important**:
|
|
11796
11785
|
*
|
|
11797
11786
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
11798
|
-
* entities in mail items to perform tasks on them.
|
|
11799
|
-
*
|
|
11800
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11801
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11802
|
-
* to activate the **Join Meeting** button.
|
|
11803
|
-
*
|
|
11804
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11805
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11787
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
11788
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11806
11789
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11807
|
-
*
|
|
11808
|
-
* For more information, see
|
|
11790
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
11809
11791
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11810
11792
|
*
|
|
11811
11793
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -11836,17 +11818,10 @@ declare namespace Office {
|
|
|
11836
11818
|
* **Important**:
|
|
11837
11819
|
*
|
|
11838
11820
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
11839
|
-
* entities in mail items to perform tasks on them.
|
|
11840
|
-
*
|
|
11841
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11842
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11843
|
-
* to activate the **Join Meeting** button.
|
|
11844
|
-
*
|
|
11845
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11846
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11821
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
11822
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11847
11823
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11848
|
-
*
|
|
11849
|
-
* For more information, see
|
|
11824
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
11850
11825
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11851
11826
|
*
|
|
11852
11827
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -11874,24 +11849,19 @@ declare namespace Office {
|
|
|
11874
11849
|
*
|
|
11875
11850
|
* **Important**:
|
|
11876
11851
|
*
|
|
11877
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
11878
|
-
* entities in mail items to perform tasks on them.
|
|
11879
|
-
*
|
|
11880
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11881
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11882
|
-
* to activate the **Join Meeting** button.
|
|
11883
|
-
*
|
|
11852
|
+
* - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
11853
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
11884
11854
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11885
11855
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11886
11856
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11887
|
-
*
|
|
11888
|
-
* For more information, see
|
|
11857
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
11889
11858
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11890
11859
|
*
|
|
11891
11860
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11892
11861
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
11893
11862
|
*
|
|
11894
|
-
* - This method isn't supported in Outlook on iOS or Android.
|
|
11863
|
+
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
11864
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11895
11865
|
*
|
|
11896
11866
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
11897
11867
|
*/
|
|
@@ -11916,23 +11886,17 @@ declare namespace Office {
|
|
|
11916
11886
|
* **Important**:
|
|
11917
11887
|
*
|
|
11918
11888
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
11919
|
-
* entities in mail items to perform tasks on them.
|
|
11920
|
-
*
|
|
11921
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
11922
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
11923
|
-
* to activate the **Join Meeting** button.
|
|
11924
|
-
*
|
|
11925
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
11926
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11889
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
11890
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
11927
11891
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
11928
|
-
*
|
|
11929
|
-
* For more information, see
|
|
11892
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
11930
11893
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
11931
11894
|
*
|
|
11932
11895
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
11933
11896
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
11934
11897
|
*
|
|
11935
|
-
* - This method isn't supported in Outlook on iOS or Android.
|
|
11898
|
+
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
11899
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
11936
11900
|
*
|
|
11937
11901
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
11938
11902
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
|
|
@@ -12969,9 +12933,16 @@ declare namespace Office {
|
|
|
12969
12933
|
*
|
|
12970
12934
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
12971
12935
|
*
|
|
12972
|
-
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
12973
|
-
*
|
|
12974
|
-
*
|
|
12936
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
|
|
12937
|
+
* until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
12938
|
+
* The following APIs will also be retired.
|
|
12939
|
+
*
|
|
12940
|
+
* - `Office.context.mailbox.item.getEntities`
|
|
12941
|
+
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
12942
|
+
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
12943
|
+
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
12944
|
+
*
|
|
12945
|
+
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
12975
12946
|
*
|
|
12976
12947
|
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
12977
12948
|
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
@@ -13562,9 +13533,16 @@ declare namespace Office {
|
|
|
13562
13533
|
*
|
|
13563
13534
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
13564
13535
|
*
|
|
13565
|
-
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
13566
|
-
*
|
|
13567
|
-
*
|
|
13536
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
|
|
13537
|
+
* until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
13538
|
+
* The following APIs will also be retired.
|
|
13539
|
+
*
|
|
13540
|
+
* - `Office.context.mailbox.item.getEntities`
|
|
13541
|
+
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
13542
|
+
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
13543
|
+
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
13544
|
+
*
|
|
13545
|
+
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
13568
13546
|
*
|
|
13569
13547
|
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
13570
13548
|
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
@@ -15258,9 +15236,16 @@ declare namespace Office {
|
|
|
15258
15236
|
*
|
|
15259
15237
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
15260
15238
|
*
|
|
15261
|
-
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
15262
|
-
*
|
|
15263
|
-
*
|
|
15239
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
|
|
15240
|
+
* until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
15241
|
+
* The following APIs will also be retired.
|
|
15242
|
+
*
|
|
15243
|
+
* - `Office.context.mailbox.item.getEntities`
|
|
15244
|
+
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
15245
|
+
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
15246
|
+
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
15247
|
+
*
|
|
15248
|
+
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
15264
15249
|
*
|
|
15265
15250
|
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
15266
15251
|
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
@@ -17230,18 +17215,12 @@ declare namespace Office {
|
|
|
17230
17215
|
*
|
|
17231
17216
|
* **Important**:
|
|
17232
17217
|
*
|
|
17233
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
17234
|
-
* entities in mail items to perform tasks on them.
|
|
17235
|
-
*
|
|
17236
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17237
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17238
|
-
* to activate the **Join Meeting** button.
|
|
17239
|
-
*
|
|
17218
|
+
* - Entity-based contextual Outlook add-ins, including the `getEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
17219
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
17240
17220
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17241
17221
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17242
17222
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17243
|
-
*
|
|
17244
|
-
* For more information, see
|
|
17223
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
17245
17224
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17246
17225
|
*
|
|
17247
17226
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
@@ -17265,18 +17244,12 @@ declare namespace Office {
|
|
|
17265
17244
|
*
|
|
17266
17245
|
* **Important**:
|
|
17267
17246
|
*
|
|
17268
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
17269
|
-
* entities in mail items to perform tasks on them.
|
|
17270
|
-
*
|
|
17271
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17272
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17273
|
-
* to activate the **Join Meeting** button.
|
|
17274
|
-
*
|
|
17247
|
+
* - Entity-based contextual Outlook add-ins, including the `getEntitiesByType` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
17248
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
17275
17249
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17276
17250
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17277
17251
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17278
|
-
*
|
|
17279
|
-
* For more information, see
|
|
17252
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
17280
17253
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17281
17254
|
*
|
|
17282
17255
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
@@ -17349,18 +17322,12 @@ declare namespace Office {
|
|
|
17349
17322
|
*
|
|
17350
17323
|
* **Important**:
|
|
17351
17324
|
*
|
|
17352
|
-
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
17353
|
-
* entities in mail items to perform tasks on them.
|
|
17354
|
-
*
|
|
17355
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17356
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17357
|
-
* to activate the **Join Meeting** button.
|
|
17358
|
-
*
|
|
17325
|
+
* - Entity-based contextual Outlook add-ins, including the `getFilteredEntitiesByName` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
17326
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
17359
17327
|
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17360
17328
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17361
17329
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17362
|
-
*
|
|
17363
|
-
* For more information, see
|
|
17330
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
17364
17331
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17365
17332
|
*
|
|
17366
17333
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -17425,17 +17392,10 @@ declare namespace Office {
|
|
|
17425
17392
|
* **Important**:
|
|
17426
17393
|
*
|
|
17427
17394
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
17428
|
-
* entities in mail items to perform tasks on them.
|
|
17429
|
-
*
|
|
17430
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17431
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17432
|
-
* to activate the **Join Meeting** button.
|
|
17433
|
-
*
|
|
17434
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17435
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17395
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
17396
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17436
17397
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17437
|
-
*
|
|
17438
|
-
* For more information, see
|
|
17398
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
17439
17399
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17440
17400
|
*
|
|
17441
17401
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -17466,17 +17426,10 @@ declare namespace Office {
|
|
|
17466
17426
|
* **Important**:
|
|
17467
17427
|
*
|
|
17468
17428
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
17469
|
-
* entities in mail items to perform tasks on them.
|
|
17470
|
-
*
|
|
17471
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17472
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17473
|
-
* to activate the **Join Meeting** button.
|
|
17474
|
-
*
|
|
17475
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17476
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17429
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
17430
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17477
17431
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17478
|
-
*
|
|
17479
|
-
* For more information, see
|
|
17432
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
17480
17433
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17481
17434
|
*
|
|
17482
17435
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
@@ -17506,21 +17459,22 @@ declare namespace Office {
|
|
|
17506
17459
|
*
|
|
17507
17460
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17508
17461
|
*
|
|
17509
|
-
* **Important**:
|
|
17510
|
-
* entities in mail items to perform tasks on them. To help minimize potential disruptions, the following will still be supported after entity-based
|
|
17511
|
-
* contextual add-ins are retired.
|
|
17512
|
-
*
|
|
17513
|
-
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
17514
|
-
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
17515
|
-
* **Join Meeting** button.
|
|
17462
|
+
* **Important**:
|
|
17516
17463
|
*
|
|
17517
|
-
* -
|
|
17464
|
+
* - Entity-based contextual Outlook add-ins, including the `getSelectedEntities` method, will be retired in Q2 of 2024. The work to retire this method will
|
|
17465
|
+
* start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
17466
|
+
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17518
17467
|
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17519
17468
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17520
|
-
*
|
|
17521
|
-
* For more information, see
|
|
17469
|
+
* To learn more about the retirement of entity-based contextual Outlook add-ins, see
|
|
17522
17470
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17523
17471
|
*
|
|
17472
|
+
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
17473
|
+
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
17474
|
+
*
|
|
17475
|
+
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
17476
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17477
|
+
*
|
|
17524
17478
|
* @param name - The name of the `ItemHasRegularExpressionMatch` rule element that defines the filter to match.
|
|
17525
17479
|
*/
|
|
17526
17480
|
getSelectedEntities(): Entities;
|
|
@@ -17544,23 +17498,17 @@ declare namespace Office {
|
|
|
17544
17498
|
* **Important**:
|
|
17545
17499
|
*
|
|
17546
17500
|
* - Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. Once retired, contextual add-ins will no longer be able to detect
|
|
17547
|
-
* entities in mail items to perform tasks on them.
|
|
17548
|
-
*
|
|
17549
|
-
* An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed.
|
|
17550
|
-
* Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation
|
|
17551
|
-
* to activate the **Join Meeting** button.
|
|
17552
|
-
*
|
|
17553
|
-
* Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. We recommend updating your contextual add-in
|
|
17554
|
-
* to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17501
|
+
* entities in mail items to perform tasks on them. Regular expression rules will continue to be supported after entity-based contextual add-ins are retired.
|
|
17502
|
+
* We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see
|
|
17555
17503
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in | Use regular expression activation rules to show an Outlook add-in}.
|
|
17556
|
-
*
|
|
17557
|
-
* For more information, see
|
|
17504
|
+
* To learn more about the retirement of entity-based contextual add-ins, see
|
|
17558
17505
|
* {@link https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins | Retirement of entity-based contextual Outlook add-ins}.
|
|
17559
17506
|
*
|
|
17560
17507
|
* - This method is used with the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/activation-rules | activation rules feature for Outlook add-ins},
|
|
17561
17508
|
* which isn't supported by the {@link https://learn.microsoft.com/office/dev/add-ins/develop/json-manifest-overview | unified manifest for Microsoft 365 (preview)}.
|
|
17562
17509
|
*
|
|
17563
|
-
* - This method isn't supported in Outlook on iOS or Android.
|
|
17510
|
+
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
17511
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
17564
17512
|
*
|
|
17565
17513
|
* - If you specify an `ItemHasRegularExpressionMatch` rule on the body property of an item, the regular expression should further filter the body
|
|
17566
17514
|
* and shouldn't attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item doesn't always return the
|
|
@@ -18014,9 +17962,16 @@ declare namespace Office {
|
|
|
18014
17962
|
*
|
|
18015
17963
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Read
|
|
18016
17964
|
*
|
|
18017
|
-
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024.
|
|
18018
|
-
*
|
|
18019
|
-
*
|
|
17965
|
+
* **Important**: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue
|
|
17966
|
+
* until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them.
|
|
17967
|
+
* The following APIs will also be retired.
|
|
17968
|
+
*
|
|
17969
|
+
* - `Office.context.mailbox.item.getEntities`
|
|
17970
|
+
* - `Office.context.mailbox.item.getEntitiesByType`
|
|
17971
|
+
* - `Office.context.mailbox.item.getFilteredEntitiesByName`
|
|
17972
|
+
* - `Office.context.mailbox.item.getSelectedEntities`
|
|
17973
|
+
*
|
|
17974
|
+
* To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.
|
|
18020
17975
|
*
|
|
18021
17976
|
* - An alternative implementation of the **Join Meeting** button, which is activated by online meeting add-ins, is being developed. Once support for
|
|
18022
17977
|
* entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the
|
|
@@ -109768,234 +109723,228 @@ declare namespace OneNote {
|
|
|
109768
109723
|
|
|
109769
109724
|
declare namespace Visio {
|
|
109770
109725
|
/**
|
|
109771
|
-
*
|
|
109772
109726
|
* Provides information about the shape that raised the ShapeMouseEnter event.
|
|
109773
109727
|
*
|
|
109728
|
+
* @remarks
|
|
109774
109729
|
* [Api set: 1.1]
|
|
109775
109730
|
*/
|
|
109776
109731
|
interface ShapeMouseEnterEventArgs {
|
|
109777
109732
|
/**
|
|
109778
|
-
*
|
|
109779
109733
|
* Gets the name of the page which has the shape object that raised the ShapeMouseEnter event.
|
|
109780
109734
|
*
|
|
109735
|
+
* @remarks
|
|
109781
109736
|
* [Api set: 1.1]
|
|
109782
109737
|
*/
|
|
109783
109738
|
pageName: string;
|
|
109784
109739
|
/**
|
|
109785
|
-
*
|
|
109786
109740
|
* Gets the name of the shape object that raised the ShapeMouseEnter event.
|
|
109787
109741
|
*
|
|
109742
|
+
* @remarks
|
|
109788
109743
|
* [Api set: 1.1]
|
|
109789
109744
|
*/
|
|
109790
109745
|
shapeName: string;
|
|
109791
109746
|
}
|
|
109792
109747
|
/**
|
|
109793
|
-
*
|
|
109794
109748
|
* Provides information about the shape that raised the ShapeMouseLeave event.
|
|
109795
109749
|
*
|
|
109750
|
+
* @remarks
|
|
109796
109751
|
* [Api set: 1.1]
|
|
109797
109752
|
*/
|
|
109798
109753
|
interface ShapeMouseLeaveEventArgs {
|
|
109799
109754
|
/**
|
|
109800
|
-
*
|
|
109801
109755
|
* Gets the name of the page which has the shape object that raised the ShapeMouseLeave event.
|
|
109802
109756
|
*
|
|
109757
|
+
* @remarks
|
|
109803
109758
|
* [Api set: 1.1]
|
|
109804
109759
|
*/
|
|
109805
109760
|
pageName: string;
|
|
109806
109761
|
/**
|
|
109807
|
-
*
|
|
109808
109762
|
* Gets the name of the shape object that raised the ShapeMouseLeave event.
|
|
109809
109763
|
*
|
|
109764
|
+
* @remarks
|
|
109810
109765
|
* [Api set: 1.1]
|
|
109811
109766
|
*/
|
|
109812
109767
|
shapeName: string;
|
|
109813
109768
|
}
|
|
109814
109769
|
/**
|
|
109815
|
-
*
|
|
109816
109770
|
* Provides information about the page that raised the PageLoadComplete event.
|
|
109817
109771
|
*
|
|
109772
|
+
* @remarks
|
|
109818
109773
|
* [Api set: 1.1]
|
|
109819
109774
|
*/
|
|
109820
109775
|
interface PageLoadCompleteEventArgs {
|
|
109821
109776
|
/**
|
|
109822
|
-
*
|
|
109823
109777
|
* Gets the name of the page that raised the PageLoad event.
|
|
109824
109778
|
*
|
|
109779
|
+
* @remarks
|
|
109825
109780
|
* [Api set: 1.1]
|
|
109826
109781
|
*/
|
|
109827
109782
|
pageName: string;
|
|
109828
109783
|
/**
|
|
109829
|
-
*
|
|
109830
109784
|
* Gets the success or failure of the PageLoadComplete event.
|
|
109831
109785
|
*
|
|
109786
|
+
* @remarks
|
|
109832
109787
|
* [Api set: 1.1]
|
|
109833
109788
|
*/
|
|
109834
109789
|
success: boolean;
|
|
109835
109790
|
}
|
|
109836
109791
|
/**
|
|
109837
|
-
*
|
|
109838
109792
|
* Provides information about the document that raised the DataRefreshComplete event.
|
|
109839
109793
|
*
|
|
109794
|
+
* @remarks
|
|
109840
109795
|
* [Api set: 1.1]
|
|
109841
109796
|
*/
|
|
109842
109797
|
interface DataRefreshCompleteEventArgs {
|
|
109843
109798
|
/**
|
|
109844
|
-
*
|
|
109845
109799
|
* Gets the document object that raised the DataRefreshComplete event.
|
|
109846
109800
|
*
|
|
109801
|
+
* @remarks
|
|
109847
109802
|
* [Api set: 1.1]
|
|
109848
109803
|
*/
|
|
109849
109804
|
document: Visio.Document;
|
|
109850
109805
|
/**
|
|
109851
|
-
*
|
|
109852
109806
|
* Gets the success or failure of the DataRefreshComplete event.
|
|
109853
109807
|
*
|
|
109808
|
+
* @remarks
|
|
109854
109809
|
* [Api set: 1.1]
|
|
109855
109810
|
*/
|
|
109856
109811
|
success: boolean;
|
|
109857
109812
|
}
|
|
109858
109813
|
/**
|
|
109859
|
-
*
|
|
109860
109814
|
* Provides information about the shape collection that raised the SelectionChanged event.
|
|
109861
109815
|
*
|
|
109816
|
+
* @remarks
|
|
109862
109817
|
* [Api set: 1.1]
|
|
109863
109818
|
*/
|
|
109864
109819
|
interface SelectionChangedEventArgs {
|
|
109865
109820
|
/**
|
|
109866
|
-
*
|
|
109867
109821
|
* Gets the name of the page which has the ShapeCollection object that raised the SelectionChanged event.
|
|
109868
109822
|
*
|
|
109823
|
+
* @remarks
|
|
109869
109824
|
* [Api set: 1.1]
|
|
109870
109825
|
*/
|
|
109871
109826
|
pageName: string;
|
|
109872
109827
|
/**
|
|
109873
|
-
*
|
|
109874
109828
|
* Gets the array of shape names that raised the SelectionChanged event.
|
|
109875
109829
|
*
|
|
109830
|
+
* @remarks
|
|
109876
109831
|
* [Api set: 1.1]
|
|
109877
109832
|
*/
|
|
109878
109833
|
shapeNames: string[];
|
|
109879
109834
|
}
|
|
109880
109835
|
/**
|
|
109881
|
-
*
|
|
109882
109836
|
* Provides information about the success or failure of the DocumentLoadComplete event.
|
|
109883
109837
|
*
|
|
109838
|
+
* @remarks
|
|
109884
109839
|
* [Api set: 1.1]
|
|
109885
109840
|
*/
|
|
109886
109841
|
interface DocumentLoadCompleteEventArgs {
|
|
109887
109842
|
/**
|
|
109888
|
-
*
|
|
109889
109843
|
* Gets the success or failure of the DocumentLoadComplete event.
|
|
109890
109844
|
*
|
|
109845
|
+
* @remarks
|
|
109891
109846
|
* [Api set: 1.1]
|
|
109892
109847
|
*/
|
|
109893
109848
|
success: boolean;
|
|
109894
109849
|
}
|
|
109895
109850
|
/**
|
|
109896
|
-
*
|
|
109897
109851
|
* Provides information about the page that raised the PageRenderComplete event.
|
|
109898
109852
|
*
|
|
109853
|
+
* @remarks
|
|
109899
109854
|
* [Api set: 1.1]
|
|
109900
109855
|
*/
|
|
109901
109856
|
interface PageRenderCompleteEventArgs {
|
|
109902
109857
|
/**
|
|
109903
|
-
*
|
|
109904
109858
|
* Gets the name of the page that raised the PageLoad event.
|
|
109905
109859
|
*
|
|
109860
|
+
* @remarks
|
|
109906
109861
|
* [Api set: 1.1]
|
|
109907
109862
|
*/
|
|
109908
109863
|
pageName: string;
|
|
109909
109864
|
/**
|
|
109910
|
-
*
|
|
109911
109865
|
* Gets the success/failure of the PageRender event.
|
|
109912
109866
|
*
|
|
109867
|
+
* @remarks
|
|
109913
109868
|
* [Api set: 1.1]
|
|
109914
109869
|
*/
|
|
109915
109870
|
success: boolean;
|
|
109916
109871
|
}
|
|
109917
109872
|
/**
|
|
109873
|
+
* Provides information about DocumentError event.
|
|
109918
109874
|
*
|
|
109919
|
-
*
|
|
109920
|
-
*
|
|
109875
|
+
* @remarks
|
|
109921
109876
|
* [Api set: 1.1]
|
|
109922
109877
|
*/
|
|
109923
109878
|
interface DocumentErrorEventArgs {
|
|
109924
109879
|
/**
|
|
109880
|
+
* Visio Error code.
|
|
109925
109881
|
*
|
|
109926
|
-
*
|
|
109927
|
-
*
|
|
109882
|
+
* @remarks
|
|
109928
109883
|
* [Api set: 1.1]
|
|
109929
109884
|
*/
|
|
109930
109885
|
errorCode: number;
|
|
109931
109886
|
/**
|
|
109887
|
+
* Message about error that occurred.
|
|
109932
109888
|
*
|
|
109933
|
-
*
|
|
109934
|
-
*
|
|
109889
|
+
* @remarks
|
|
109935
109890
|
* [Api set: 1.1]
|
|
109936
109891
|
*/
|
|
109937
109892
|
errorMessage: string;
|
|
109938
109893
|
/**
|
|
109939
|
-
*
|
|
109940
109894
|
* Tells if the error is critical or not. If critical the session cannot continue.
|
|
109941
109895
|
*
|
|
109896
|
+
* @remarks
|
|
109942
109897
|
* [Api set: 1.1]
|
|
109943
109898
|
*/
|
|
109944
109899
|
isCritical: boolean;
|
|
109945
109900
|
}
|
|
109946
109901
|
/**
|
|
109947
|
-
*
|
|
109948
109902
|
* Provides information about the TaskPaneStateChanged event.
|
|
109949
109903
|
*
|
|
109904
|
+
* @remarks
|
|
109950
109905
|
* [Api set: 1.1]
|
|
109951
109906
|
*/
|
|
109952
109907
|
interface TaskPaneStateChangedEventArgs {
|
|
109953
109908
|
/**
|
|
109909
|
+
* Current state of the task pane.
|
|
109954
109910
|
*
|
|
109955
|
-
*
|
|
109956
|
-
*
|
|
109911
|
+
* @remarks
|
|
109957
109912
|
* [Api set: 1.1]
|
|
109958
109913
|
*/
|
|
109959
109914
|
isVisible: boolean;
|
|
109960
109915
|
/**
|
|
109961
|
-
*
|
|
109962
109916
|
* Type of the TaskPane.
|
|
109963
109917
|
*
|
|
109918
|
+
* @remarks
|
|
109964
109919
|
* [Api set: 1.1]
|
|
109965
109920
|
*/
|
|
109966
109921
|
paneType: Visio.TaskPaneType | "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings";
|
|
109967
109922
|
}
|
|
109968
109923
|
/**
|
|
109969
|
-
*
|
|
109970
109924
|
* Represents the Application.
|
|
109971
109925
|
*
|
|
109926
|
+
* @remarks
|
|
109972
109927
|
* [Api set: 1.1]
|
|
109973
109928
|
*/
|
|
109974
109929
|
class Application extends OfficeExtension.ClientObject {
|
|
109975
109930
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
109976
109931
|
context: RequestContext;
|
|
109977
109932
|
/**
|
|
109933
|
+
* Shows or hides the iframe application borders.
|
|
109978
109934
|
*
|
|
109979
|
-
*
|
|
109980
|
-
*
|
|
109935
|
+
* @remarks
|
|
109981
109936
|
* [Api set: 1.1]
|
|
109982
109937
|
*/
|
|
109983
109938
|
showBorders: boolean;
|
|
109984
109939
|
/**
|
|
109940
|
+
* Shows or hides the standard toolbars.
|
|
109985
109941
|
*
|
|
109986
|
-
*
|
|
109987
|
-
*
|
|
109942
|
+
* @remarks
|
|
109988
109943
|
* [Api set: 1.1]
|
|
109989
109944
|
*/
|
|
109990
109945
|
showToolbars: boolean;
|
|
109991
|
-
/**
|
|
109992
|
-
*
|
|
109993
|
-
* @remarks
|
|
109994
|
-
*
|
|
109995
|
-
* This method has the following additional signature:
|
|
109996
|
-
*
|
|
109997
|
-
* `set(properties: Visio.Application): void`
|
|
109998
|
-
*
|
|
109946
|
+
/**
|
|
109947
|
+
* 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.
|
|
109999
109948
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110000
109949
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110001
109950
|
*/
|
|
@@ -110003,23 +109952,23 @@ declare namespace Visio {
|
|
|
110003
109952
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110004
109953
|
set(properties: Visio.Application): void;
|
|
110005
109954
|
/**
|
|
110006
|
-
*
|
|
110007
109955
|
* Sets the visibility of a specific toolbar in the application.
|
|
110008
109956
|
*
|
|
109957
|
+
* @remarks
|
|
110009
109958
|
* [Api set: 1.1]
|
|
110010
109959
|
*
|
|
110011
|
-
* @param id The type of the Toolbar
|
|
110012
|
-
* @param show Whether the toolbar is
|
|
109960
|
+
* @param id The type of the Toolbar.
|
|
109961
|
+
* @param show Whether the toolbar is visible or not.
|
|
110013
109962
|
*/
|
|
110014
109963
|
showToolbar(id: Visio.ToolBarType, show: boolean): void;
|
|
110015
109964
|
/**
|
|
110016
|
-
*
|
|
110017
109965
|
* Sets the visibility of a specific toolbar in the application.
|
|
110018
109966
|
*
|
|
109967
|
+
* @remarks
|
|
110019
109968
|
* [Api set: 1.1]
|
|
110020
109969
|
*
|
|
110021
|
-
* @param id The type of the Toolbar
|
|
110022
|
-
* @param show Whether the toolbar is
|
|
109970
|
+
* @param id The type of the Toolbar.
|
|
109971
|
+
* @param show Whether the toolbar is visible or not.
|
|
110023
109972
|
*/
|
|
110024
109973
|
showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;
|
|
110025
109974
|
/**
|
|
@@ -110054,43 +110003,37 @@ declare namespace Visio {
|
|
|
110054
110003
|
setMockData(data: Visio.Interfaces.ApplicationData): void;
|
|
110055
110004
|
}
|
|
110056
110005
|
/**
|
|
110057
|
-
*
|
|
110058
110006
|
* Represents the Document class.
|
|
110059
110007
|
*
|
|
110008
|
+
* @remarks
|
|
110060
110009
|
* [Api set: 1.1]
|
|
110061
110010
|
*/
|
|
110062
110011
|
class Document extends OfficeExtension.ClientObject {
|
|
110063
110012
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110064
110013
|
context: RequestContext;
|
|
110065
110014
|
/**
|
|
110015
|
+
* Represents a Visio application instance that contains this document.
|
|
110066
110016
|
*
|
|
110067
|
-
*
|
|
110068
|
-
*
|
|
110017
|
+
* @remarks
|
|
110069
110018
|
* [Api set: 1.1]
|
|
110070
110019
|
*/
|
|
110071
110020
|
readonly application: Visio.Application;
|
|
110072
110021
|
/**
|
|
110022
|
+
* Represents a collection of pages associated with the document.
|
|
110073
110023
|
*
|
|
110074
|
-
*
|
|
110075
|
-
*
|
|
110024
|
+
* @remarks
|
|
110076
110025
|
* [Api set: 1.1]
|
|
110077
110026
|
*/
|
|
110078
110027
|
readonly pages: Visio.PageCollection;
|
|
110079
110028
|
/**
|
|
110029
|
+
* Returns the DocumentView object.
|
|
110080
110030
|
*
|
|
110081
|
-
*
|
|
110082
|
-
*
|
|
110031
|
+
* @remarks
|
|
110083
110032
|
* [Api set: 1.1]
|
|
110084
110033
|
*/
|
|
110085
110034
|
readonly view: Visio.DocumentView;
|
|
110086
|
-
/**
|
|
110087
|
-
*
|
|
110088
|
-
* @remarks
|
|
110089
|
-
*
|
|
110090
|
-
* This method has the following additional signature:
|
|
110091
|
-
*
|
|
110092
|
-
* `set(properties: Visio.Document): void`
|
|
110093
|
-
*
|
|
110035
|
+
/**
|
|
110036
|
+
* 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.
|
|
110094
110037
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110095
110038
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110096
110039
|
*/
|
|
@@ -110098,49 +110041,49 @@ declare namespace Visio {
|
|
|
110098
110041
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110099
110042
|
set(properties: Visio.Document): void;
|
|
110100
110043
|
/**
|
|
110101
|
-
*
|
|
110102
110044
|
* Returns the Active Page of the document.
|
|
110103
110045
|
*
|
|
110046
|
+
* @remarks
|
|
110104
110047
|
* [Api set: 1.1]
|
|
110105
110048
|
*/
|
|
110106
110049
|
getActivePage(): Visio.Page;
|
|
110107
110050
|
/**
|
|
110108
|
-
*
|
|
110109
110051
|
* Set the Active Page of the document.
|
|
110110
110052
|
*
|
|
110053
|
+
* @remarks
|
|
110111
110054
|
* [Api set: 1.1]
|
|
110112
110055
|
*
|
|
110113
110056
|
* @param PageName Name of the page
|
|
110114
110057
|
*/
|
|
110115
110058
|
setActivePage(PageName: string): void;
|
|
110116
110059
|
/**
|
|
110060
|
+
* Shows or hides a TaskPane.
|
|
110061
|
+
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the Visio drawing to show/hide the task pane.
|
|
110117
110062
|
*
|
|
110118
|
-
*
|
|
110119
|
-
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
|
|
110120
|
-
*
|
|
110063
|
+
* @remarks
|
|
110121
110064
|
* [Api set: 1.1]
|
|
110122
110065
|
*
|
|
110123
110066
|
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
110124
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the
|
|
110125
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified
|
|
110067
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
|
|
110068
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
|
|
110126
110069
|
*/
|
|
110127
110070
|
showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;
|
|
110128
110071
|
/**
|
|
110072
|
+
* Shows or hides a TaskPane.
|
|
110073
|
+
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the Visio drawing to show/hide the task pane.
|
|
110129
110074
|
*
|
|
110130
|
-
*
|
|
110131
|
-
This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
|
|
110132
|
-
*
|
|
110075
|
+
* @remarks
|
|
110133
110076
|
* [Api set: 1.1]
|
|
110134
110077
|
*
|
|
110135
110078
|
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
110136
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the
|
|
110137
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified
|
|
110079
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
|
|
110080
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
|
|
110138
110081
|
*/
|
|
110139
110082
|
showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
|
|
110140
110083
|
/**
|
|
110141
|
-
*
|
|
110142
110084
|
* Triggers the refresh of the data in the Diagram, for all pages.
|
|
110143
110085
|
*
|
|
110086
|
+
* @remarks
|
|
110144
110087
|
* [Api set: 1.1]
|
|
110145
110088
|
*/
|
|
110146
110089
|
startDataRefresh(): void;
|
|
@@ -110166,72 +110109,72 @@ declare namespace Visio {
|
|
|
110166
110109
|
expand?: string;
|
|
110167
110110
|
}): Visio.Document;
|
|
110168
110111
|
/**
|
|
110169
|
-
*
|
|
110170
110112
|
* Occurs when the data is refreshed in the diagram.
|
|
110171
110113
|
*
|
|
110114
|
+
* @remarks
|
|
110172
110115
|
* [Api set: 1.1]
|
|
110173
110116
|
*
|
|
110174
110117
|
* @eventproperty
|
|
110175
110118
|
*/
|
|
110176
110119
|
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
|
|
110177
110120
|
/**
|
|
110121
|
+
* Occurs when there is an expected or unexpected error occurred in the session.
|
|
110178
110122
|
*
|
|
110179
|
-
*
|
|
110180
|
-
*
|
|
110123
|
+
* @remarks
|
|
110181
110124
|
* [Api set: 1.1]
|
|
110182
110125
|
*
|
|
110183
110126
|
* @eventproperty
|
|
110184
110127
|
*/
|
|
110185
110128
|
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;
|
|
110186
110129
|
/**
|
|
110187
|
-
*
|
|
110188
110130
|
* Occurs when the Document is loaded, refreshed, or changed.
|
|
110189
110131
|
*
|
|
110132
|
+
* @remarks
|
|
110190
110133
|
* [Api set: 1.1]
|
|
110191
110134
|
*
|
|
110192
110135
|
* @eventproperty
|
|
110193
110136
|
*/
|
|
110194
110137
|
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;
|
|
110195
110138
|
/**
|
|
110196
|
-
*
|
|
110197
110139
|
* Occurs when the page is finished loading.
|
|
110198
110140
|
*
|
|
110141
|
+
* @remarks
|
|
110199
110142
|
* [Api set: 1.1]
|
|
110200
110143
|
*
|
|
110201
110144
|
* @eventproperty
|
|
110202
110145
|
*/
|
|
110203
110146
|
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;
|
|
110204
110147
|
/**
|
|
110205
|
-
*
|
|
110206
110148
|
* Occurs when the current selection of shapes changes.
|
|
110207
110149
|
*
|
|
110150
|
+
* @remarks
|
|
110208
110151
|
* [Api set: 1.1]
|
|
110209
110152
|
*
|
|
110210
110153
|
* @eventproperty
|
|
110211
110154
|
*/
|
|
110212
110155
|
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;
|
|
110213
110156
|
/**
|
|
110214
|
-
*
|
|
110215
110157
|
* Occurs when the user moves the mouse pointer into the bounding box of a shape.
|
|
110216
110158
|
*
|
|
110159
|
+
* @remarks
|
|
110217
110160
|
* [Api set: 1.1]
|
|
110218
110161
|
*
|
|
110219
110162
|
* @eventproperty
|
|
110220
110163
|
*/
|
|
110221
110164
|
readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;
|
|
110222
110165
|
/**
|
|
110223
|
-
*
|
|
110224
110166
|
* Occurs when the user moves the mouse out of the bounding box of a shape.
|
|
110225
110167
|
*
|
|
110168
|
+
* @remarks
|
|
110226
110169
|
* [Api set: 1.1]
|
|
110227
110170
|
*
|
|
110228
110171
|
* @eventproperty
|
|
110229
110172
|
*/
|
|
110230
110173
|
readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;
|
|
110231
110174
|
/**
|
|
110175
|
+
* Occurs whenever a task pane state is changed.
|
|
110232
110176
|
*
|
|
110233
|
-
*
|
|
110234
|
-
*
|
|
110177
|
+
* @remarks
|
|
110235
110178
|
* [Api set: 1.1]
|
|
110236
110179
|
*
|
|
110237
110180
|
* @eventproperty
|
|
@@ -110248,57 +110191,51 @@ declare namespace Visio {
|
|
|
110248
110191
|
setMockData(data: Visio.Interfaces.DocumentData): void;
|
|
110249
110192
|
}
|
|
110250
110193
|
/**
|
|
110251
|
-
*
|
|
110252
110194
|
* Represents the DocumentView class.
|
|
110253
110195
|
*
|
|
110196
|
+
* @remarks
|
|
110254
110197
|
* [Api set: 1.1]
|
|
110255
110198
|
*/
|
|
110256
110199
|
class DocumentView extends OfficeExtension.ClientObject {
|
|
110257
110200
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110258
110201
|
context: RequestContext;
|
|
110259
110202
|
/**
|
|
110260
|
-
*
|
|
110261
110203
|
* Disable Hyperlinks.
|
|
110262
110204
|
*
|
|
110205
|
+
* @remarks
|
|
110263
110206
|
* [Api set: 1.1]
|
|
110264
110207
|
*/
|
|
110265
110208
|
disableHyperlinks: boolean;
|
|
110266
110209
|
/**
|
|
110267
|
-
*
|
|
110268
110210
|
* Disable Pan.
|
|
110269
110211
|
*
|
|
110212
|
+
* @remarks
|
|
110270
110213
|
* [Api set: 1.1]
|
|
110271
110214
|
*/
|
|
110272
110215
|
disablePan: boolean;
|
|
110273
110216
|
/**
|
|
110274
|
-
*
|
|
110275
110217
|
* Disable PanZoomWindow.
|
|
110276
110218
|
*
|
|
110219
|
+
* @remarks
|
|
110277
110220
|
* [Api set: 1.1]
|
|
110278
110221
|
*/
|
|
110279
110222
|
disablePanZoomWindow: boolean;
|
|
110280
110223
|
/**
|
|
110281
|
-
*
|
|
110282
110224
|
* Disable Zoom.
|
|
110283
110225
|
*
|
|
110226
|
+
* @remarks
|
|
110284
110227
|
* [Api set: 1.1]
|
|
110285
110228
|
*/
|
|
110286
110229
|
disableZoom: boolean;
|
|
110287
110230
|
/**
|
|
110288
|
-
*
|
|
110289
110231
|
* Hide Diagram Boundary.
|
|
110290
110232
|
*
|
|
110233
|
+
* @remarks
|
|
110291
110234
|
* [Api set: 1.1]
|
|
110292
110235
|
*/
|
|
110293
110236
|
hideDiagramBoundary: boolean;
|
|
110294
|
-
/**
|
|
110295
|
-
*
|
|
110296
|
-
* @remarks
|
|
110297
|
-
*
|
|
110298
|
-
* This method has the following additional signature:
|
|
110299
|
-
*
|
|
110300
|
-
* `set(properties: Visio.DocumentView): void`
|
|
110301
|
-
*
|
|
110237
|
+
/**
|
|
110238
|
+
* 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.
|
|
110302
110239
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110303
110240
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110304
110241
|
*/
|
|
@@ -110337,85 +110274,79 @@ declare namespace Visio {
|
|
|
110337
110274
|
setMockData(data: Visio.Interfaces.DocumentViewData): void;
|
|
110338
110275
|
}
|
|
110339
110276
|
/**
|
|
110340
|
-
*
|
|
110341
110277
|
* Represents the Page class.
|
|
110342
110278
|
*
|
|
110279
|
+
* @remarks
|
|
110343
110280
|
* [Api set: 1.1]
|
|
110344
110281
|
*/
|
|
110345
110282
|
class Page extends OfficeExtension.ClientObject {
|
|
110346
110283
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110347
110284
|
context: RequestContext;
|
|
110348
110285
|
/**
|
|
110286
|
+
* All shapes in the Page, including subshapes.
|
|
110349
110287
|
*
|
|
110350
|
-
*
|
|
110351
|
-
*
|
|
110288
|
+
* @remarks
|
|
110352
110289
|
* [Api set: 1.1]
|
|
110353
110290
|
*/
|
|
110354
110291
|
readonly allShapes: Visio.ShapeCollection;
|
|
110355
110292
|
/**
|
|
110293
|
+
* Returns the Comments Collection.
|
|
110356
110294
|
*
|
|
110357
|
-
*
|
|
110358
|
-
*
|
|
110295
|
+
* @remarks
|
|
110359
110296
|
* [Api set: 1.1]
|
|
110360
110297
|
*/
|
|
110361
110298
|
readonly comments: Visio.CommentCollection;
|
|
110362
110299
|
/**
|
|
110300
|
+
* All top-level shapes in the Page.
|
|
110363
110301
|
*
|
|
110364
|
-
*
|
|
110365
|
-
*
|
|
110302
|
+
* @remarks
|
|
110366
110303
|
* [Api set: 1.1]
|
|
110367
110304
|
*/
|
|
110368
110305
|
readonly shapes: Visio.ShapeCollection;
|
|
110369
110306
|
/**
|
|
110307
|
+
* Returns the view of the page.
|
|
110370
110308
|
*
|
|
110371
|
-
*
|
|
110372
|
-
*
|
|
110309
|
+
* @remarks
|
|
110373
110310
|
* [Api set: 1.1]
|
|
110374
110311
|
*/
|
|
110375
110312
|
readonly view: Visio.PageView;
|
|
110376
110313
|
/**
|
|
110314
|
+
* Returns the height of the page.
|
|
110377
110315
|
*
|
|
110378
|
-
*
|
|
110379
|
-
*
|
|
110316
|
+
* @remarks
|
|
110380
110317
|
* [Api set: 1.1]
|
|
110381
110318
|
*/
|
|
110382
110319
|
readonly height: number;
|
|
110383
110320
|
/**
|
|
110321
|
+
* Index of the Page.
|
|
110384
110322
|
*
|
|
110385
|
-
*
|
|
110386
|
-
*
|
|
110323
|
+
* @remarks
|
|
110387
110324
|
* [Api set: 1.1]
|
|
110388
110325
|
*/
|
|
110389
110326
|
readonly index: number;
|
|
110390
110327
|
/**
|
|
110328
|
+
* Whether the page is a background page or not.
|
|
110391
110329
|
*
|
|
110392
|
-
*
|
|
110393
|
-
*
|
|
110330
|
+
* @remarks
|
|
110394
110331
|
* [Api set: 1.1]
|
|
110395
110332
|
*/
|
|
110396
110333
|
readonly isBackground: boolean;
|
|
110397
110334
|
/**
|
|
110335
|
+
* Page name.
|
|
110398
110336
|
*
|
|
110399
|
-
*
|
|
110400
|
-
*
|
|
110337
|
+
* @remarks
|
|
110401
110338
|
* [Api set: 1.1]
|
|
110402
110339
|
*/
|
|
110403
110340
|
readonly name: string;
|
|
110404
110341
|
/**
|
|
110342
|
+
* Returns the width of the page.
|
|
110405
110343
|
*
|
|
110406
|
-
*
|
|
110407
|
-
*
|
|
110344
|
+
* @remarks
|
|
110408
110345
|
* [Api set: 1.1]
|
|
110409
110346
|
*/
|
|
110410
110347
|
readonly width: number;
|
|
110411
|
-
/**
|
|
110412
|
-
*
|
|
110413
|
-
* @remarks
|
|
110414
|
-
*
|
|
110415
|
-
* This method has the following additional signature:
|
|
110416
|
-
*
|
|
110417
|
-
* `set(properties: Visio.Page): void`
|
|
110418
|
-
*
|
|
110348
|
+
/**
|
|
110349
|
+
* 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.
|
|
110419
110350
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110420
110351
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110421
110352
|
*/
|
|
@@ -110423,9 +110354,9 @@ declare namespace Visio {
|
|
|
110423
110354
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110424
110355
|
set(properties: Visio.Page): void;
|
|
110425
110356
|
/**
|
|
110357
|
+
* Sets the page as Active Page of the document.
|
|
110426
110358
|
*
|
|
110427
|
-
*
|
|
110428
|
-
*
|
|
110359
|
+
* @remarks
|
|
110429
110360
|
* [Api set: 1.1]
|
|
110430
110361
|
*/
|
|
110431
110362
|
activate(): void;
|
|
@@ -110461,29 +110392,23 @@ declare namespace Visio {
|
|
|
110461
110392
|
setMockData(data: Visio.Interfaces.PageData): void;
|
|
110462
110393
|
}
|
|
110463
110394
|
/**
|
|
110464
|
-
*
|
|
110465
110395
|
* Represents the PageView class.
|
|
110466
110396
|
*
|
|
110397
|
+
* @remarks
|
|
110467
110398
|
* [Api set: 1.1]
|
|
110468
110399
|
*/
|
|
110469
110400
|
class PageView extends OfficeExtension.ClientObject {
|
|
110470
110401
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110471
110402
|
context: RequestContext;
|
|
110472
110403
|
/**
|
|
110473
|
-
*
|
|
110474
110404
|
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
110475
110405
|
*
|
|
110406
|
+
* @remarks
|
|
110476
110407
|
* [Api set: 1.1]
|
|
110477
110408
|
*/
|
|
110478
110409
|
zoom: number;
|
|
110479
|
-
/**
|
|
110480
|
-
*
|
|
110481
|
-
* @remarks
|
|
110482
|
-
*
|
|
110483
|
-
* This method has the following additional signature:
|
|
110484
|
-
*
|
|
110485
|
-
* `set(properties: Visio.PageView): void`
|
|
110486
|
-
*
|
|
110410
|
+
/**
|
|
110411
|
+
* 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.
|
|
110487
110412
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110488
110413
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110489
110414
|
*/
|
|
@@ -110491,48 +110416,48 @@ declare namespace Visio {
|
|
|
110491
110416
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110492
110417
|
set(properties: Visio.PageView): void;
|
|
110493
110418
|
/**
|
|
110494
|
-
*
|
|
110495
110419
|
* Pans the Visio drawing to place the specified shape in the center of the view.
|
|
110496
110420
|
*
|
|
110421
|
+
* @remarks
|
|
110497
110422
|
* [Api set: 1.1]
|
|
110498
110423
|
*
|
|
110499
110424
|
* @param ShapeId ShapeId to be seen in the center.
|
|
110500
110425
|
*/
|
|
110501
110426
|
centerViewportOnShape(ShapeId: number): void;
|
|
110502
110427
|
/**
|
|
110503
|
-
*
|
|
110504
110428
|
* Fit Page to current window.
|
|
110505
110429
|
*
|
|
110430
|
+
* @remarks
|
|
110506
110431
|
* [Api set: 1.1]
|
|
110507
110432
|
*/
|
|
110508
110433
|
fitToWindow(): void;
|
|
110509
110434
|
/**
|
|
110510
|
-
*
|
|
110511
110435
|
* Returns the position object that specifies the position of the page in the view.
|
|
110512
110436
|
*
|
|
110437
|
+
* @remarks
|
|
110513
110438
|
* [Api set: 1.1]
|
|
110514
110439
|
*/
|
|
110515
110440
|
getPosition(): OfficeExtension.ClientResult<Visio.Position>;
|
|
110516
110441
|
/**
|
|
110517
|
-
*
|
|
110518
110442
|
* Represents the Selection in the page.
|
|
110519
110443
|
*
|
|
110444
|
+
* @remarks
|
|
110520
110445
|
* [Api set: 1.1]
|
|
110521
110446
|
*/
|
|
110522
110447
|
getSelection(): Visio.Selection;
|
|
110523
110448
|
/**
|
|
110524
|
-
*
|
|
110525
110449
|
* To check if the shape is in view of the page or not.
|
|
110526
110450
|
*
|
|
110451
|
+
* @remarks
|
|
110527
110452
|
* [Api set: 1.1]
|
|
110528
110453
|
*
|
|
110529
110454
|
* @param Shape Shape to be checked.
|
|
110530
110455
|
*/
|
|
110531
110456
|
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;
|
|
110532
110457
|
/**
|
|
110533
|
-
*
|
|
110534
110458
|
* Sets the position of the page in the view.
|
|
110535
110459
|
*
|
|
110460
|
+
* @remarks
|
|
110536
110461
|
* [Api set: 1.1]
|
|
110537
110462
|
*
|
|
110538
110463
|
* @param Position Position object that specifies the new position of the page in the view.
|
|
@@ -110570,9 +110495,9 @@ declare namespace Visio {
|
|
|
110570
110495
|
setMockData(data: Visio.Interfaces.PageViewData): void;
|
|
110571
110496
|
}
|
|
110572
110497
|
/**
|
|
110573
|
-
*
|
|
110574
110498
|
* Represents a collection of Page objects that are part of the document.
|
|
110575
110499
|
*
|
|
110500
|
+
* @remarks
|
|
110576
110501
|
* [Api set: 1.1]
|
|
110577
110502
|
*/
|
|
110578
110503
|
class PageCollection extends OfficeExtension.ClientObject {
|
|
@@ -110581,16 +110506,16 @@ declare namespace Visio {
|
|
|
110581
110506
|
/** Gets the loaded child items in this collection. */
|
|
110582
110507
|
readonly items: Visio.Page[];
|
|
110583
110508
|
/**
|
|
110584
|
-
*
|
|
110585
110509
|
* Gets the number of pages in the collection.
|
|
110586
110510
|
*
|
|
110511
|
+
* @remarks
|
|
110587
110512
|
* [Api set: 1.1]
|
|
110588
110513
|
*/
|
|
110589
110514
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
110590
110515
|
/**
|
|
110591
|
-
*
|
|
110592
110516
|
* Gets a page using its key (name or Id).
|
|
110593
110517
|
*
|
|
110518
|
+
* @remarks
|
|
110594
110519
|
* [Api set: 1.1]
|
|
110595
110520
|
*
|
|
110596
110521
|
* @param key Key is the name or Id of the page to be retrieved.
|
|
@@ -110625,9 +110550,9 @@ declare namespace Visio {
|
|
|
110625
110550
|
setMockData(data: Visio.Interfaces.PageCollectionData): void;
|
|
110626
110551
|
}
|
|
110627
110552
|
/**
|
|
110628
|
-
*
|
|
110629
110553
|
* Represents the Shape Collection.
|
|
110630
110554
|
*
|
|
110555
|
+
* @remarks
|
|
110631
110556
|
* [Api set: 1.1]
|
|
110632
110557
|
*/
|
|
110633
110558
|
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
@@ -110636,16 +110561,16 @@ declare namespace Visio {
|
|
|
110636
110561
|
/** Gets the loaded child items in this collection. */
|
|
110637
110562
|
readonly items: Visio.Shape[];
|
|
110638
110563
|
/**
|
|
110639
|
-
*
|
|
110640
110564
|
* Gets the number of Shapes in the collection.
|
|
110641
110565
|
*
|
|
110566
|
+
* @remarks
|
|
110642
110567
|
* [Api set: 1.1]
|
|
110643
110568
|
*/
|
|
110644
110569
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
110645
110570
|
/**
|
|
110646
|
-
*
|
|
110647
110571
|
* Gets a Shape using its key (name or Index).
|
|
110648
110572
|
*
|
|
110573
|
+
* @remarks
|
|
110649
110574
|
* [Api set: 1.1]
|
|
110650
110575
|
*
|
|
110651
110576
|
* @param key Key is the Name or Index of the shape to be retrieved.
|
|
@@ -110680,85 +110605,79 @@ declare namespace Visio {
|
|
|
110680
110605
|
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
|
|
110681
110606
|
}
|
|
110682
110607
|
/**
|
|
110683
|
-
*
|
|
110684
110608
|
* Represents the Shape class.
|
|
110685
110609
|
*
|
|
110610
|
+
* @remarks
|
|
110686
110611
|
* [Api set: 1.1]
|
|
110687
110612
|
*/
|
|
110688
110613
|
class Shape extends OfficeExtension.ClientObject {
|
|
110689
110614
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110690
110615
|
context: RequestContext;
|
|
110691
110616
|
/**
|
|
110617
|
+
* Returns the Comments Collection.
|
|
110692
110618
|
*
|
|
110693
|
-
*
|
|
110694
|
-
*
|
|
110619
|
+
* @remarks
|
|
110695
110620
|
* [Api set: 1.1]
|
|
110696
110621
|
*/
|
|
110697
110622
|
readonly comments: Visio.CommentCollection;
|
|
110698
110623
|
/**
|
|
110624
|
+
* Returns the Hyperlinks collection for a Shape object.
|
|
110699
110625
|
*
|
|
110700
|
-
*
|
|
110701
|
-
*
|
|
110626
|
+
* @remarks
|
|
110702
110627
|
* [Api set: 1.1]
|
|
110703
110628
|
*/
|
|
110704
110629
|
readonly hyperlinks: Visio.HyperlinkCollection;
|
|
110705
110630
|
/**
|
|
110631
|
+
* Returns the Shape's Data Section.
|
|
110706
110632
|
*
|
|
110707
|
-
*
|
|
110708
|
-
*
|
|
110633
|
+
* @remarks
|
|
110709
110634
|
* [Api set: 1.1]
|
|
110710
110635
|
*/
|
|
110711
110636
|
readonly shapeDataItems: Visio.ShapeDataItemCollection;
|
|
110712
110637
|
/**
|
|
110638
|
+
* Gets SubShape Collection.
|
|
110713
110639
|
*
|
|
110714
|
-
*
|
|
110715
|
-
*
|
|
110640
|
+
* @remarks
|
|
110716
110641
|
* [Api set: 1.1]
|
|
110717
110642
|
*/
|
|
110718
110643
|
readonly subShapes: Visio.ShapeCollection;
|
|
110719
110644
|
/**
|
|
110645
|
+
* Returns the view of the shape.
|
|
110720
110646
|
*
|
|
110721
|
-
*
|
|
110722
|
-
*
|
|
110647
|
+
* @remarks
|
|
110723
110648
|
* [Api set: 1.1]
|
|
110724
110649
|
*/
|
|
110725
110650
|
readonly view: Visio.ShapeView;
|
|
110726
110651
|
/**
|
|
110652
|
+
* Shape's identifier.
|
|
110727
110653
|
*
|
|
110728
|
-
*
|
|
110729
|
-
*
|
|
110654
|
+
* @remarks
|
|
110730
110655
|
* [Api set: 1.1]
|
|
110731
110656
|
*/
|
|
110732
110657
|
readonly id: number;
|
|
110733
110658
|
/**
|
|
110659
|
+
* Shape's name.
|
|
110734
110660
|
*
|
|
110735
|
-
*
|
|
110736
|
-
*
|
|
110661
|
+
* @remarks
|
|
110737
110662
|
* [Api set: 1.1]
|
|
110738
110663
|
*/
|
|
110739
110664
|
readonly name: string;
|
|
110740
110665
|
/**
|
|
110741
|
-
*
|
|
110742
110666
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
110743
110667
|
*
|
|
110668
|
+
* @remarks
|
|
110744
110669
|
* [Api set: 1.1]
|
|
110745
110670
|
*/
|
|
110746
110671
|
select: boolean;
|
|
110747
110672
|
/**
|
|
110673
|
+
* Shape's text.
|
|
110748
110674
|
*
|
|
110749
|
-
*
|
|
110750
|
-
*
|
|
110675
|
+
* @remarks
|
|
110751
110676
|
* [Api set: 1.1]
|
|
110752
110677
|
*/
|
|
110753
110678
|
readonly text: string;
|
|
110754
|
-
/**
|
|
110755
|
-
*
|
|
110756
|
-
* @remarks
|
|
110757
|
-
*
|
|
110758
|
-
* This method has the following additional signature:
|
|
110759
|
-
*
|
|
110760
|
-
* `set(properties: Visio.Shape): void`
|
|
110761
|
-
*
|
|
110679
|
+
/**
|
|
110680
|
+
* 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.
|
|
110762
110681
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110763
110682
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110764
110683
|
*/
|
|
@@ -110766,12 +110685,19 @@ declare namespace Visio {
|
|
|
110766
110685
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110767
110686
|
set(properties: Visio.Shape): void;
|
|
110768
110687
|
/**
|
|
110769
|
-
*
|
|
110770
110688
|
* Returns the BoundingBox object that specifies bounding box of the shape.
|
|
110771
110689
|
*
|
|
110690
|
+
* @remarks
|
|
110772
110691
|
* [Api set: 1.1]
|
|
110773
110692
|
*/
|
|
110774
110693
|
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
|
|
110694
|
+
/**
|
|
110695
|
+
* Returns the AbsoluteBoundingBox object that specifies absolute bounding box of the shape.
|
|
110696
|
+
*
|
|
110697
|
+
* @remarks
|
|
110698
|
+
* [Api set: 1.1]
|
|
110699
|
+
*/
|
|
110700
|
+
getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
|
|
110775
110701
|
/**
|
|
110776
110702
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110777
110703
|
*
|
|
@@ -110804,29 +110730,23 @@ declare namespace Visio {
|
|
|
110804
110730
|
setMockData(data: Visio.Interfaces.ShapeData): void;
|
|
110805
110731
|
}
|
|
110806
110732
|
/**
|
|
110807
|
-
*
|
|
110808
110733
|
* Represents the ShapeView class.
|
|
110809
110734
|
*
|
|
110735
|
+
* @remarks
|
|
110810
110736
|
* [Api set: 1.1]
|
|
110811
110737
|
*/
|
|
110812
110738
|
class ShapeView extends OfficeExtension.ClientObject {
|
|
110813
110739
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110814
110740
|
context: RequestContext;
|
|
110815
110741
|
/**
|
|
110816
|
-
*
|
|
110817
110742
|
* Represents the highlight around the shape.
|
|
110818
110743
|
*
|
|
110744
|
+
* @remarks
|
|
110819
110745
|
* [Api set: 1.1]
|
|
110820
110746
|
*/
|
|
110821
110747
|
highlight: Visio.Highlight;
|
|
110822
|
-
/**
|
|
110823
|
-
*
|
|
110824
|
-
* @remarks
|
|
110825
|
-
*
|
|
110826
|
-
* This method has the following additional signature:
|
|
110827
|
-
*
|
|
110828
|
-
* `set(properties: Visio.ShapeView): void`
|
|
110829
|
-
*
|
|
110748
|
+
/**
|
|
110749
|
+
* 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.
|
|
110830
110750
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110831
110751
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110832
110752
|
*/
|
|
@@ -110834,9 +110754,9 @@ declare namespace Visio {
|
|
|
110834
110754
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110835
110755
|
set(properties: Visio.ShapeView): void;
|
|
110836
110756
|
/**
|
|
110837
|
-
*
|
|
110838
110757
|
* Adds an overlay on top of the shape.
|
|
110839
110758
|
*
|
|
110759
|
+
* @remarks
|
|
110840
110760
|
* [Api set: 1.1]
|
|
110841
110761
|
*
|
|
110842
110762
|
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
@@ -110848,9 +110768,9 @@ declare namespace Visio {
|
|
|
110848
110768
|
*/
|
|
110849
110769
|
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
110850
110770
|
/**
|
|
110851
|
-
*
|
|
110852
110771
|
* Adds an overlay on top of the shape.
|
|
110853
110772
|
*
|
|
110773
|
+
* @remarks
|
|
110854
110774
|
* [Api set: 1.1]
|
|
110855
110775
|
*
|
|
110856
110776
|
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
@@ -110862,22 +110782,31 @@ declare namespace Visio {
|
|
|
110862
110782
|
*/
|
|
110863
110783
|
addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
110864
110784
|
/**
|
|
110865
|
-
*
|
|
110866
110785
|
* Removes particular overlay or all overlays on the Shape.
|
|
110867
110786
|
*
|
|
110787
|
+
* @remarks
|
|
110868
110788
|
* [Api set: 1.1]
|
|
110869
110789
|
*
|
|
110870
110790
|
* @param OverlayId An Overlay Id. Removes the specific overlay id from the shape.
|
|
110871
110791
|
*/
|
|
110872
110792
|
removeOverlay(OverlayId: number): void;
|
|
110873
110793
|
/**
|
|
110794
|
+
* The purpose of SetText API is to update the text inside a Visio Shape in run time. The updated text retains the existing formatting properties of the shape's text.
|
|
110874
110795
|
*
|
|
110796
|
+
* @remarks
|
|
110797
|
+
* [Api set: 1.1]
|
|
110798
|
+
*
|
|
110799
|
+
* @param Text Text parameter is the updated text to display on the shape.
|
|
110800
|
+
*/
|
|
110801
|
+
setText(Text: string): void;
|
|
110802
|
+
/**
|
|
110875
110803
|
* Shows particular overlay on the Shape.
|
|
110876
110804
|
*
|
|
110805
|
+
* @remarks
|
|
110877
110806
|
* [Api set: 1.1]
|
|
110878
110807
|
*
|
|
110879
|
-
* @param overlayId overlay
|
|
110880
|
-
* @param show to show
|
|
110808
|
+
* @param overlayId The overlay ID in context.
|
|
110809
|
+
* @param show Whether to show the overlay.
|
|
110881
110810
|
*/
|
|
110882
110811
|
showOverlay(overlayId: number, show: boolean): void;
|
|
110883
110812
|
/**
|
|
@@ -110912,89 +110841,89 @@ declare namespace Visio {
|
|
|
110912
110841
|
setMockData(data: Visio.Interfaces.ShapeViewData): void;
|
|
110913
110842
|
}
|
|
110914
110843
|
/**
|
|
110915
|
-
*
|
|
110916
110844
|
* Represents the Position of the object in the view.
|
|
110917
110845
|
*
|
|
110846
|
+
* @remarks
|
|
110918
110847
|
* [Api set: 1.1]
|
|
110919
110848
|
*/
|
|
110920
110849
|
interface Position {
|
|
110921
110850
|
/**
|
|
110922
|
-
*
|
|
110923
110851
|
* An integer that specifies the x-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the left boundary of the page.
|
|
110924
110852
|
*
|
|
110853
|
+
* @remarks
|
|
110925
110854
|
* [Api set: 1.1]
|
|
110926
110855
|
*/
|
|
110927
110856
|
x: number;
|
|
110928
110857
|
/**
|
|
110929
|
-
*
|
|
110930
110858
|
* An integer that specifies the y-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the top boundary of the page.
|
|
110931
110859
|
*
|
|
110860
|
+
* @remarks
|
|
110932
110861
|
* [Api set: 1.1]
|
|
110933
110862
|
*/
|
|
110934
110863
|
y: number;
|
|
110935
110864
|
}
|
|
110936
110865
|
/**
|
|
110937
|
-
*
|
|
110938
110866
|
* Represents the BoundingBox of the shape.
|
|
110939
110867
|
*
|
|
110868
|
+
* @remarks
|
|
110940
110869
|
* [Api set: 1.1]
|
|
110941
110870
|
*/
|
|
110942
110871
|
interface BoundingBox {
|
|
110943
110872
|
/**
|
|
110944
|
-
*
|
|
110945
110873
|
* The distance between the top and bottom edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
110946
110874
|
*
|
|
110875
|
+
* @remarks
|
|
110947
110876
|
* [Api set: 1.1]
|
|
110948
110877
|
*/
|
|
110949
110878
|
height: number;
|
|
110950
110879
|
/**
|
|
110951
|
-
*
|
|
110952
110880
|
* The distance between the left and right edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
110953
110881
|
*
|
|
110882
|
+
* @remarks
|
|
110954
110883
|
* [Api set: 1.1]
|
|
110955
110884
|
*/
|
|
110956
110885
|
width: number;
|
|
110957
110886
|
/**
|
|
110958
|
-
*
|
|
110959
110887
|
* An integer that specifies the x-coordinate of the bounding box.
|
|
110960
110888
|
*
|
|
110889
|
+
* @remarks
|
|
110961
110890
|
* [Api set: 1.1]
|
|
110962
110891
|
*/
|
|
110963
110892
|
x: number;
|
|
110964
110893
|
/**
|
|
110965
|
-
*
|
|
110966
110894
|
* An integer that specifies the y-coordinate of the bounding box.
|
|
110967
110895
|
*
|
|
110896
|
+
* @remarks
|
|
110968
110897
|
* [Api set: 1.1]
|
|
110969
110898
|
*/
|
|
110970
110899
|
y: number;
|
|
110971
110900
|
}
|
|
110972
110901
|
/**
|
|
110973
|
-
*
|
|
110974
110902
|
* Represents the highlight data added to the shape.
|
|
110975
110903
|
*
|
|
110904
|
+
* @remarks
|
|
110976
110905
|
* [Api set: 1.1]
|
|
110977
110906
|
*/
|
|
110978
110907
|
interface Highlight {
|
|
110979
110908
|
/**
|
|
110980
|
-
*
|
|
110981
110909
|
* A string that specifies the color of the highlight. It must have the form "#RRGGBB", where each letter represents a hexadecimal digit between 0 and F, and where RR is the red value between 0 and 0xFF (255), GG the green value between 0 and 0xFF (255), and BB is the blue value between 0 and 0xFF (255).
|
|
110982
110910
|
*
|
|
110911
|
+
* @remarks
|
|
110983
110912
|
* [Api set: 1.1]
|
|
110984
110913
|
*/
|
|
110985
110914
|
color: string;
|
|
110986
110915
|
/**
|
|
110987
|
-
*
|
|
110988
110916
|
* A positive integer that specifies the width of the highlight's stroke in pixels.
|
|
110989
110917
|
*
|
|
110918
|
+
* @remarks
|
|
110990
110919
|
* [Api set: 1.1]
|
|
110991
110920
|
*/
|
|
110992
110921
|
width: number;
|
|
110993
110922
|
}
|
|
110994
110923
|
/**
|
|
110995
|
-
*
|
|
110996
110924
|
* Represents the ShapeDataItemCollection for a given Shape.
|
|
110997
110925
|
*
|
|
110926
|
+
* @remarks
|
|
110998
110927
|
* [Api set: 1.1]
|
|
110999
110928
|
*/
|
|
111000
110929
|
class ShapeDataItemCollection extends OfficeExtension.ClientObject {
|
|
@@ -111003,16 +110932,16 @@ declare namespace Visio {
|
|
|
111003
110932
|
/** Gets the loaded child items in this collection. */
|
|
111004
110933
|
readonly items: Visio.ShapeDataItem[];
|
|
111005
110934
|
/**
|
|
111006
|
-
*
|
|
111007
110935
|
* Gets the number of Shape Data Items.
|
|
111008
110936
|
*
|
|
110937
|
+
* @remarks
|
|
111009
110938
|
* [Api set: 1.1]
|
|
111010
110939
|
*/
|
|
111011
110940
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
111012
110941
|
/**
|
|
111013
|
-
*
|
|
111014
110942
|
* Gets the ShapeDataItem using its name.
|
|
111015
110943
|
*
|
|
110944
|
+
* @remarks
|
|
111016
110945
|
* [Api set: 1.1]
|
|
111017
110946
|
*
|
|
111018
110947
|
* @param key Key is the name of the ShapeDataItem to be retrieved.
|
|
@@ -111047,39 +110976,39 @@ declare namespace Visio {
|
|
|
111047
110976
|
setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
|
|
111048
110977
|
}
|
|
111049
110978
|
/**
|
|
111050
|
-
*
|
|
111051
110979
|
* Represents the ShapeDataItem.
|
|
111052
110980
|
*
|
|
110981
|
+
* @remarks
|
|
111053
110982
|
* [Api set: 1.1]
|
|
111054
110983
|
*/
|
|
111055
110984
|
class ShapeDataItem extends OfficeExtension.ClientObject {
|
|
111056
110985
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111057
110986
|
context: RequestContext;
|
|
111058
110987
|
/**
|
|
110988
|
+
* A string that specifies the format of the shape data item.
|
|
111059
110989
|
*
|
|
111060
|
-
*
|
|
111061
|
-
*
|
|
110990
|
+
* @remarks
|
|
111062
110991
|
* [Api set: 1.1]
|
|
111063
110992
|
*/
|
|
111064
110993
|
readonly format: string;
|
|
111065
110994
|
/**
|
|
110995
|
+
* A string that specifies the formatted value of the shape data item.
|
|
111066
110996
|
*
|
|
111067
|
-
*
|
|
111068
|
-
*
|
|
110997
|
+
* @remarks
|
|
111069
110998
|
* [Api set: 1.1]
|
|
111070
110999
|
*/
|
|
111071
111000
|
readonly formattedValue: string;
|
|
111072
111001
|
/**
|
|
111002
|
+
* A string that specifies the label of the shape data item.
|
|
111073
111003
|
*
|
|
111074
|
-
*
|
|
111075
|
-
*
|
|
111004
|
+
* @remarks
|
|
111076
111005
|
* [Api set: 1.1]
|
|
111077
111006
|
*/
|
|
111078
111007
|
readonly label: string;
|
|
111079
111008
|
/**
|
|
111009
|
+
* A string that specifies the value of the shape data item.
|
|
111080
111010
|
*
|
|
111081
|
-
*
|
|
111082
|
-
*
|
|
111011
|
+
* @remarks
|
|
111083
111012
|
* [Api set: 1.1]
|
|
111084
111013
|
*/
|
|
111085
111014
|
readonly value: string;
|
|
@@ -111115,9 +111044,9 @@ declare namespace Visio {
|
|
|
111115
111044
|
setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
|
|
111116
111045
|
}
|
|
111117
111046
|
/**
|
|
111118
|
-
*
|
|
111119
111047
|
* Represents the Hyperlink Collection.
|
|
111120
111048
|
*
|
|
111049
|
+
* @remarks
|
|
111121
111050
|
* [Api set: 1.1]
|
|
111122
111051
|
*/
|
|
111123
111052
|
class HyperlinkCollection extends OfficeExtension.ClientObject {
|
|
@@ -111126,16 +111055,16 @@ declare namespace Visio {
|
|
|
111126
111055
|
/** Gets the loaded child items in this collection. */
|
|
111127
111056
|
readonly items: Visio.Hyperlink[];
|
|
111128
111057
|
/**
|
|
111129
|
-
*
|
|
111130
111058
|
* Gets the number of hyperlinks.
|
|
111131
111059
|
*
|
|
111060
|
+
* @remarks
|
|
111132
111061
|
* [Api set: 1.1]
|
|
111133
111062
|
*/
|
|
111134
111063
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
111135
111064
|
/**
|
|
111136
|
-
*
|
|
111137
111065
|
* Gets a Hyperlink using its key (name or Id).
|
|
111138
111066
|
*
|
|
111067
|
+
* @remarks
|
|
111139
111068
|
* [Api set: 1.1]
|
|
111140
111069
|
*
|
|
111141
111070
|
* @param Key Key is the name or index of the Hyperlink to be retrieved.
|
|
@@ -111170,39 +111099,39 @@ declare namespace Visio {
|
|
|
111170
111099
|
setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
|
|
111171
111100
|
}
|
|
111172
111101
|
/**
|
|
111173
|
-
*
|
|
111174
111102
|
* Represents the Hyperlink.
|
|
111175
111103
|
*
|
|
111104
|
+
* @remarks
|
|
111176
111105
|
* [Api set: 1.1]
|
|
111177
111106
|
*/
|
|
111178
111107
|
class Hyperlink extends OfficeExtension.ClientObject {
|
|
111179
111108
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111180
111109
|
context: RequestContext;
|
|
111181
111110
|
/**
|
|
111111
|
+
* Gets the address of the Hyperlink object.
|
|
111182
111112
|
*
|
|
111183
|
-
*
|
|
111184
|
-
*
|
|
111113
|
+
* @remarks
|
|
111185
111114
|
* [Api set: 1.1]
|
|
111186
111115
|
*/
|
|
111187
111116
|
readonly address: string;
|
|
111188
111117
|
/**
|
|
111118
|
+
* Gets the description of a hyperlink.
|
|
111189
111119
|
*
|
|
111190
|
-
*
|
|
111191
|
-
*
|
|
111120
|
+
* @remarks
|
|
111192
111121
|
* [Api set: 1.1]
|
|
111193
111122
|
*/
|
|
111194
111123
|
readonly description: string;
|
|
111195
111124
|
/**
|
|
111125
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
111196
111126
|
*
|
|
111197
|
-
*
|
|
111198
|
-
*
|
|
111127
|
+
* @remarks
|
|
111199
111128
|
* [Api set: 1.1]
|
|
111200
111129
|
*/
|
|
111201
111130
|
readonly extraInfo: string;
|
|
111202
111131
|
/**
|
|
111132
|
+
* Gets the sub-address of the Hyperlink object.
|
|
111203
111133
|
*
|
|
111204
|
-
*
|
|
111205
|
-
*
|
|
111134
|
+
* @remarks
|
|
111206
111135
|
* [Api set: 1.1]
|
|
111207
111136
|
*/
|
|
111208
111137
|
readonly subAddress: string;
|
|
@@ -111238,9 +111167,9 @@ declare namespace Visio {
|
|
|
111238
111167
|
setMockData(data: Visio.Interfaces.HyperlinkData): void;
|
|
111239
111168
|
}
|
|
111240
111169
|
/**
|
|
111241
|
-
*
|
|
111242
111170
|
* Represents the CommentCollection for a given Shape.
|
|
111243
111171
|
*
|
|
111172
|
+
* @remarks
|
|
111244
111173
|
* [Api set: 1.1]
|
|
111245
111174
|
*/
|
|
111246
111175
|
class CommentCollection extends OfficeExtension.ClientObject {
|
|
@@ -111249,16 +111178,16 @@ declare namespace Visio {
|
|
|
111249
111178
|
/** Gets the loaded child items in this collection. */
|
|
111250
111179
|
readonly items: Visio.Comment[];
|
|
111251
111180
|
/**
|
|
111252
|
-
*
|
|
111253
111181
|
* Gets the number of Comments.
|
|
111254
111182
|
*
|
|
111183
|
+
* @remarks
|
|
111255
111184
|
* [Api set: 1.1]
|
|
111256
111185
|
*/
|
|
111257
111186
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
111258
111187
|
/**
|
|
111259
|
-
*
|
|
111260
111188
|
* Gets the Comment using its name.
|
|
111261
111189
|
*
|
|
111190
|
+
* @remarks
|
|
111262
111191
|
* [Api set: 1.1]
|
|
111263
111192
|
*
|
|
111264
111193
|
* @param key Key is the name of the Comment to be retrieved.
|
|
@@ -111293,43 +111222,37 @@ declare namespace Visio {
|
|
|
111293
111222
|
setMockData(data: Visio.Interfaces.CommentCollectionData): void;
|
|
111294
111223
|
}
|
|
111295
111224
|
/**
|
|
111296
|
-
*
|
|
111297
111225
|
* Represents the Comment.
|
|
111298
111226
|
*
|
|
111227
|
+
* @remarks
|
|
111299
111228
|
* [Api set: 1.1]
|
|
111300
111229
|
*/
|
|
111301
111230
|
class Comment extends OfficeExtension.ClientObject {
|
|
111302
111231
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111303
111232
|
context: RequestContext;
|
|
111304
111233
|
/**
|
|
111305
|
-
*
|
|
111306
111234
|
* A string that specifies the name of the author of the comment.
|
|
111307
111235
|
*
|
|
111236
|
+
* @remarks
|
|
111308
111237
|
* [Api set: 1.1]
|
|
111309
111238
|
*/
|
|
111310
111239
|
author: string;
|
|
111311
111240
|
/**
|
|
111312
|
-
*
|
|
111313
111241
|
* A string that specifies the date when the comment was created.
|
|
111314
111242
|
*
|
|
111243
|
+
* @remarks
|
|
111315
111244
|
* [Api set: 1.1]
|
|
111316
111245
|
*/
|
|
111317
111246
|
date: string;
|
|
111318
111247
|
/**
|
|
111319
|
-
*
|
|
111320
111248
|
* A string that contains the comment text.
|
|
111321
111249
|
*
|
|
111250
|
+
* @remarks
|
|
111322
111251
|
* [Api set: 1.1]
|
|
111323
111252
|
*/
|
|
111324
111253
|
text: string;
|
|
111325
|
-
/**
|
|
111326
|
-
*
|
|
111327
|
-
* @remarks
|
|
111328
|
-
*
|
|
111329
|
-
* This method has the following additional signature:
|
|
111330
|
-
*
|
|
111331
|
-
* `set(properties: Visio.Comment): void`
|
|
111332
|
-
*
|
|
111254
|
+
/**
|
|
111255
|
+
* 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.
|
|
111333
111256
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
111334
111257
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
111335
111258
|
*/
|
|
@@ -111368,18 +111291,18 @@ declare namespace Visio {
|
|
|
111368
111291
|
setMockData(data: Visio.Interfaces.CommentData): void;
|
|
111369
111292
|
}
|
|
111370
111293
|
/**
|
|
111371
|
-
*
|
|
111372
111294
|
* Represents the Selection in the page.
|
|
111373
111295
|
*
|
|
111296
|
+
* @remarks
|
|
111374
111297
|
* [Api set: 1.1]
|
|
111375
111298
|
*/
|
|
111376
111299
|
class Selection extends OfficeExtension.ClientObject {
|
|
111377
111300
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111378
111301
|
context: RequestContext;
|
|
111379
111302
|
/**
|
|
111303
|
+
* Gets the Shapes of the Selection.
|
|
111380
111304
|
*
|
|
111381
|
-
*
|
|
111382
|
-
*
|
|
111305
|
+
* @remarks
|
|
111383
111306
|
* [Api set: 1.1]
|
|
111384
111307
|
*/
|
|
111385
111308
|
readonly shapes: Visio.ShapeCollection;
|
|
@@ -111405,575 +111328,502 @@ declare namespace Visio {
|
|
|
111405
111328
|
toJSON(): Visio.Interfaces.SelectionData;
|
|
111406
111329
|
}
|
|
111407
111330
|
/**
|
|
111408
|
-
*
|
|
111409
|
-
* Shape binding informations required for data visualizer diagram
|
|
111410
|
-
*
|
|
111411
|
-
* [Api set: 1.1]
|
|
111412
|
-
*/
|
|
111413
|
-
interface ShapeBinding {
|
|
111414
|
-
/**
|
|
111415
|
-
*
|
|
111416
|
-
* Column for alternative text for shape.
|
|
111417
|
-
*
|
|
111418
|
-
* [Api set: 1.1]
|
|
111419
|
-
*/
|
|
111420
|
-
alternativeTextColumnName: string;
|
|
111421
|
-
/**
|
|
111422
|
-
*
|
|
111423
|
-
* Column for Shape label.
|
|
111424
|
-
*
|
|
111425
|
-
* [Api set: 1.1]
|
|
111426
|
-
*/
|
|
111427
|
-
labelColumnName: string;
|
|
111428
|
-
/**
|
|
111429
|
-
*
|
|
111430
|
-
* Unique Id column.
|
|
111431
|
-
*
|
|
111432
|
-
* [Api set: 1.1]
|
|
111433
|
-
*/
|
|
111434
|
-
uniqueIDColumnName: string;
|
|
111435
|
-
}
|
|
111436
|
-
/**
|
|
111437
|
-
*
|
|
111438
|
-
* Connector bindings for data visualizer diagram.
|
|
111439
|
-
*
|
|
111440
|
-
* [Api set: 1.1]
|
|
111441
|
-
*/
|
|
111442
|
-
interface ConnectorBinding {
|
|
111443
|
-
/**
|
|
111444
|
-
*
|
|
111445
|
-
* If true then connectors are added in sequence according to the uniqueId column.
|
|
111446
|
-
*
|
|
111447
|
-
* [Api set: 1.1]
|
|
111448
|
-
*/
|
|
111449
|
-
connectSequentially: boolean;
|
|
111450
|
-
/**
|
|
111451
|
-
*
|
|
111452
|
-
* Delimiter for TargetColumn. It should not have more then one character.
|
|
111453
|
-
*
|
|
111454
|
-
* [Api set: 1.1]
|
|
111455
|
-
*/
|
|
111456
|
-
delimiter: string;
|
|
111457
|
-
/**
|
|
111458
|
-
*
|
|
111459
|
-
* Direction of connector to use in diagram.
|
|
111460
|
-
*
|
|
111461
|
-
* [Api set: 1.1]
|
|
111462
|
-
*/
|
|
111463
|
-
direction: Visio.ConnectorDirection | "FromTarget" | "ToTarget";
|
|
111464
|
-
/**
|
|
111465
|
-
*
|
|
111466
|
-
* Column for ConnectorLabel (shape text of connector).
|
|
111467
|
-
*
|
|
111468
|
-
* [Api set: 1.1]
|
|
111469
|
-
*/
|
|
111470
|
-
labelColumnName: string;
|
|
111471
|
-
/**
|
|
111472
|
-
*
|
|
111473
|
-
* Column for proving connected target shape.
|
|
111474
|
-
*
|
|
111475
|
-
* [Api set: 1.1]
|
|
111476
|
-
*/
|
|
111477
|
-
targetColumnName: string;
|
|
111478
|
-
}
|
|
111479
|
-
/**
|
|
111480
|
-
*
|
|
111481
111331
|
* Represents the Horizontal Alignment of the Overlay relative to the shape.
|
|
111482
111332
|
*
|
|
111333
|
+
* @remarks
|
|
111483
111334
|
* [Api set: 1.1]
|
|
111484
111335
|
*/
|
|
111485
111336
|
enum OverlayHorizontalAlignment {
|
|
111486
111337
|
/**
|
|
111487
|
-
*
|
|
111488
|
-
*
|
|
111489
|
-
*
|
|
111338
|
+
* @remarks
|
|
111339
|
+
* [Api set: 1.1]
|
|
111490
111340
|
*/
|
|
111491
111341
|
left = "Left",
|
|
111492
111342
|
/**
|
|
111493
|
-
*
|
|
111494
|
-
*
|
|
111495
|
-
*
|
|
111343
|
+
* @remarks
|
|
111344
|
+
* [Api set: 1.1]
|
|
111496
111345
|
*/
|
|
111497
111346
|
center = "Center",
|
|
111498
111347
|
/**
|
|
111499
|
-
*
|
|
111500
|
-
*
|
|
111501
|
-
*
|
|
111348
|
+
* @remarks
|
|
111349
|
+
* [Api set: 1.1]
|
|
111502
111350
|
*/
|
|
111503
111351
|
right = "Right",
|
|
111504
111352
|
}
|
|
111505
111353
|
/**
|
|
111506
|
-
*
|
|
111507
111354
|
* Represents the Vertical Alignment of the Overlay relative to the shape.
|
|
111508
111355
|
*
|
|
111356
|
+
* @remarks
|
|
111509
111357
|
* [Api set: 1.1]
|
|
111510
111358
|
*/
|
|
111511
111359
|
enum OverlayVerticalAlignment {
|
|
111512
111360
|
/**
|
|
111513
|
-
*
|
|
111514
|
-
*
|
|
111515
|
-
*
|
|
111361
|
+
* @remarks
|
|
111362
|
+
* [Api set: 1.1]
|
|
111516
111363
|
*/
|
|
111517
111364
|
top = "Top",
|
|
111518
111365
|
/**
|
|
111519
|
-
*
|
|
111520
|
-
*
|
|
111521
|
-
*
|
|
111366
|
+
* @remarks
|
|
111367
|
+
* [Api set: 1.1]
|
|
111522
111368
|
*/
|
|
111523
111369
|
middle = "Middle",
|
|
111524
111370
|
/**
|
|
111525
|
-
*
|
|
111526
|
-
*
|
|
111527
|
-
*
|
|
111371
|
+
* @remarks
|
|
111372
|
+
* [Api set: 1.1]
|
|
111528
111373
|
*/
|
|
111529
111374
|
bottom = "Bottom",
|
|
111530
111375
|
}
|
|
111531
111376
|
/**
|
|
111532
|
-
*
|
|
111533
111377
|
* Represents the type of the overlay.
|
|
111534
111378
|
*
|
|
111379
|
+
* @remarks
|
|
111535
111380
|
* [Api set: 1.1]
|
|
111536
111381
|
*/
|
|
111537
111382
|
enum OverlayType {
|
|
111538
111383
|
/**
|
|
111539
|
-
*
|
|
111540
|
-
*
|
|
111541
|
-
*
|
|
111384
|
+
* @remarks
|
|
111385
|
+
* [Api set: 1.1]
|
|
111542
111386
|
*/
|
|
111543
111387
|
text = "Text",
|
|
111544
111388
|
/**
|
|
111545
|
-
*
|
|
111546
|
-
*
|
|
111547
|
-
*
|
|
111389
|
+
* @remarks
|
|
111390
|
+
* [Api set: 1.1]
|
|
111548
111391
|
*/
|
|
111549
111392
|
image = "Image",
|
|
111550
111393
|
/**
|
|
111551
|
-
*
|
|
111552
|
-
*
|
|
111553
|
-
*
|
|
111394
|
+
* @remarks
|
|
111395
|
+
* [Api set: 1.1]
|
|
111554
111396
|
*/
|
|
111555
111397
|
html = "Html",
|
|
111556
111398
|
}
|
|
111557
111399
|
/**
|
|
111400
|
+
* Toolbar IDs of the app.
|
|
111558
111401
|
*
|
|
111559
|
-
*
|
|
111560
|
-
*
|
|
111402
|
+
* @remarks
|
|
111561
111403
|
* [Api set: 1.1]
|
|
111562
111404
|
*/
|
|
111563
111405
|
enum ToolBarType {
|
|
111564
111406
|
/**
|
|
111565
|
-
*
|
|
111566
|
-
*
|
|
111567
|
-
*
|
|
111407
|
+
* The command toolbar type.
|
|
111408
|
+
* @remarks
|
|
111409
|
+
* [Api set: 1.1]
|
|
111568
111410
|
*/
|
|
111569
111411
|
commandBar = "CommandBar",
|
|
111570
111412
|
/**
|
|
111571
|
-
*
|
|
111572
|
-
*
|
|
111573
|
-
*
|
|
111413
|
+
* The page navigation toolbar type.
|
|
111414
|
+
* @remarks
|
|
111415
|
+
* [Api set: 1.1]
|
|
111574
111416
|
*/
|
|
111575
111417
|
pageNavigationBar = "PageNavigationBar",
|
|
111576
111418
|
/**
|
|
111577
|
-
*
|
|
111578
|
-
*
|
|
111579
|
-
*
|
|
111419
|
+
* The status toolbar type.
|
|
111420
|
+
* @remarks
|
|
111421
|
+
* [Api set: 1.1]
|
|
111580
111422
|
*/
|
|
111581
111423
|
statusBar = "StatusBar",
|
|
111582
111424
|
}
|
|
111583
111425
|
/**
|
|
111584
|
-
*
|
|
111585
111426
|
* Result of Data Visualizer Diagram operations.
|
|
111586
111427
|
*
|
|
111428
|
+
* @remarks
|
|
111587
111429
|
* [Api set: 1.1]
|
|
111588
111430
|
*/
|
|
111589
111431
|
enum DataVisualizerDiagramResultType {
|
|
111590
111432
|
/**
|
|
111591
|
-
*
|
|
111592
|
-
*
|
|
111593
|
-
*
|
|
111433
|
+
* Operation is successful.
|
|
111434
|
+
* @remarks
|
|
111435
|
+
* [Api set: 1.1]
|
|
111594
111436
|
*/
|
|
111595
111437
|
success = "Success",
|
|
111596
111438
|
/**
|
|
111597
|
-
*
|
|
111598
111439
|
* Unexpected error during operation.
|
|
111599
|
-
*
|
|
111440
|
+
* @remarks
|
|
111441
|
+
* [Api set: 1.1]
|
|
111600
111442
|
*/
|
|
111601
111443
|
unexpected = "Unexpected",
|
|
111602
111444
|
/**
|
|
111603
|
-
*
|
|
111604
111445
|
* Validation error in operation.
|
|
111605
|
-
*
|
|
111446
|
+
* @remarks
|
|
111447
|
+
* [Api set: 1.1]
|
|
111606
111448
|
*/
|
|
111607
111449
|
validationError = "ValidationError",
|
|
111608
111450
|
/**
|
|
111609
|
-
*
|
|
111610
111451
|
* Conflict error in operation.
|
|
111611
|
-
*
|
|
111452
|
+
* @remarks
|
|
111453
|
+
* [Api set: 1.1]
|
|
111612
111454
|
*/
|
|
111613
111455
|
conflictError = "ConflictError",
|
|
111614
111456
|
}
|
|
111615
111457
|
/**
|
|
111616
|
-
*
|
|
111617
111458
|
* Type of the Data Visualizer Diagram operation
|
|
111618
111459
|
*
|
|
111460
|
+
* @remarks
|
|
111619
111461
|
* [Api set: 1.1]
|
|
111620
111462
|
*/
|
|
111621
111463
|
enum DataVisualizerDiagramOperationType {
|
|
111622
111464
|
/**
|
|
111623
|
-
*
|
|
111624
|
-
*
|
|
111625
|
-
*
|
|
111465
|
+
* Unknown operation type.
|
|
111466
|
+
* @remarks
|
|
111467
|
+
* [Api set: 1.1]
|
|
111626
111468
|
*/
|
|
111627
111469
|
unknown = "Unknown",
|
|
111628
111470
|
/**
|
|
111629
|
-
*
|
|
111630
111471
|
* Creation operation.
|
|
111631
|
-
*
|
|
111472
|
+
* @remarks
|
|
111473
|
+
* [Api set: 1.1]
|
|
111632
111474
|
*/
|
|
111633
111475
|
create = "Create",
|
|
111634
111476
|
/**
|
|
111635
|
-
*
|
|
111636
111477
|
* Update Mappings operation.
|
|
111637
|
-
*
|
|
111478
|
+
* @remarks
|
|
111479
|
+
* [Api set: 1.1]
|
|
111638
111480
|
*/
|
|
111639
111481
|
updateMappings = "UpdateMappings",
|
|
111640
111482
|
/**
|
|
111641
|
-
*
|
|
111642
111483
|
* Update data associated with diagram.
|
|
111643
|
-
*
|
|
111484
|
+
* @remarks
|
|
111485
|
+
* [Api set: 1.1]
|
|
111644
111486
|
*/
|
|
111645
111487
|
updateData = "UpdateData",
|
|
111646
111488
|
/**
|
|
111647
|
-
*
|
|
111648
111489
|
* Update both data and mappings.
|
|
111649
|
-
*
|
|
111490
|
+
* @remarks
|
|
111491
|
+
* [Api set: 1.1]
|
|
111650
111492
|
*/
|
|
111651
111493
|
update = "Update",
|
|
111652
111494
|
/**
|
|
111653
|
-
*
|
|
111654
111495
|
* Delete the diagram content.
|
|
111655
|
-
*
|
|
111496
|
+
* @remarks
|
|
111497
|
+
* [Api set: 1.1]
|
|
111656
111498
|
*/
|
|
111657
111499
|
delete = "Delete",
|
|
111658
111500
|
}
|
|
111659
111501
|
/**
|
|
111502
|
+
* DiagramType for Data Visualizer diagrams.
|
|
111660
111503
|
*
|
|
111661
|
-
*
|
|
111662
|
-
*
|
|
111504
|
+
* @remarks
|
|
111663
111505
|
* [Api set: 1.1]
|
|
111664
111506
|
*/
|
|
111665
111507
|
enum DataVisualizerDiagramType {
|
|
111666
111508
|
/**
|
|
111667
|
-
*
|
|
111668
|
-
*
|
|
111669
|
-
*
|
|
111509
|
+
* @remarks
|
|
111510
|
+
* [Api set: 1.1]
|
|
111670
111511
|
*/
|
|
111671
111512
|
unknown = "Unknown",
|
|
111672
111513
|
/**
|
|
111673
|
-
*
|
|
111674
|
-
*
|
|
111675
|
-
*
|
|
111514
|
+
* @remarks
|
|
111515
|
+
* [Api set: 1.1]
|
|
111676
111516
|
*/
|
|
111677
111517
|
basicFlowchart = "BasicFlowchart",
|
|
111678
111518
|
/**
|
|
111679
|
-
*
|
|
111680
|
-
*
|
|
111681
|
-
*
|
|
111519
|
+
* @remarks
|
|
111520
|
+
* [Api set: 1.1]
|
|
111682
111521
|
*/
|
|
111683
111522
|
crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
|
|
111684
111523
|
/**
|
|
111685
|
-
*
|
|
111686
|
-
*
|
|
111687
|
-
*
|
|
111524
|
+
* @remarks
|
|
111525
|
+
* [Api set: 1.1]
|
|
111688
111526
|
*/
|
|
111689
111527
|
crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
|
|
111690
111528
|
/**
|
|
111691
|
-
*
|
|
111692
|
-
*
|
|
111693
|
-
*
|
|
111529
|
+
* @remarks
|
|
111530
|
+
* [Api set: 1.1]
|
|
111694
111531
|
*/
|
|
111695
111532
|
audit = "Audit",
|
|
111696
111533
|
/**
|
|
111697
|
-
*
|
|
111698
|
-
*
|
|
111699
|
-
*
|
|
111534
|
+
* @remarks
|
|
111535
|
+
* [Api set: 1.1]
|
|
111700
111536
|
*/
|
|
111701
111537
|
orgChart = "OrgChart",
|
|
111702
111538
|
/**
|
|
111703
|
-
*
|
|
111704
|
-
*
|
|
111705
|
-
*
|
|
111539
|
+
* @remarks
|
|
111540
|
+
* [Api set: 1.1]
|
|
111706
111541
|
*/
|
|
111707
111542
|
network = "Network",
|
|
111708
111543
|
}
|
|
111709
111544
|
/**
|
|
111710
|
-
*
|
|
111711
111545
|
* Represents the type of column values.
|
|
111712
111546
|
*
|
|
111547
|
+
* @remarks
|
|
111713
111548
|
* [Api set: 1.1]
|
|
111714
111549
|
*/
|
|
111715
111550
|
enum ColumnType {
|
|
111716
111551
|
/**
|
|
111717
|
-
*
|
|
111718
|
-
*
|
|
111719
|
-
*
|
|
111552
|
+
* @remarks
|
|
111553
|
+
* [Api set: 1.1]
|
|
111720
111554
|
*/
|
|
111721
111555
|
unknown = "Unknown",
|
|
111722
111556
|
/**
|
|
111723
|
-
*
|
|
111724
|
-
*
|
|
111725
|
-
*
|
|
111557
|
+
* @remarks
|
|
111558
|
+
* [Api set: 1.1]
|
|
111726
111559
|
*/
|
|
111727
111560
|
string = "String",
|
|
111728
111561
|
/**
|
|
111729
|
-
*
|
|
111730
|
-
*
|
|
111731
|
-
*
|
|
111562
|
+
* @remarks
|
|
111563
|
+
* [Api set: 1.1]
|
|
111732
111564
|
*/
|
|
111733
111565
|
number = "Number",
|
|
111734
111566
|
/**
|
|
111735
|
-
*
|
|
111736
|
-
*
|
|
111737
|
-
*
|
|
111567
|
+
* @remarks
|
|
111568
|
+
* [Api set: 1.1]
|
|
111738
111569
|
*/
|
|
111739
111570
|
date = "Date",
|
|
111740
111571
|
/**
|
|
111741
|
-
*
|
|
111742
|
-
*
|
|
111743
|
-
*
|
|
111572
|
+
* @remarks
|
|
111573
|
+
* [Api set: 1.1]
|
|
111744
111574
|
*/
|
|
111745
111575
|
currency = "Currency",
|
|
111746
111576
|
}
|
|
111747
111577
|
/**
|
|
111748
|
-
*
|
|
111749
111578
|
* Represents the type of source for the data connection.
|
|
111750
111579
|
*
|
|
111580
|
+
* @remarks
|
|
111751
111581
|
* [Api set: 1.1]
|
|
111752
111582
|
*/
|
|
111753
111583
|
enum DataSourceType {
|
|
111754
111584
|
/**
|
|
111755
|
-
*
|
|
111756
|
-
*
|
|
111757
|
-
*
|
|
111585
|
+
* Unknown Data Source.
|
|
111586
|
+
* @remarks
|
|
111587
|
+
* [Api set: 1.1]
|
|
111758
111588
|
*/
|
|
111759
111589
|
unknown = "Unknown",
|
|
111760
111590
|
/**
|
|
111761
|
-
*
|
|
111762
|
-
*
|
|
111763
|
-
*
|
|
111591
|
+
* Microsoft Excel workbook.
|
|
111592
|
+
* @remarks
|
|
111593
|
+
* [Api set: 1.1]
|
|
111764
111594
|
*/
|
|
111765
111595
|
excel = "Excel",
|
|
111766
111596
|
}
|
|
111767
111597
|
/**
|
|
111768
|
-
*
|
|
111769
111598
|
* Represents the orientation of the Cross Functional Flowchart diagram.
|
|
111770
111599
|
*
|
|
111600
|
+
* @remarks
|
|
111771
111601
|
* [Api set: 1.1]
|
|
111772
111602
|
*/
|
|
111773
111603
|
enum CrossFunctionalFlowchartOrientation {
|
|
111774
111604
|
/**
|
|
111775
|
-
*
|
|
111776
111605
|
* Horizontal Cross Functional Flowchart.
|
|
111777
|
-
*
|
|
111606
|
+
* @remarks
|
|
111607
|
+
* [Api set: 1.1]
|
|
111778
111608
|
*/
|
|
111779
111609
|
horizontal = "Horizontal",
|
|
111780
111610
|
/**
|
|
111781
|
-
*
|
|
111782
111611
|
* Vertical Cross Functional Flowchart.
|
|
111783
|
-
*
|
|
111612
|
+
* @remarks
|
|
111613
|
+
* [Api set: 1.1]
|
|
111784
111614
|
*/
|
|
111785
111615
|
vertical = "Vertical",
|
|
111786
111616
|
}
|
|
111787
111617
|
/**
|
|
111788
|
-
*
|
|
111789
111618
|
* Represents the type of layout.
|
|
111790
111619
|
*
|
|
111620
|
+
* @remarks
|
|
111791
111621
|
* [Api set: 1.1]
|
|
111792
111622
|
*/
|
|
111793
111623
|
enum LayoutVariant {
|
|
111794
111624
|
/**
|
|
111795
|
-
*
|
|
111796
|
-
*
|
|
111797
|
-
*
|
|
111625
|
+
* Invalid layout.
|
|
111626
|
+
* @remarks
|
|
111627
|
+
* [Api set: 1.1]
|
|
111798
111628
|
*/
|
|
111799
111629
|
unknown = "Unknown",
|
|
111800
111630
|
/**
|
|
111801
|
-
*
|
|
111802
|
-
*
|
|
111803
|
-
*
|
|
111631
|
+
* Use the Page default layout.
|
|
111632
|
+
* @remarks
|
|
111633
|
+
* [Api set: 1.1]
|
|
111804
111634
|
*/
|
|
111805
111635
|
pageDefault = "PageDefault",
|
|
111806
111636
|
/**
|
|
111807
|
-
*
|
|
111808
|
-
*
|
|
111809
|
-
*
|
|
111637
|
+
* Use Flowchart with TopToBottom orientation.
|
|
111638
|
+
* @remarks
|
|
111639
|
+
* [Api set: 1.1]
|
|
111810
111640
|
*/
|
|
111811
111641
|
flowchart_TopToBottom = "Flowchart_TopToBottom",
|
|
111812
111642
|
/**
|
|
111813
|
-
*
|
|
111814
|
-
*
|
|
111815
|
-
*
|
|
111643
|
+
* Use Flowchart with BottomToTop orientation.
|
|
111644
|
+
* @remarks
|
|
111645
|
+
* [Api set: 1.1]
|
|
111816
111646
|
*/
|
|
111817
111647
|
flowchart_BottomToTop = "Flowchart_BottomToTop",
|
|
111818
111648
|
/**
|
|
111819
|
-
*
|
|
111820
|
-
*
|
|
111821
|
-
*
|
|
111649
|
+
* Use Flowchart with LeftToRight orientation.
|
|
111650
|
+
* @remarks
|
|
111651
|
+
* [Api set: 1.1]
|
|
111822
111652
|
*/
|
|
111823
111653
|
flowchart_LeftToRight = "Flowchart_LeftToRight",
|
|
111824
111654
|
/**
|
|
111825
|
-
*
|
|
111826
|
-
*
|
|
111827
|
-
*
|
|
111655
|
+
* Use Flowchart with RightToLeft orientation.
|
|
111656
|
+
* @remarks
|
|
111657
|
+
* [Api set: 1.1]
|
|
111828
111658
|
*/
|
|
111829
111659
|
flowchart_RightToLeft = "Flowchart_RightToLeft",
|
|
111830
111660
|
/**
|
|
111831
|
-
*
|
|
111832
|
-
*
|
|
111833
|
-
*
|
|
111661
|
+
* Use WideTree with DownThenRight orientation.
|
|
111662
|
+
* @remarks
|
|
111663
|
+
* [Api set: 1.1]
|
|
111834
111664
|
*/
|
|
111835
111665
|
wideTree_DownThenRight = "WideTree_DownThenRight",
|
|
111836
111666
|
/**
|
|
111837
|
-
*
|
|
111838
|
-
*
|
|
111839
|
-
*
|
|
111667
|
+
* Use WideTree with DownThenLeft orientation.
|
|
111668
|
+
* @remarks
|
|
111669
|
+
* [Api set: 1.1]
|
|
111840
111670
|
*/
|
|
111841
111671
|
wideTree_DownThenLeft = "WideTree_DownThenLeft",
|
|
111842
111672
|
/**
|
|
111843
|
-
*
|
|
111844
|
-
*
|
|
111845
|
-
*
|
|
111673
|
+
* Use WideTree with RightThenDown orientation.
|
|
111674
|
+
* @remarks
|
|
111675
|
+
* [Api set: 1.1]
|
|
111846
111676
|
*/
|
|
111847
111677
|
wideTree_RightThenDown = "WideTree_RightThenDown",
|
|
111848
111678
|
/**
|
|
111849
|
-
*
|
|
111850
|
-
*
|
|
111851
|
-
*
|
|
111679
|
+
* Use WideTree with LeftThenDown orientation.
|
|
111680
|
+
* @remarks
|
|
111681
|
+
* [Api set: 1.1]
|
|
111852
111682
|
*/
|
|
111853
111683
|
wideTree_LeftThenDown = "WideTree_LeftThenDown",
|
|
111854
111684
|
}
|
|
111855
111685
|
/**
|
|
111856
|
-
*
|
|
111857
111686
|
* Represents the types of data validation error.
|
|
111858
111687
|
*
|
|
111688
|
+
* @remarks
|
|
111859
111689
|
* [Api set: 1.1]
|
|
111860
111690
|
*/
|
|
111861
111691
|
enum DataValidationErrorType {
|
|
111862
111692
|
/**
|
|
111863
|
-
*
|
|
111864
|
-
*
|
|
111865
|
-
*
|
|
111693
|
+
* No error.
|
|
111694
|
+
* @remarks
|
|
111695
|
+
* [Api set: 1.1]
|
|
111866
111696
|
*/
|
|
111867
111697
|
none = "None",
|
|
111868
111698
|
/**
|
|
111869
|
-
*
|
|
111870
111699
|
* Data does not have one of the mapped column.
|
|
111871
|
-
*
|
|
111700
|
+
* @remarks
|
|
111701
|
+
* [Api set: 1.1]
|
|
111872
111702
|
*/
|
|
111873
111703
|
columnNotMapped = "ColumnNotMapped",
|
|
111874
111704
|
/**
|
|
111875
|
-
*
|
|
111876
111705
|
* UniqueId column has error.
|
|
111877
|
-
*
|
|
111706
|
+
* @remarks
|
|
111707
|
+
* [Api set: 1.1]
|
|
111878
111708
|
*/
|
|
111879
111709
|
uniqueIdColumnError = "UniqueIdColumnError",
|
|
111880
111710
|
/**
|
|
111881
|
-
*
|
|
111882
111711
|
* Swim-lane column is empty.
|
|
111883
|
-
*
|
|
111712
|
+
* @remarks
|
|
111713
|
+
* [Api set: 1.1]
|
|
111884
111714
|
*/
|
|
111885
111715
|
swimlaneColumnError = "SwimlaneColumnError",
|
|
111886
111716
|
/**
|
|
111887
|
-
*
|
|
111888
111717
|
* Delimiter can not have more then one character.
|
|
111889
|
-
*
|
|
111718
|
+
* @remarks
|
|
111719
|
+
* [Api set: 1.1]
|
|
111890
111720
|
*/
|
|
111891
111721
|
delimiterError = "DelimiterError",
|
|
111892
111722
|
/**
|
|
111893
|
-
*
|
|
111894
|
-
*
|
|
111895
|
-
*
|
|
111723
|
+
* Connector column has error.
|
|
111724
|
+
* @remarks
|
|
111725
|
+
* [Api set: 1.1]
|
|
111896
111726
|
*/
|
|
111897
111727
|
connectorColumnError = "ConnectorColumnError",
|
|
111898
111728
|
/**
|
|
111899
|
-
*
|
|
111900
111729
|
* Connector column is already mapped
|
|
111901
|
-
|
|
111902
|
-
*
|
|
111730
|
+
to another setting.
|
|
111731
|
+
* @remarks
|
|
111732
|
+
* [Api set: 1.1]
|
|
111903
111733
|
*/
|
|
111904
111734
|
connectorColumnMappedElsewhere = "ConnectorColumnMappedElsewhere",
|
|
111905
111735
|
/**
|
|
111906
|
-
*
|
|
111907
111736
|
* Connector label column already mapped
|
|
111908
|
-
|
|
111909
|
-
*
|
|
111737
|
+
to other setting.
|
|
111738
|
+
* @remarks
|
|
111739
|
+
* [Api set: 1.1]
|
|
111910
111740
|
*/
|
|
111911
111741
|
connectorLabelColumnMappedElsewhere = "ConnectorLabelColumnMappedElsewhere",
|
|
111912
111742
|
/**
|
|
111913
|
-
*
|
|
111914
111743
|
* Connector column and connector label column are
|
|
111915
|
-
|
|
111916
|
-
*
|
|
111744
|
+
already mapped to other setting.
|
|
111745
|
+
* @remarks
|
|
111746
|
+
* [Api set: 1.1]
|
|
111917
111747
|
*/
|
|
111918
111748
|
connectorColumnAndConnectorLabelMappedElsewhere = "ConnectorColumnAndConnectorLabelMappedElsewhere",
|
|
111919
111749
|
}
|
|
111920
111750
|
/**
|
|
111921
|
-
*
|
|
111922
111751
|
* Direction of connector in DataVisualizer diagram.
|
|
111923
111752
|
*
|
|
111753
|
+
* @remarks
|
|
111924
111754
|
* [Api set: 1.1]
|
|
111925
111755
|
*/
|
|
111926
111756
|
enum ConnectorDirection {
|
|
111927
111757
|
/**
|
|
111928
|
-
*
|
|
111929
111758
|
* Direction will be from target to source shape.
|
|
111930
|
-
*
|
|
111759
|
+
* @remarks
|
|
111760
|
+
* [Api set: 1.1]
|
|
111931
111761
|
*/
|
|
111932
111762
|
fromTarget = "FromTarget",
|
|
111933
111763
|
/**
|
|
111934
|
-
*
|
|
111935
111764
|
* Direction will be from source to target shape.
|
|
111936
|
-
*
|
|
111765
|
+
* @remarks
|
|
111766
|
+
* [Api set: 1.1]
|
|
111937
111767
|
*/
|
|
111938
111768
|
toTarget = "ToTarget",
|
|
111939
111769
|
}
|
|
111940
111770
|
/**
|
|
111771
|
+
* TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API, TaskPane State Changed, or similar events.
|
|
111941
111772
|
*
|
|
111942
|
-
*
|
|
111943
|
-
*
|
|
111773
|
+
* @remarks
|
|
111944
111774
|
* [Api set: 1.1]
|
|
111945
111775
|
*/
|
|
111946
111776
|
enum TaskPaneType {
|
|
111947
111777
|
/**
|
|
111948
|
-
*
|
|
111949
|
-
*
|
|
111950
|
-
*
|
|
111778
|
+
* No task pane.
|
|
111779
|
+
* @remarks
|
|
111780
|
+
* [Api set: 1.1]
|
|
111951
111781
|
*/
|
|
111952
111782
|
none = "None",
|
|
111953
111783
|
/**
|
|
111954
|
-
*
|
|
111955
|
-
*
|
|
111956
|
-
*
|
|
111784
|
+
* Data Visualizer Process Mapping pane.
|
|
111785
|
+
* @remarks
|
|
111786
|
+
* [Api set: 1.1]
|
|
111957
111787
|
*/
|
|
111958
111788
|
dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
|
|
111959
111789
|
/**
|
|
111960
|
-
*
|
|
111961
|
-
*
|
|
111962
|
-
*
|
|
111790
|
+
* Data Visualizer Organization Mapping pane.
|
|
111791
|
+
* @remarks
|
|
111792
|
+
* [Api set: 1.1]
|
|
111963
111793
|
*/
|
|
111964
111794
|
dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
|
|
111965
111795
|
}
|
|
111966
111796
|
/**
|
|
111797
|
+
* MessageType represents the type of message when event is fired from Host.
|
|
111967
111798
|
*
|
|
111968
|
-
*
|
|
111799
|
+
* @remarks
|
|
111800
|
+
* [Api set: 1.1]
|
|
111801
|
+
*/
|
|
111802
|
+
enum MessageType {
|
|
111803
|
+
/**
|
|
111804
|
+
* No message.
|
|
111805
|
+
* @remarks
|
|
111806
|
+
* [Api set: 1.1]
|
|
111807
|
+
*/
|
|
111808
|
+
none = 0,
|
|
111809
|
+
/**
|
|
111810
|
+
* DataVisualizer diagram operation complete Event Message.
|
|
111811
|
+
* @remarks
|
|
111812
|
+
* [Api set: 1.1]
|
|
111813
|
+
*/
|
|
111814
|
+
dataVisualizerDiagramOperationCompletedEvent = 1,
|
|
111815
|
+
}
|
|
111816
|
+
/**
|
|
111817
|
+
* EventType represents the type of the events Host supports.
|
|
111969
111818
|
*
|
|
111819
|
+
* @remarks
|
|
111970
111820
|
* [Api set: 1.1]
|
|
111971
111821
|
*/
|
|
111972
111822
|
enum EventType {
|
|
111973
111823
|
/**
|
|
111974
|
-
*
|
|
111975
|
-
*
|
|
111976
|
-
*
|
|
111824
|
+
* DataVisualizer diagram operation complete Event.
|
|
111825
|
+
* @remarks
|
|
111826
|
+
* [Api set: 1.1]
|
|
111977
111827
|
*/
|
|
111978
111828
|
dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
|
|
111979
111829
|
}
|
|
@@ -112002,16 +111852,16 @@ declare namespace Visio {
|
|
|
112002
111852
|
/** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
|
|
112003
111853
|
interface ApplicationUpdateData {
|
|
112004
111854
|
/**
|
|
111855
|
+
* Shows or hides the iframe application borders.
|
|
112005
111856
|
*
|
|
112006
|
-
*
|
|
112007
|
-
*
|
|
111857
|
+
* @remarks
|
|
112008
111858
|
* [Api set: 1.1]
|
|
112009
111859
|
*/
|
|
112010
111860
|
showBorders?: boolean;
|
|
112011
111861
|
/**
|
|
111862
|
+
* Shows or hides the standard toolbars.
|
|
112012
111863
|
*
|
|
112013
|
-
*
|
|
112014
|
-
*
|
|
111864
|
+
* @remarks
|
|
112015
111865
|
* [Api set: 1.1]
|
|
112016
111866
|
*/
|
|
112017
111867
|
showToolbars?: boolean;
|
|
@@ -112019,16 +111869,16 @@ declare namespace Visio {
|
|
|
112019
111869
|
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
112020
111870
|
interface DocumentUpdateData {
|
|
112021
111871
|
/**
|
|
112022
|
-
*
|
|
112023
111872
|
* Represents a Visio application instance that contains this document.
|
|
112024
111873
|
*
|
|
111874
|
+
* @remarks
|
|
112025
111875
|
* [Api set: 1.1]
|
|
112026
111876
|
*/
|
|
112027
111877
|
application?: Visio.Interfaces.ApplicationUpdateData;
|
|
112028
111878
|
/**
|
|
112029
|
-
*
|
|
112030
111879
|
* Returns the DocumentView object.
|
|
112031
111880
|
*
|
|
111881
|
+
* @remarks
|
|
112032
111882
|
* [Api set: 1.1]
|
|
112033
111883
|
*/
|
|
112034
111884
|
view?: Visio.Interfaces.DocumentViewUpdateData;
|
|
@@ -112036,37 +111886,37 @@ declare namespace Visio {
|
|
|
112036
111886
|
/** An interface for updating data on the DocumentView object, for use in `documentView.set({ ... })`. */
|
|
112037
111887
|
interface DocumentViewUpdateData {
|
|
112038
111888
|
/**
|
|
112039
|
-
*
|
|
112040
111889
|
* Disable Hyperlinks.
|
|
112041
111890
|
*
|
|
111891
|
+
* @remarks
|
|
112042
111892
|
* [Api set: 1.1]
|
|
112043
111893
|
*/
|
|
112044
111894
|
disableHyperlinks?: boolean;
|
|
112045
111895
|
/**
|
|
112046
|
-
*
|
|
112047
111896
|
* Disable Pan.
|
|
112048
111897
|
*
|
|
111898
|
+
* @remarks
|
|
112049
111899
|
* [Api set: 1.1]
|
|
112050
111900
|
*/
|
|
112051
111901
|
disablePan?: boolean;
|
|
112052
111902
|
/**
|
|
112053
|
-
*
|
|
112054
111903
|
* Disable PanZoomWindow.
|
|
112055
111904
|
*
|
|
111905
|
+
* @remarks
|
|
112056
111906
|
* [Api set: 1.1]
|
|
112057
111907
|
*/
|
|
112058
111908
|
disablePanZoomWindow?: boolean;
|
|
112059
111909
|
/**
|
|
112060
|
-
*
|
|
112061
111910
|
* Disable Zoom.
|
|
112062
111911
|
*
|
|
111912
|
+
* @remarks
|
|
112063
111913
|
* [Api set: 1.1]
|
|
112064
111914
|
*/
|
|
112065
111915
|
disableZoom?: boolean;
|
|
112066
111916
|
/**
|
|
112067
|
-
*
|
|
112068
111917
|
* Hide Diagram Boundary.
|
|
112069
111918
|
*
|
|
111919
|
+
* @remarks
|
|
112070
111920
|
* [Api set: 1.1]
|
|
112071
111921
|
*/
|
|
112072
111922
|
hideDiagramBoundary?: boolean;
|
|
@@ -112074,9 +111924,9 @@ declare namespace Visio {
|
|
|
112074
111924
|
/** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
|
|
112075
111925
|
interface PageUpdateData {
|
|
112076
111926
|
/**
|
|
112077
|
-
*
|
|
112078
111927
|
* Returns the view of the page.
|
|
112079
111928
|
*
|
|
111929
|
+
* @remarks
|
|
112080
111930
|
* [Api set: 1.1]
|
|
112081
111931
|
*/
|
|
112082
111932
|
view?: Visio.Interfaces.PageViewUpdateData;
|
|
@@ -112084,9 +111934,9 @@ declare namespace Visio {
|
|
|
112084
111934
|
/** An interface for updating data on the PageView object, for use in `pageView.set({ ... })`. */
|
|
112085
111935
|
interface PageViewUpdateData {
|
|
112086
111936
|
/**
|
|
111937
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112087
111938
|
*
|
|
112088
|
-
*
|
|
112089
|
-
*
|
|
111939
|
+
* @remarks
|
|
112090
111940
|
* [Api set: 1.1]
|
|
112091
111941
|
*/
|
|
112092
111942
|
zoom?: number;
|
|
@@ -112102,16 +111952,16 @@ declare namespace Visio {
|
|
|
112102
111952
|
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
112103
111953
|
interface ShapeUpdateData {
|
|
112104
111954
|
/**
|
|
112105
|
-
*
|
|
112106
111955
|
* Returns the view of the shape.
|
|
112107
111956
|
*
|
|
111957
|
+
* @remarks
|
|
112108
111958
|
* [Api set: 1.1]
|
|
112109
111959
|
*/
|
|
112110
111960
|
view?: Visio.Interfaces.ShapeViewUpdateData;
|
|
112111
111961
|
/**
|
|
112112
|
-
*
|
|
112113
111962
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112114
111963
|
*
|
|
111964
|
+
* @remarks
|
|
112115
111965
|
* [Api set: 1.1]
|
|
112116
111966
|
*/
|
|
112117
111967
|
select?: boolean;
|
|
@@ -112119,9 +111969,9 @@ declare namespace Visio {
|
|
|
112119
111969
|
/** An interface for updating data on the ShapeView object, for use in `shapeView.set({ ... })`. */
|
|
112120
111970
|
interface ShapeViewUpdateData {
|
|
112121
111971
|
/**
|
|
112122
|
-
*
|
|
112123
111972
|
* Represents the highlight around the shape.
|
|
112124
111973
|
*
|
|
111974
|
+
* @remarks
|
|
112125
111975
|
* [Api set: 1.1]
|
|
112126
111976
|
*/
|
|
112127
111977
|
highlight?: Visio.Highlight;
|
|
@@ -112141,23 +111991,23 @@ declare namespace Visio {
|
|
|
112141
111991
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
112142
111992
|
interface CommentUpdateData {
|
|
112143
111993
|
/**
|
|
112144
|
-
*
|
|
112145
111994
|
* A string that specifies the name of the author of the comment.
|
|
112146
111995
|
*
|
|
111996
|
+
* @remarks
|
|
112147
111997
|
* [Api set: 1.1]
|
|
112148
111998
|
*/
|
|
112149
111999
|
author?: string;
|
|
112150
112000
|
/**
|
|
112151
|
-
*
|
|
112152
112001
|
* A string that specifies the date when the comment was created.
|
|
112153
112002
|
*
|
|
112003
|
+
* @remarks
|
|
112154
112004
|
* [Api set: 1.1]
|
|
112155
112005
|
*/
|
|
112156
112006
|
date?: string;
|
|
112157
112007
|
/**
|
|
112158
|
-
*
|
|
112159
112008
|
* A string that contains the comment text.
|
|
112160
112009
|
*
|
|
112010
|
+
* @remarks
|
|
112161
112011
|
* [Api set: 1.1]
|
|
112162
112012
|
*/
|
|
112163
112013
|
text?: string;
|
|
@@ -112165,16 +112015,16 @@ declare namespace Visio {
|
|
|
112165
112015
|
/** An interface describing the data returned by calling `application.toJSON()`. */
|
|
112166
112016
|
interface ApplicationData {
|
|
112167
112017
|
/**
|
|
112018
|
+
* Shows or hides the iframe application borders.
|
|
112168
112019
|
*
|
|
112169
|
-
*
|
|
112170
|
-
*
|
|
112020
|
+
* @remarks
|
|
112171
112021
|
* [Api set: 1.1]
|
|
112172
112022
|
*/
|
|
112173
112023
|
showBorders?: boolean;
|
|
112174
112024
|
/**
|
|
112025
|
+
* Shows or hides the standard toolbars.
|
|
112175
112026
|
*
|
|
112176
|
-
*
|
|
112177
|
-
*
|
|
112027
|
+
* @remarks
|
|
112178
112028
|
* [Api set: 1.1]
|
|
112179
112029
|
*/
|
|
112180
112030
|
showToolbars?: boolean;
|
|
@@ -112182,23 +112032,23 @@ declare namespace Visio {
|
|
|
112182
112032
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
112183
112033
|
interface DocumentData {
|
|
112184
112034
|
/**
|
|
112035
|
+
* Represents a Visio application instance that contains this document.
|
|
112185
112036
|
*
|
|
112186
|
-
*
|
|
112187
|
-
*
|
|
112037
|
+
* @remarks
|
|
112188
112038
|
* [Api set: 1.1]
|
|
112189
112039
|
*/
|
|
112190
112040
|
application?: Visio.Interfaces.ApplicationData;
|
|
112191
112041
|
/**
|
|
112042
|
+
* Represents a collection of pages associated with the document.
|
|
112192
112043
|
*
|
|
112193
|
-
*
|
|
112194
|
-
*
|
|
112044
|
+
* @remarks
|
|
112195
112045
|
* [Api set: 1.1]
|
|
112196
112046
|
*/
|
|
112197
112047
|
pages?: Visio.Interfaces.PageData[];
|
|
112198
112048
|
/**
|
|
112049
|
+
* Returns the DocumentView object.
|
|
112199
112050
|
*
|
|
112200
|
-
*
|
|
112201
|
-
*
|
|
112051
|
+
* @remarks
|
|
112202
112052
|
* [Api set: 1.1]
|
|
112203
112053
|
*/
|
|
112204
112054
|
view?: Visio.Interfaces.DocumentViewData;
|
|
@@ -112206,37 +112056,37 @@ declare namespace Visio {
|
|
|
112206
112056
|
/** An interface describing the data returned by calling `documentView.toJSON()`. */
|
|
112207
112057
|
interface DocumentViewData {
|
|
112208
112058
|
/**
|
|
112209
|
-
*
|
|
112210
112059
|
* Disable Hyperlinks.
|
|
112211
112060
|
*
|
|
112061
|
+
* @remarks
|
|
112212
112062
|
* [Api set: 1.1]
|
|
112213
112063
|
*/
|
|
112214
112064
|
disableHyperlinks?: boolean;
|
|
112215
112065
|
/**
|
|
112216
|
-
*
|
|
112217
112066
|
* Disable Pan.
|
|
112218
112067
|
*
|
|
112068
|
+
* @remarks
|
|
112219
112069
|
* [Api set: 1.1]
|
|
112220
112070
|
*/
|
|
112221
112071
|
disablePan?: boolean;
|
|
112222
112072
|
/**
|
|
112223
|
-
*
|
|
112224
112073
|
* Disable PanZoomWindow.
|
|
112225
112074
|
*
|
|
112075
|
+
* @remarks
|
|
112226
112076
|
* [Api set: 1.1]
|
|
112227
112077
|
*/
|
|
112228
112078
|
disablePanZoomWindow?: boolean;
|
|
112229
112079
|
/**
|
|
112230
|
-
*
|
|
112231
112080
|
* Disable Zoom.
|
|
112232
112081
|
*
|
|
112082
|
+
* @remarks
|
|
112233
112083
|
* [Api set: 1.1]
|
|
112234
112084
|
*/
|
|
112235
112085
|
disableZoom?: boolean;
|
|
112236
112086
|
/**
|
|
112237
|
-
*
|
|
112238
112087
|
* Hide Diagram Boundary.
|
|
112239
112088
|
*
|
|
112089
|
+
* @remarks
|
|
112240
112090
|
* [Api set: 1.1]
|
|
112241
112091
|
*/
|
|
112242
112092
|
hideDiagramBoundary?: boolean;
|
|
@@ -112244,65 +112094,65 @@ declare namespace Visio {
|
|
|
112244
112094
|
/** An interface describing the data returned by calling `page.toJSON()`. */
|
|
112245
112095
|
interface PageData {
|
|
112246
112096
|
/**
|
|
112097
|
+
* All shapes in the Page, including subshapes.
|
|
112247
112098
|
*
|
|
112248
|
-
*
|
|
112249
|
-
*
|
|
112099
|
+
* @remarks
|
|
112250
112100
|
* [Api set: 1.1]
|
|
112251
112101
|
*/
|
|
112252
112102
|
allShapes?: Visio.Interfaces.ShapeData[];
|
|
112253
112103
|
/**
|
|
112104
|
+
* Returns the Comments Collection.
|
|
112254
112105
|
*
|
|
112255
|
-
*
|
|
112256
|
-
*
|
|
112106
|
+
* @remarks
|
|
112257
112107
|
* [Api set: 1.1]
|
|
112258
112108
|
*/
|
|
112259
112109
|
comments?: Visio.Interfaces.CommentData[];
|
|
112260
112110
|
/**
|
|
112111
|
+
* All top-level shapes in the Page.
|
|
112261
112112
|
*
|
|
112262
|
-
*
|
|
112263
|
-
*
|
|
112113
|
+
* @remarks
|
|
112264
112114
|
* [Api set: 1.1]
|
|
112265
112115
|
*/
|
|
112266
112116
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
112267
112117
|
/**
|
|
112118
|
+
* Returns the view of the page.
|
|
112268
112119
|
*
|
|
112269
|
-
*
|
|
112270
|
-
*
|
|
112120
|
+
* @remarks
|
|
112271
112121
|
* [Api set: 1.1]
|
|
112272
112122
|
*/
|
|
112273
112123
|
view?: Visio.Interfaces.PageViewData;
|
|
112274
112124
|
/**
|
|
112125
|
+
* Returns the height of the page.
|
|
112275
112126
|
*
|
|
112276
|
-
*
|
|
112277
|
-
*
|
|
112127
|
+
* @remarks
|
|
112278
112128
|
* [Api set: 1.1]
|
|
112279
112129
|
*/
|
|
112280
112130
|
height?: number;
|
|
112281
112131
|
/**
|
|
112132
|
+
* Index of the Page.
|
|
112282
112133
|
*
|
|
112283
|
-
*
|
|
112284
|
-
*
|
|
112134
|
+
* @remarks
|
|
112285
112135
|
* [Api set: 1.1]
|
|
112286
112136
|
*/
|
|
112287
112137
|
index?: number;
|
|
112288
112138
|
/**
|
|
112139
|
+
* Whether the page is a background page or not.
|
|
112289
112140
|
*
|
|
112290
|
-
*
|
|
112291
|
-
*
|
|
112141
|
+
* @remarks
|
|
112292
112142
|
* [Api set: 1.1]
|
|
112293
112143
|
*/
|
|
112294
112144
|
isBackground?: boolean;
|
|
112295
112145
|
/**
|
|
112146
|
+
* Page name.
|
|
112296
112147
|
*
|
|
112297
|
-
*
|
|
112298
|
-
*
|
|
112148
|
+
* @remarks
|
|
112299
112149
|
* [Api set: 1.1]
|
|
112300
112150
|
*/
|
|
112301
112151
|
name?: string;
|
|
112302
112152
|
/**
|
|
112153
|
+
* Returns the width of the page.
|
|
112303
112154
|
*
|
|
112304
|
-
*
|
|
112305
|
-
*
|
|
112155
|
+
* @remarks
|
|
112306
112156
|
* [Api set: 1.1]
|
|
112307
112157
|
*/
|
|
112308
112158
|
width?: number;
|
|
@@ -112310,9 +112160,9 @@ declare namespace Visio {
|
|
|
112310
112160
|
/** An interface describing the data returned by calling `pageView.toJSON()`. */
|
|
112311
112161
|
interface PageViewData {
|
|
112312
112162
|
/**
|
|
112163
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112313
112164
|
*
|
|
112314
|
-
*
|
|
112315
|
-
*
|
|
112165
|
+
* @remarks
|
|
112316
112166
|
* [Api set: 1.1]
|
|
112317
112167
|
*/
|
|
112318
112168
|
zoom?: number;
|
|
@@ -112328,65 +112178,65 @@ declare namespace Visio {
|
|
|
112328
112178
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
112329
112179
|
interface ShapeData {
|
|
112330
112180
|
/**
|
|
112181
|
+
* Returns the Comments Collection.
|
|
112331
112182
|
*
|
|
112332
|
-
*
|
|
112333
|
-
*
|
|
112183
|
+
* @remarks
|
|
112334
112184
|
* [Api set: 1.1]
|
|
112335
112185
|
*/
|
|
112336
112186
|
comments?: Visio.Interfaces.CommentData[];
|
|
112337
112187
|
/**
|
|
112188
|
+
* Returns the Hyperlinks collection for a Shape object.
|
|
112338
112189
|
*
|
|
112339
|
-
*
|
|
112340
|
-
*
|
|
112190
|
+
* @remarks
|
|
112341
112191
|
* [Api set: 1.1]
|
|
112342
112192
|
*/
|
|
112343
112193
|
hyperlinks?: Visio.Interfaces.HyperlinkData[];
|
|
112344
112194
|
/**
|
|
112195
|
+
* Returns the Shape's Data Section.
|
|
112345
112196
|
*
|
|
112346
|
-
*
|
|
112347
|
-
*
|
|
112197
|
+
* @remarks
|
|
112348
112198
|
* [Api set: 1.1]
|
|
112349
112199
|
*/
|
|
112350
112200
|
shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
|
|
112351
112201
|
/**
|
|
112202
|
+
* Gets SubShape Collection.
|
|
112352
112203
|
*
|
|
112353
|
-
*
|
|
112354
|
-
*
|
|
112204
|
+
* @remarks
|
|
112355
112205
|
* [Api set: 1.1]
|
|
112356
112206
|
*/
|
|
112357
112207
|
subShapes?: Visio.Interfaces.ShapeData[];
|
|
112358
112208
|
/**
|
|
112209
|
+
* Returns the view of the shape.
|
|
112359
112210
|
*
|
|
112360
|
-
*
|
|
112361
|
-
*
|
|
112211
|
+
* @remarks
|
|
112362
112212
|
* [Api set: 1.1]
|
|
112363
112213
|
*/
|
|
112364
112214
|
view?: Visio.Interfaces.ShapeViewData;
|
|
112365
112215
|
/**
|
|
112216
|
+
* Shape's identifier.
|
|
112366
112217
|
*
|
|
112367
|
-
*
|
|
112368
|
-
*
|
|
112218
|
+
* @remarks
|
|
112369
112219
|
* [Api set: 1.1]
|
|
112370
112220
|
*/
|
|
112371
112221
|
id?: number;
|
|
112372
112222
|
/**
|
|
112223
|
+
* Shape's name.
|
|
112373
112224
|
*
|
|
112374
|
-
*
|
|
112375
|
-
*
|
|
112225
|
+
* @remarks
|
|
112376
112226
|
* [Api set: 1.1]
|
|
112377
112227
|
*/
|
|
112378
112228
|
name?: string;
|
|
112379
112229
|
/**
|
|
112380
|
-
*
|
|
112381
112230
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112382
112231
|
*
|
|
112232
|
+
* @remarks
|
|
112383
112233
|
* [Api set: 1.1]
|
|
112384
112234
|
*/
|
|
112385
112235
|
select?: boolean;
|
|
112386
112236
|
/**
|
|
112237
|
+
* Shape's text.
|
|
112387
112238
|
*
|
|
112388
|
-
*
|
|
112389
|
-
*
|
|
112239
|
+
* @remarks
|
|
112390
112240
|
* [Api set: 1.1]
|
|
112391
112241
|
*/
|
|
112392
112242
|
text?: string;
|
|
@@ -112394,9 +112244,9 @@ declare namespace Visio {
|
|
|
112394
112244
|
/** An interface describing the data returned by calling `shapeView.toJSON()`. */
|
|
112395
112245
|
interface ShapeViewData {
|
|
112396
112246
|
/**
|
|
112397
|
-
*
|
|
112398
112247
|
* Represents the highlight around the shape.
|
|
112399
112248
|
*
|
|
112249
|
+
* @remarks
|
|
112400
112250
|
* [Api set: 1.1]
|
|
112401
112251
|
*/
|
|
112402
112252
|
highlight?: Visio.Highlight;
|
|
@@ -112408,30 +112258,30 @@ declare namespace Visio {
|
|
|
112408
112258
|
/** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
|
|
112409
112259
|
interface ShapeDataItemData {
|
|
112410
112260
|
/**
|
|
112261
|
+
* A string that specifies the format of the shape data item.
|
|
112411
112262
|
*
|
|
112412
|
-
*
|
|
112413
|
-
*
|
|
112263
|
+
* @remarks
|
|
112414
112264
|
* [Api set: 1.1]
|
|
112415
112265
|
*/
|
|
112416
112266
|
format?: string;
|
|
112417
112267
|
/**
|
|
112268
|
+
* A string that specifies the formatted value of the shape data item.
|
|
112418
112269
|
*
|
|
112419
|
-
*
|
|
112420
|
-
*
|
|
112270
|
+
* @remarks
|
|
112421
112271
|
* [Api set: 1.1]
|
|
112422
112272
|
*/
|
|
112423
112273
|
formattedValue?: string;
|
|
112424
112274
|
/**
|
|
112275
|
+
* A string that specifies the label of the shape data item.
|
|
112425
112276
|
*
|
|
112426
|
-
*
|
|
112427
|
-
*
|
|
112277
|
+
* @remarks
|
|
112428
112278
|
* [Api set: 1.1]
|
|
112429
112279
|
*/
|
|
112430
112280
|
label?: string;
|
|
112431
112281
|
/**
|
|
112282
|
+
* A string that specifies the value of the shape data item.
|
|
112432
112283
|
*
|
|
112433
|
-
*
|
|
112434
|
-
*
|
|
112284
|
+
* @remarks
|
|
112435
112285
|
* [Api set: 1.1]
|
|
112436
112286
|
*/
|
|
112437
112287
|
value?: string;
|
|
@@ -112443,30 +112293,30 @@ declare namespace Visio {
|
|
|
112443
112293
|
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
|
|
112444
112294
|
interface HyperlinkData {
|
|
112445
112295
|
/**
|
|
112296
|
+
* Gets the address of the Hyperlink object.
|
|
112446
112297
|
*
|
|
112447
|
-
*
|
|
112448
|
-
*
|
|
112298
|
+
* @remarks
|
|
112449
112299
|
* [Api set: 1.1]
|
|
112450
112300
|
*/
|
|
112451
112301
|
address?: string;
|
|
112452
112302
|
/**
|
|
112303
|
+
* Gets the description of a hyperlink.
|
|
112453
112304
|
*
|
|
112454
|
-
*
|
|
112455
|
-
*
|
|
112305
|
+
* @remarks
|
|
112456
112306
|
* [Api set: 1.1]
|
|
112457
112307
|
*/
|
|
112458
112308
|
description?: string;
|
|
112459
112309
|
/**
|
|
112310
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
112460
112311
|
*
|
|
112461
|
-
*
|
|
112462
|
-
*
|
|
112312
|
+
* @remarks
|
|
112463
112313
|
* [Api set: 1.1]
|
|
112464
112314
|
*/
|
|
112465
112315
|
extraInfo?: string;
|
|
112466
112316
|
/**
|
|
112317
|
+
* Gets the sub-address of the Hyperlink object.
|
|
112467
112318
|
*
|
|
112468
|
-
*
|
|
112469
|
-
*
|
|
112319
|
+
* @remarks
|
|
112470
112320
|
* [Api set: 1.1]
|
|
112471
112321
|
*/
|
|
112472
112322
|
subAddress?: string;
|
|
@@ -112478,23 +112328,23 @@ declare namespace Visio {
|
|
|
112478
112328
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
112479
112329
|
interface CommentData {
|
|
112480
112330
|
/**
|
|
112481
|
-
*
|
|
112482
112331
|
* A string that specifies the name of the author of the comment.
|
|
112483
112332
|
*
|
|
112333
|
+
* @remarks
|
|
112484
112334
|
* [Api set: 1.1]
|
|
112485
112335
|
*/
|
|
112486
112336
|
author?: string;
|
|
112487
112337
|
/**
|
|
112488
|
-
*
|
|
112489
112338
|
* A string that specifies the date when the comment was created.
|
|
112490
112339
|
*
|
|
112340
|
+
* @remarks
|
|
112491
112341
|
* [Api set: 1.1]
|
|
112492
112342
|
*/
|
|
112493
112343
|
date?: string;
|
|
112494
112344
|
/**
|
|
112495
|
-
*
|
|
112496
112345
|
* A string that contains the comment text.
|
|
112497
112346
|
*
|
|
112347
|
+
* @remarks
|
|
112498
112348
|
* [Api set: 1.1]
|
|
112499
112349
|
*/
|
|
112500
112350
|
text?: string;
|
|
@@ -112502,17 +112352,17 @@ declare namespace Visio {
|
|
|
112502
112352
|
/** An interface describing the data returned by calling `selection.toJSON()`. */
|
|
112503
112353
|
interface SelectionData {
|
|
112504
112354
|
/**
|
|
112355
|
+
* Gets the Shapes of the Selection.
|
|
112505
112356
|
*
|
|
112506
|
-
*
|
|
112507
|
-
*
|
|
112357
|
+
* @remarks
|
|
112508
112358
|
* [Api set: 1.1]
|
|
112509
112359
|
*/
|
|
112510
112360
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
112511
112361
|
}
|
|
112512
112362
|
/**
|
|
112513
|
-
*
|
|
112514
112363
|
* Represents the Application.
|
|
112515
112364
|
*
|
|
112365
|
+
* @remarks
|
|
112516
112366
|
* [Api set: 1.1]
|
|
112517
112367
|
*/
|
|
112518
112368
|
interface ApplicationLoadOptions {
|
|
@@ -112521,24 +112371,24 @@ declare namespace Visio {
|
|
|
112521
112371
|
*/
|
|
112522
112372
|
$all?: boolean;
|
|
112523
112373
|
/**
|
|
112374
|
+
* Shows or hides the iframe application borders.
|
|
112524
112375
|
*
|
|
112525
|
-
*
|
|
112526
|
-
*
|
|
112376
|
+
* @remarks
|
|
112527
112377
|
* [Api set: 1.1]
|
|
112528
112378
|
*/
|
|
112529
112379
|
showBorders?: boolean;
|
|
112530
112380
|
/**
|
|
112381
|
+
* Shows or hides the standard toolbars.
|
|
112531
112382
|
*
|
|
112532
|
-
*
|
|
112533
|
-
*
|
|
112383
|
+
* @remarks
|
|
112534
112384
|
* [Api set: 1.1]
|
|
112535
112385
|
*/
|
|
112536
112386
|
showToolbars?: boolean;
|
|
112537
112387
|
}
|
|
112538
112388
|
/**
|
|
112539
|
-
*
|
|
112540
112389
|
* Represents the Document class.
|
|
112541
112390
|
*
|
|
112391
|
+
* @remarks
|
|
112542
112392
|
* [Api set: 1.1]
|
|
112543
112393
|
*/
|
|
112544
112394
|
interface DocumentLoadOptions {
|
|
@@ -112547,24 +112397,24 @@ declare namespace Visio {
|
|
|
112547
112397
|
*/
|
|
112548
112398
|
$all?: boolean;
|
|
112549
112399
|
/**
|
|
112550
|
-
*
|
|
112551
112400
|
* Represents a Visio application instance that contains this document.
|
|
112552
112401
|
*
|
|
112402
|
+
* @remarks
|
|
112553
112403
|
* [Api set: 1.1]
|
|
112554
112404
|
*/
|
|
112555
112405
|
application?: Visio.Interfaces.ApplicationLoadOptions;
|
|
112556
112406
|
/**
|
|
112557
|
-
*
|
|
112558
112407
|
* Returns the DocumentView object.
|
|
112559
112408
|
*
|
|
112409
|
+
* @remarks
|
|
112560
112410
|
* [Api set: 1.1]
|
|
112561
112411
|
*/
|
|
112562
112412
|
view?: Visio.Interfaces.DocumentViewLoadOptions;
|
|
112563
112413
|
}
|
|
112564
112414
|
/**
|
|
112565
|
-
*
|
|
112566
112415
|
* Represents the DocumentView class.
|
|
112567
112416
|
*
|
|
112417
|
+
* @remarks
|
|
112568
112418
|
* [Api set: 1.1]
|
|
112569
112419
|
*/
|
|
112570
112420
|
interface DocumentViewLoadOptions {
|
|
@@ -112573,45 +112423,45 @@ declare namespace Visio {
|
|
|
112573
112423
|
*/
|
|
112574
112424
|
$all?: boolean;
|
|
112575
112425
|
/**
|
|
112576
|
-
*
|
|
112577
112426
|
* Disable Hyperlinks.
|
|
112578
112427
|
*
|
|
112428
|
+
* @remarks
|
|
112579
112429
|
* [Api set: 1.1]
|
|
112580
112430
|
*/
|
|
112581
112431
|
disableHyperlinks?: boolean;
|
|
112582
112432
|
/**
|
|
112583
|
-
*
|
|
112584
112433
|
* Disable Pan.
|
|
112585
112434
|
*
|
|
112435
|
+
* @remarks
|
|
112586
112436
|
* [Api set: 1.1]
|
|
112587
112437
|
*/
|
|
112588
112438
|
disablePan?: boolean;
|
|
112589
112439
|
/**
|
|
112590
|
-
*
|
|
112591
112440
|
* Disable PanZoomWindow.
|
|
112592
112441
|
*
|
|
112442
|
+
* @remarks
|
|
112593
112443
|
* [Api set: 1.1]
|
|
112594
112444
|
*/
|
|
112595
112445
|
disablePanZoomWindow?: boolean;
|
|
112596
112446
|
/**
|
|
112597
|
-
*
|
|
112598
112447
|
* Disable Zoom.
|
|
112599
112448
|
*
|
|
112449
|
+
* @remarks
|
|
112600
112450
|
* [Api set: 1.1]
|
|
112601
112451
|
*/
|
|
112602
112452
|
disableZoom?: boolean;
|
|
112603
112453
|
/**
|
|
112604
|
-
*
|
|
112605
112454
|
* Hide Diagram Boundary.
|
|
112606
112455
|
*
|
|
112456
|
+
* @remarks
|
|
112607
112457
|
* [Api set: 1.1]
|
|
112608
112458
|
*/
|
|
112609
112459
|
hideDiagramBoundary?: boolean;
|
|
112610
112460
|
}
|
|
112611
112461
|
/**
|
|
112612
|
-
*
|
|
112613
112462
|
* Represents the Page class.
|
|
112614
112463
|
*
|
|
112464
|
+
* @remarks
|
|
112615
112465
|
* [Api set: 1.1]
|
|
112616
112466
|
*/
|
|
112617
112467
|
interface PageLoadOptions {
|
|
@@ -112620,52 +112470,52 @@ declare namespace Visio {
|
|
|
112620
112470
|
*/
|
|
112621
112471
|
$all?: boolean;
|
|
112622
112472
|
/**
|
|
112623
|
-
*
|
|
112624
112473
|
* Returns the view of the page.
|
|
112625
112474
|
*
|
|
112475
|
+
* @remarks
|
|
112626
112476
|
* [Api set: 1.1]
|
|
112627
112477
|
*/
|
|
112628
112478
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
112629
112479
|
/**
|
|
112480
|
+
* Returns the height of the page.
|
|
112630
112481
|
*
|
|
112631
|
-
*
|
|
112632
|
-
*
|
|
112482
|
+
* @remarks
|
|
112633
112483
|
* [Api set: 1.1]
|
|
112634
112484
|
*/
|
|
112635
112485
|
height?: boolean;
|
|
112636
112486
|
/**
|
|
112487
|
+
* Index of the Page.
|
|
112637
112488
|
*
|
|
112638
|
-
*
|
|
112639
|
-
*
|
|
112489
|
+
* @remarks
|
|
112640
112490
|
* [Api set: 1.1]
|
|
112641
112491
|
*/
|
|
112642
112492
|
index?: boolean;
|
|
112643
112493
|
/**
|
|
112494
|
+
* Whether the page is a background page or not.
|
|
112644
112495
|
*
|
|
112645
|
-
*
|
|
112646
|
-
*
|
|
112496
|
+
* @remarks
|
|
112647
112497
|
* [Api set: 1.1]
|
|
112648
112498
|
*/
|
|
112649
112499
|
isBackground?: boolean;
|
|
112650
112500
|
/**
|
|
112501
|
+
* Page name.
|
|
112651
112502
|
*
|
|
112652
|
-
*
|
|
112653
|
-
*
|
|
112503
|
+
* @remarks
|
|
112654
112504
|
* [Api set: 1.1]
|
|
112655
112505
|
*/
|
|
112656
112506
|
name?: boolean;
|
|
112657
112507
|
/**
|
|
112508
|
+
* Returns the width of the page.
|
|
112658
112509
|
*
|
|
112659
|
-
*
|
|
112660
|
-
*
|
|
112510
|
+
* @remarks
|
|
112661
112511
|
* [Api set: 1.1]
|
|
112662
112512
|
*/
|
|
112663
112513
|
width?: boolean;
|
|
112664
112514
|
}
|
|
112665
112515
|
/**
|
|
112666
|
-
*
|
|
112667
112516
|
* Represents the PageView class.
|
|
112668
112517
|
*
|
|
112518
|
+
* @remarks
|
|
112669
112519
|
* [Api set: 1.1]
|
|
112670
112520
|
*/
|
|
112671
112521
|
interface PageViewLoadOptions {
|
|
@@ -112674,17 +112524,17 @@ declare namespace Visio {
|
|
|
112674
112524
|
*/
|
|
112675
112525
|
$all?: boolean;
|
|
112676
112526
|
/**
|
|
112527
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112677
112528
|
*
|
|
112678
|
-
*
|
|
112679
|
-
*
|
|
112529
|
+
* @remarks
|
|
112680
112530
|
* [Api set: 1.1]
|
|
112681
112531
|
*/
|
|
112682
112532
|
zoom?: boolean;
|
|
112683
112533
|
}
|
|
112684
112534
|
/**
|
|
112685
|
-
*
|
|
112686
112535
|
* Represents a collection of Page objects that are part of the document.
|
|
112687
112536
|
*
|
|
112537
|
+
* @remarks
|
|
112688
112538
|
* [Api set: 1.1]
|
|
112689
112539
|
*/
|
|
112690
112540
|
interface PageCollectionLoadOptions {
|
|
@@ -112693,52 +112543,52 @@ declare namespace Visio {
|
|
|
112693
112543
|
*/
|
|
112694
112544
|
$all?: boolean;
|
|
112695
112545
|
/**
|
|
112696
|
-
*
|
|
112697
112546
|
* For EACH ITEM in the collection: Returns the view of the page.
|
|
112698
112547
|
*
|
|
112548
|
+
* @remarks
|
|
112699
112549
|
* [Api set: 1.1]
|
|
112700
112550
|
*/
|
|
112701
112551
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
112702
112552
|
/**
|
|
112553
|
+
* For EACH ITEM in the collection: Returns the height of the page.
|
|
112703
112554
|
*
|
|
112704
|
-
*
|
|
112705
|
-
*
|
|
112555
|
+
* @remarks
|
|
112706
112556
|
* [Api set: 1.1]
|
|
112707
112557
|
*/
|
|
112708
112558
|
height?: boolean;
|
|
112709
112559
|
/**
|
|
112560
|
+
* For EACH ITEM in the collection: Index of the Page.
|
|
112710
112561
|
*
|
|
112711
|
-
*
|
|
112712
|
-
*
|
|
112562
|
+
* @remarks
|
|
112713
112563
|
* [Api set: 1.1]
|
|
112714
112564
|
*/
|
|
112715
112565
|
index?: boolean;
|
|
112716
112566
|
/**
|
|
112567
|
+
* For EACH ITEM in the collection: Whether the page is a background page or not.
|
|
112717
112568
|
*
|
|
112718
|
-
*
|
|
112719
|
-
*
|
|
112569
|
+
* @remarks
|
|
112720
112570
|
* [Api set: 1.1]
|
|
112721
112571
|
*/
|
|
112722
112572
|
isBackground?: boolean;
|
|
112723
112573
|
/**
|
|
112574
|
+
* For EACH ITEM in the collection: Page name.
|
|
112724
112575
|
*
|
|
112725
|
-
*
|
|
112726
|
-
*
|
|
112576
|
+
* @remarks
|
|
112727
112577
|
* [Api set: 1.1]
|
|
112728
112578
|
*/
|
|
112729
112579
|
name?: boolean;
|
|
112730
112580
|
/**
|
|
112581
|
+
* For EACH ITEM in the collection: Returns the width of the page.
|
|
112731
112582
|
*
|
|
112732
|
-
*
|
|
112733
|
-
*
|
|
112583
|
+
* @remarks
|
|
112734
112584
|
* [Api set: 1.1]
|
|
112735
112585
|
*/
|
|
112736
112586
|
width?: boolean;
|
|
112737
112587
|
}
|
|
112738
112588
|
/**
|
|
112739
|
-
*
|
|
112740
112589
|
* Represents the Shape Collection.
|
|
112741
112590
|
*
|
|
112591
|
+
* @remarks
|
|
112742
112592
|
* [Api set: 1.1]
|
|
112743
112593
|
*/
|
|
112744
112594
|
interface ShapeCollectionLoadOptions {
|
|
@@ -112747,52 +112597,45 @@ declare namespace Visio {
|
|
|
112747
112597
|
*/
|
|
112748
112598
|
$all?: boolean;
|
|
112749
112599
|
/**
|
|
112750
|
-
*
|
|
112751
112600
|
* For EACH ITEM in the collection: Returns the view of the shape.
|
|
112752
112601
|
*
|
|
112602
|
+
* @remarks
|
|
112753
112603
|
* [Api set: 1.1]
|
|
112754
112604
|
*/
|
|
112755
112605
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
112756
112606
|
/**
|
|
112607
|
+
* For EACH ITEM in the collection: Shape's identifier.
|
|
112757
112608
|
*
|
|
112758
|
-
*
|
|
112759
|
-
*
|
|
112609
|
+
* @remarks
|
|
112760
112610
|
* [Api set: 1.1]
|
|
112761
112611
|
*/
|
|
112762
112612
|
id?: boolean;
|
|
112763
112613
|
/**
|
|
112614
|
+
* For EACH ITEM in the collection: Shape's name.
|
|
112764
112615
|
*
|
|
112765
|
-
*
|
|
112766
|
-
*
|
|
112767
|
-
* [Api set: 1.1]
|
|
112768
|
-
*/
|
|
112769
|
-
isBoundToData?: boolean;
|
|
112770
|
-
/**
|
|
112771
|
-
*
|
|
112772
|
-
* For EACH ITEM in the collection: Shape's name. Read-only.
|
|
112773
|
-
*
|
|
112616
|
+
* @remarks
|
|
112774
112617
|
* [Api set: 1.1]
|
|
112775
112618
|
*/
|
|
112776
112619
|
name?: boolean;
|
|
112777
112620
|
/**
|
|
112778
|
-
*
|
|
112779
112621
|
* For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112780
112622
|
*
|
|
112623
|
+
* @remarks
|
|
112781
112624
|
* [Api set: 1.1]
|
|
112782
112625
|
*/
|
|
112783
112626
|
select?: boolean;
|
|
112784
112627
|
/**
|
|
112628
|
+
* For EACH ITEM in the collection: Shape's text.
|
|
112785
112629
|
*
|
|
112786
|
-
*
|
|
112787
|
-
*
|
|
112630
|
+
* @remarks
|
|
112788
112631
|
* [Api set: 1.1]
|
|
112789
112632
|
*/
|
|
112790
112633
|
text?: boolean;
|
|
112791
112634
|
}
|
|
112792
112635
|
/**
|
|
112793
|
-
*
|
|
112794
112636
|
* Represents the Shape class.
|
|
112795
112637
|
*
|
|
112638
|
+
* @remarks
|
|
112796
112639
|
* [Api set: 1.1]
|
|
112797
112640
|
*/
|
|
112798
112641
|
interface ShapeLoadOptions {
|
|
@@ -112801,52 +112644,45 @@ declare namespace Visio {
|
|
|
112801
112644
|
*/
|
|
112802
112645
|
$all?: boolean;
|
|
112803
112646
|
/**
|
|
112804
|
-
*
|
|
112805
112647
|
* Returns the view of the shape.
|
|
112806
112648
|
*
|
|
112649
|
+
* @remarks
|
|
112807
112650
|
* [Api set: 1.1]
|
|
112808
112651
|
*/
|
|
112809
112652
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
112810
112653
|
/**
|
|
112654
|
+
* Shape's identifier.
|
|
112811
112655
|
*
|
|
112812
|
-
*
|
|
112813
|
-
*
|
|
112656
|
+
* @remarks
|
|
112814
112657
|
* [Api set: 1.1]
|
|
112815
112658
|
*/
|
|
112816
112659
|
id?: boolean;
|
|
112817
112660
|
/**
|
|
112661
|
+
* Shape's name.
|
|
112818
112662
|
*
|
|
112819
|
-
*
|
|
112820
|
-
*
|
|
112821
|
-
* [Api set: 1.1]
|
|
112822
|
-
*/
|
|
112823
|
-
isBoundToData?: boolean;
|
|
112824
|
-
/**
|
|
112825
|
-
*
|
|
112826
|
-
* Shape's name. Read-only.
|
|
112827
|
-
*
|
|
112663
|
+
* @remarks
|
|
112828
112664
|
* [Api set: 1.1]
|
|
112829
112665
|
*/
|
|
112830
112666
|
name?: boolean;
|
|
112831
112667
|
/**
|
|
112832
|
-
*
|
|
112833
112668
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112834
112669
|
*
|
|
112670
|
+
* @remarks
|
|
112835
112671
|
* [Api set: 1.1]
|
|
112836
112672
|
*/
|
|
112837
112673
|
select?: boolean;
|
|
112838
112674
|
/**
|
|
112675
|
+
* Shape's text.
|
|
112839
112676
|
*
|
|
112840
|
-
*
|
|
112841
|
-
*
|
|
112677
|
+
* @remarks
|
|
112842
112678
|
* [Api set: 1.1]
|
|
112843
112679
|
*/
|
|
112844
112680
|
text?: boolean;
|
|
112845
112681
|
}
|
|
112846
112682
|
/**
|
|
112847
|
-
*
|
|
112848
112683
|
* Represents the ShapeView class.
|
|
112849
112684
|
*
|
|
112685
|
+
* @remarks
|
|
112850
112686
|
* [Api set: 1.1]
|
|
112851
112687
|
*/
|
|
112852
112688
|
interface ShapeViewLoadOptions {
|
|
@@ -112855,17 +112691,17 @@ declare namespace Visio {
|
|
|
112855
112691
|
*/
|
|
112856
112692
|
$all?: boolean;
|
|
112857
112693
|
/**
|
|
112858
|
-
*
|
|
112859
112694
|
* Represents the highlight around the shape.
|
|
112860
112695
|
*
|
|
112696
|
+
* @remarks
|
|
112861
112697
|
* [Api set: 1.1]
|
|
112862
112698
|
*/
|
|
112863
112699
|
highlight?: boolean;
|
|
112864
112700
|
}
|
|
112865
112701
|
/**
|
|
112866
|
-
*
|
|
112867
112702
|
* Represents the ShapeDataItemCollection for a given Shape.
|
|
112868
112703
|
*
|
|
112704
|
+
* @remarks
|
|
112869
112705
|
* [Api set: 1.1]
|
|
112870
112706
|
*/
|
|
112871
112707
|
interface ShapeDataItemCollectionLoadOptions {
|
|
@@ -112874,38 +112710,38 @@ declare namespace Visio {
|
|
|
112874
112710
|
*/
|
|
112875
112711
|
$all?: boolean;
|
|
112876
112712
|
/**
|
|
112713
|
+
* For EACH ITEM in the collection: A string that specifies the format of the shape data item.
|
|
112877
112714
|
*
|
|
112878
|
-
*
|
|
112879
|
-
*
|
|
112715
|
+
* @remarks
|
|
112880
112716
|
* [Api set: 1.1]
|
|
112881
112717
|
*/
|
|
112882
112718
|
format?: boolean;
|
|
112883
112719
|
/**
|
|
112720
|
+
* For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.
|
|
112884
112721
|
*
|
|
112885
|
-
*
|
|
112886
|
-
*
|
|
112722
|
+
* @remarks
|
|
112887
112723
|
* [Api set: 1.1]
|
|
112888
112724
|
*/
|
|
112889
112725
|
formattedValue?: boolean;
|
|
112890
112726
|
/**
|
|
112727
|
+
* For EACH ITEM in the collection: A string that specifies the label of the shape data item.
|
|
112891
112728
|
*
|
|
112892
|
-
*
|
|
112893
|
-
*
|
|
112729
|
+
* @remarks
|
|
112894
112730
|
* [Api set: 1.1]
|
|
112895
112731
|
*/
|
|
112896
112732
|
label?: boolean;
|
|
112897
112733
|
/**
|
|
112734
|
+
* For EACH ITEM in the collection: A string that specifies the value of the shape data item.
|
|
112898
112735
|
*
|
|
112899
|
-
*
|
|
112900
|
-
*
|
|
112736
|
+
* @remarks
|
|
112901
112737
|
* [Api set: 1.1]
|
|
112902
112738
|
*/
|
|
112903
112739
|
value?: boolean;
|
|
112904
112740
|
}
|
|
112905
112741
|
/**
|
|
112906
|
-
*
|
|
112907
112742
|
* Represents the ShapeDataItem.
|
|
112908
112743
|
*
|
|
112744
|
+
* @remarks
|
|
112909
112745
|
* [Api set: 1.1]
|
|
112910
112746
|
*/
|
|
112911
112747
|
interface ShapeDataItemLoadOptions {
|
|
@@ -112914,38 +112750,38 @@ declare namespace Visio {
|
|
|
112914
112750
|
*/
|
|
112915
112751
|
$all?: boolean;
|
|
112916
112752
|
/**
|
|
112753
|
+
* A string that specifies the format of the shape data item.
|
|
112917
112754
|
*
|
|
112918
|
-
*
|
|
112919
|
-
*
|
|
112755
|
+
* @remarks
|
|
112920
112756
|
* [Api set: 1.1]
|
|
112921
112757
|
*/
|
|
112922
112758
|
format?: boolean;
|
|
112923
112759
|
/**
|
|
112760
|
+
* A string that specifies the formatted value of the shape data item.
|
|
112924
112761
|
*
|
|
112925
|
-
*
|
|
112926
|
-
*
|
|
112762
|
+
* @remarks
|
|
112927
112763
|
* [Api set: 1.1]
|
|
112928
112764
|
*/
|
|
112929
112765
|
formattedValue?: boolean;
|
|
112930
112766
|
/**
|
|
112767
|
+
* A string that specifies the label of the shape data item.
|
|
112931
112768
|
*
|
|
112932
|
-
*
|
|
112933
|
-
*
|
|
112769
|
+
* @remarks
|
|
112934
112770
|
* [Api set: 1.1]
|
|
112935
112771
|
*/
|
|
112936
112772
|
label?: boolean;
|
|
112937
112773
|
/**
|
|
112774
|
+
* A string that specifies the value of the shape data item.
|
|
112938
112775
|
*
|
|
112939
|
-
*
|
|
112940
|
-
*
|
|
112776
|
+
* @remarks
|
|
112941
112777
|
* [Api set: 1.1]
|
|
112942
112778
|
*/
|
|
112943
112779
|
value?: boolean;
|
|
112944
112780
|
}
|
|
112945
112781
|
/**
|
|
112946
|
-
*
|
|
112947
112782
|
* Represents the Hyperlink Collection.
|
|
112948
112783
|
*
|
|
112784
|
+
* @remarks
|
|
112949
112785
|
* [Api set: 1.1]
|
|
112950
112786
|
*/
|
|
112951
112787
|
interface HyperlinkCollectionLoadOptions {
|
|
@@ -112954,38 +112790,38 @@ declare namespace Visio {
|
|
|
112954
112790
|
*/
|
|
112955
112791
|
$all?: boolean;
|
|
112956
112792
|
/**
|
|
112793
|
+
* For EACH ITEM in the collection: Gets the address of the Hyperlink object.
|
|
112957
112794
|
*
|
|
112958
|
-
*
|
|
112959
|
-
*
|
|
112795
|
+
* @remarks
|
|
112960
112796
|
* [Api set: 1.1]
|
|
112961
112797
|
*/
|
|
112962
112798
|
address?: boolean;
|
|
112963
112799
|
/**
|
|
112800
|
+
* For EACH ITEM in the collection: Gets the description of a hyperlink.
|
|
112964
112801
|
*
|
|
112965
|
-
*
|
|
112966
|
-
*
|
|
112802
|
+
* @remarks
|
|
112967
112803
|
* [Api set: 1.1]
|
|
112968
112804
|
*/
|
|
112969
112805
|
description?: boolean;
|
|
112970
112806
|
/**
|
|
112807
|
+
* For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
112971
112808
|
*
|
|
112972
|
-
*
|
|
112973
|
-
*
|
|
112809
|
+
* @remarks
|
|
112974
112810
|
* [Api set: 1.1]
|
|
112975
112811
|
*/
|
|
112976
112812
|
extraInfo?: boolean;
|
|
112977
112813
|
/**
|
|
112814
|
+
* For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.
|
|
112978
112815
|
*
|
|
112979
|
-
*
|
|
112980
|
-
*
|
|
112816
|
+
* @remarks
|
|
112981
112817
|
* [Api set: 1.1]
|
|
112982
112818
|
*/
|
|
112983
112819
|
subAddress?: boolean;
|
|
112984
112820
|
}
|
|
112985
112821
|
/**
|
|
112986
|
-
*
|
|
112987
112822
|
* Represents the Hyperlink.
|
|
112988
112823
|
*
|
|
112824
|
+
* @remarks
|
|
112989
112825
|
* [Api set: 1.1]
|
|
112990
112826
|
*/
|
|
112991
112827
|
interface HyperlinkLoadOptions {
|
|
@@ -112994,38 +112830,38 @@ declare namespace Visio {
|
|
|
112994
112830
|
*/
|
|
112995
112831
|
$all?: boolean;
|
|
112996
112832
|
/**
|
|
112833
|
+
* Gets the address of the Hyperlink object.
|
|
112997
112834
|
*
|
|
112998
|
-
*
|
|
112999
|
-
*
|
|
112835
|
+
* @remarks
|
|
113000
112836
|
* [Api set: 1.1]
|
|
113001
112837
|
*/
|
|
113002
112838
|
address?: boolean;
|
|
113003
112839
|
/**
|
|
112840
|
+
* Gets the description of a hyperlink.
|
|
113004
112841
|
*
|
|
113005
|
-
*
|
|
113006
|
-
*
|
|
112842
|
+
* @remarks
|
|
113007
112843
|
* [Api set: 1.1]
|
|
113008
112844
|
*/
|
|
113009
112845
|
description?: boolean;
|
|
113010
112846
|
/**
|
|
112847
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
113011
112848
|
*
|
|
113012
|
-
*
|
|
113013
|
-
*
|
|
112849
|
+
* @remarks
|
|
113014
112850
|
* [Api set: 1.1]
|
|
113015
112851
|
*/
|
|
113016
112852
|
extraInfo?: boolean;
|
|
113017
112853
|
/**
|
|
112854
|
+
* Gets the sub-address of the Hyperlink object.
|
|
113018
112855
|
*
|
|
113019
|
-
*
|
|
113020
|
-
*
|
|
112856
|
+
* @remarks
|
|
113021
112857
|
* [Api set: 1.1]
|
|
113022
112858
|
*/
|
|
113023
112859
|
subAddress?: boolean;
|
|
113024
112860
|
}
|
|
113025
112861
|
/**
|
|
113026
|
-
*
|
|
113027
112862
|
* Represents the CommentCollection for a given Shape.
|
|
113028
112863
|
*
|
|
112864
|
+
* @remarks
|
|
113029
112865
|
* [Api set: 1.1]
|
|
113030
112866
|
*/
|
|
113031
112867
|
interface CommentCollectionLoadOptions {
|
|
@@ -113034,31 +112870,31 @@ declare namespace Visio {
|
|
|
113034
112870
|
*/
|
|
113035
112871
|
$all?: boolean;
|
|
113036
112872
|
/**
|
|
113037
|
-
*
|
|
113038
112873
|
* For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
|
|
113039
112874
|
*
|
|
112875
|
+
* @remarks
|
|
113040
112876
|
* [Api set: 1.1]
|
|
113041
112877
|
*/
|
|
113042
112878
|
author?: boolean;
|
|
113043
112879
|
/**
|
|
113044
|
-
*
|
|
113045
112880
|
* For EACH ITEM in the collection: A string that specifies the date when the comment was created.
|
|
113046
112881
|
*
|
|
112882
|
+
* @remarks
|
|
113047
112883
|
* [Api set: 1.1]
|
|
113048
112884
|
*/
|
|
113049
112885
|
date?: boolean;
|
|
113050
112886
|
/**
|
|
113051
|
-
*
|
|
113052
112887
|
* For EACH ITEM in the collection: A string that contains the comment text.
|
|
113053
112888
|
*
|
|
112889
|
+
* @remarks
|
|
113054
112890
|
* [Api set: 1.1]
|
|
113055
112891
|
*/
|
|
113056
112892
|
text?: boolean;
|
|
113057
112893
|
}
|
|
113058
112894
|
/**
|
|
113059
|
-
*
|
|
113060
112895
|
* Represents the Comment.
|
|
113061
112896
|
*
|
|
112897
|
+
* @remarks
|
|
113062
112898
|
* [Api set: 1.1]
|
|
113063
112899
|
*/
|
|
113064
112900
|
interface CommentLoadOptions {
|
|
@@ -113067,23 +112903,23 @@ declare namespace Visio {
|
|
|
113067
112903
|
*/
|
|
113068
112904
|
$all?: boolean;
|
|
113069
112905
|
/**
|
|
113070
|
-
*
|
|
113071
112906
|
* A string that specifies the name of the author of the comment.
|
|
113072
112907
|
*
|
|
112908
|
+
* @remarks
|
|
113073
112909
|
* [Api set: 1.1]
|
|
113074
112910
|
*/
|
|
113075
112911
|
author?: boolean;
|
|
113076
112912
|
/**
|
|
113077
|
-
*
|
|
113078
112913
|
* A string that specifies the date when the comment was created.
|
|
113079
112914
|
*
|
|
112915
|
+
* @remarks
|
|
113080
112916
|
* [Api set: 1.1]
|
|
113081
112917
|
*/
|
|
113082
112918
|
date?: boolean;
|
|
113083
112919
|
/**
|
|
113084
|
-
*
|
|
113085
112920
|
* A string that contains the comment text.
|
|
113086
112921
|
*
|
|
112922
|
+
* @remarks
|
|
113087
112923
|
* [Api set: 1.1]
|
|
113088
112924
|
*/
|
|
113089
112925
|
text?: boolean;
|
|
@@ -113119,19 +112955,12 @@ declare namespace Visio {
|
|
|
113119
112955
|
* Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
113120
112956
|
* @param contextObject - A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context.
|
|
113121
112957
|
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in.
|
|
113122
|
-
* @remarks
|
|
113123
|
-
* In addition to this signature, the method also has the following signatures:
|
|
113124
|
-
*
|
|
113125
|
-
* `run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113126
|
-
*
|
|
113127
|
-
* `run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113128
|
-
*
|
|
113129
|
-
* `run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113130
112958
|
*/
|
|
113131
112959
|
function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
113132
112960
|
}
|
|
113133
112961
|
|
|
113134
112962
|
|
|
112963
|
+
|
|
113135
112964
|
////////////////////////////////////////////////////////////////
|
|
113136
112965
|
//////////////////////// End Visio APIs ////////////////////////
|
|
113137
112966
|
////////////////////////////////////////////////////////////////
|