Event class documentation

This commit is contained in:
Alex Jerabek
2018-06-06 16:57:10 -07:00
parent 5abd03748f
commit 3d26b490c5
+18 -2
View File
@@ -523,7 +523,7 @@ declare namespace Office {
*/
name: string;
}
export namespace AddinCommands {
namespace AddinCommands {
/**
* The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify which button was clicked and to signal the host that it has completed its processing.
*
@@ -539,8 +539,13 @@ declare namespace Office {
*
* Applicable Outlook mode: Compose or Read
*/
export interface Event {
interface Event {
/**
* Information about the control that triggered calling this function
*/
source:Source;
/**
* Indicates that the add-in has completed processing that was triggered by an add-in command button or event handler.
*
@@ -561,6 +566,17 @@ declare namespace Office {
*/
completed(options?: any): void;
}
/**
* Encapsulates source data for add-in events.
*/
interface Source {
/**
* The id of the control that triggered calling this function. The id comes from the manifest and is the unique ID of your Office Add-in as a GUID.
*/
id: string;
}
}
/**
* Provides objects and methods that you can use to create and manipulate UI components, such as dialog boxes, in your Office Add-ins.