Skip to content

Commit a355d17

Browse files
[office-js][office-js-preview] (Dialog) Add a link to conceptual article (DefinitelyTyped#73610)
1 parent 60c5021 commit a355d17

File tree

2 files changed

+38
-20
lines changed

2 files changed

+38
-20
lines changed

types/office-js-preview/index.d.ts

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -611,19 +611,28 @@ declare namespace Office {
611611
*/
612612
BindingSelectionChanged,
613613
/**
614-
* Triggers when Dialog has an event, such as dialog closed or dialog navigation failed.
614+
* Occurs when a dialog is closed or when dialog navigation failed.
615+
*
616+
* For guidance on how to implement a dialog in your add-in, see
617+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
615618
*/
616619
DialogEventReceived,
617620
/**
618-
* Triggers when a dialog sends a message via `messageParent`.
621+
* Occurs when a dialog sends a message using `Office.context.ui.messageParent`.
622+
*
623+
* For guidance on how to implement a dialog in your add-in, see
624+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
619625
*/
620626
DialogMessageReceived,
621627
/**
622-
* Triggers when a host page sends a message to a child dialog box with `messageChild`.
628+
* Occurs when a host page sends a message to a child dialog box with `Dialog.messageChild`.
629+
*
630+
* For guidance on how to implement a dialog in your add-in, see
631+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
623632
*/
624633
DialogParentMessageReceived,
625634
/**
626-
* Triggers when a document-level selection happens in Excel or Word.
635+
* Occurs when a document-level selection happens in Excel or Word.
627636
*/
628637
DocumentSelectionChanged,
629638
/**
@@ -699,15 +708,15 @@ declare namespace Office {
699708
*/
700709
DragAndDropEvent,
701710
/**
702-
* Triggers when a `customXmlPart` node is deleted.
711+
* Occurs when a `customXmlPart` node is deleted.
703712
*/
704713
NodeDeleted,
705714
/**
706-
* Triggers when a `customXmlPart` node is inserted.
715+
* Occurs when a `customXmlPart` node is inserted.
707716
*/
708717
NodeInserted,
709718
/**
710-
* Triggers when a `customXmlPart` node is replaced.
719+
* Occurs when a `customXmlPart` node is replaced.
711720
*/
712721
NodeReplaced,
713722
/**
@@ -752,7 +761,7 @@ declare namespace Office {
752761
*/
753762
RecurrenceChanged,
754763
/**
755-
* Triggers when a Resource selection happens in Project.
764+
* Occurs when a Resource selection happens in Project.
756765
*/
757766
ResourceSelectionChanged,
758767
/**
@@ -789,11 +798,11 @@ declare namespace Office {
789798
*/
790799
SpamReporting,
791800
/**
792-
* Triggers when a Task selection happens in Project.
801+
* Occurs when a Task selection happens in Project.
793802
*/
794803
TaskSelectionChanged,
795804
/**
796-
* Triggers when a View selection happens in Project.
805+
* Occurs when a View selection happens in Project.
797806
*/
798807
ViewSelectionChanged
799808
}

types/office-js/index.d.ts

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -611,19 +611,28 @@ declare namespace Office {
611611
*/
612612
BindingSelectionChanged,
613613
/**
614-
* Triggers when Dialog has an event, such as dialog closed or dialog navigation failed.
614+
* Occurs when a dialog is closed or when dialog navigation failed.
615+
*
616+
* For guidance on how to implement a dialog in your add-in, see
617+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
615618
*/
616619
DialogEventReceived,
617620
/**
618-
* Triggers when a dialog sends a message via `messageParent`.
621+
* Occurs when a dialog sends a message using `Office.context.ui.messageParent`.
622+
*
623+
* For guidance on how to implement a dialog in your add-in, see
624+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
619625
*/
620626
DialogMessageReceived,
621627
/**
622-
* Triggers when a host page sends a message to a child dialog box with `messageChild`.
628+
* Occurs when a host page sends a message to a child dialog box with `Dialog.messageChild`.
629+
*
630+
* For guidance on how to implement a dialog in your add-in, see
631+
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/dialog-api-in-office-add-ins | Use the Office dialog API in Office Add-ins}.
623632
*/
624633
DialogParentMessageReceived,
625634
/**
626-
* Triggers when a document-level selection happens in Excel or Word.
635+
* Occurs when a document-level selection happens in Excel or Word.
627636
*/
628637
DocumentSelectionChanged,
629638
/**
@@ -699,15 +708,15 @@ declare namespace Office {
699708
*/
700709
DragAndDropEvent,
701710
/**
702-
* Triggers when a `customXmlPart` node is deleted.
711+
* Occurs when a `customXmlPart` node is deleted.
703712
*/
704713
NodeDeleted,
705714
/**
706-
* Triggers when a `customXmlPart` node is inserted.
715+
* Occurs when a `customXmlPart` node is inserted.
707716
*/
708717
NodeInserted,
709718
/**
710-
* Triggers when a `customXmlPart` node is replaced.
719+
* Occurs when a `customXmlPart` node is replaced.
711720
*/
712721
NodeReplaced,
713722
/**
@@ -752,7 +761,7 @@ declare namespace Office {
752761
*/
753762
RecurrenceChanged,
754763
/**
755-
* Triggers when a Resource selection happens in Project.
764+
* Occurs when a Resource selection happens in Project.
756765
*/
757766
ResourceSelectionChanged,
758767
/**
@@ -789,11 +798,11 @@ declare namespace Office {
789798
*/
790799
SpamReporting,
791800
/**
792-
* Triggers when a Task selection happens in Project.
801+
* Occurs when a Task selection happens in Project.
793802
*/
794803
TaskSelectionChanged,
795804
/**
796-
* Triggers when a View selection happens in Project.
805+
* Occurs when a View selection happens in Project.
797806
*/
798807
ViewSelectionChanged
799808
}

0 commit comments

Comments
 (0)