This outgoing interface defines the events which are fired by the Application Integration Add-in infrastructure while executing commands. Client applications implement an event sink interface to handle these events. The client application is also responsible for providing implementations of the event handlers. Note that for Visual Basic clients of the ExpressAddin, the event sink is handled internally by the VB framework.
Each FileNet Application Integration command that is supported for use by the ExpressAddin component has a corresponding set of event handlers. For every command that an Add-In application intends to execute, the application must provide these valid event handlers in order to manage the events fired by the command. The Add-In Sample Application demonstrates how to implement the event sink and basic event handlers. For more information about the event sink and event handler methods, see Implementing an Event Sink and Event Handlers.
coclass ExpressAddin {
[default] interface IExpressAddin;
[default,source] dispinterface _IExpressAddinEvents;
};
DLL | FnAppIntExpressAddin.dll |
See Also | IExpressAddin Interface and the Add-In Sample Application |
The IExpressAddinEvents interface defines the following event handler methods:
Method | Description |
---|---|
OnAppBeginWaitCursor |
Displays the application's wait cursor. |
OnAppCloseActiveDocument |
Closes the currently active document. |
OnAppEndWaitCursor |
Stops displaying the application's wait cursor. |
OnAppGetActiveDocumentPath |
Returns the path to the currently active document. |
OnAppExistsActiveDocument |
Returns whether the application has a currently active document. |
OnAppInsertHyperlink |
Inserts a specified hyperlink to an object store item into the currently active document. |
OnAppIsActiveDocumentModified |
Returns whether the currently active document has been modified since it became active. |
OnAppIsActiveDocumentNew |
Returns whether the currently active document is a new document which has never before been saved. |
OnAppSaveModifiedActiveDocument |
Saves the currently active, modified document. |
OnAppSaveNewActiveDocument |
Saves the currently active, new document. |
OnAppOpenDocument |
Causes the application to natively open the specified document. When not overridden, the application will open the document in the Microsoft® Windows operating system shell instead. |
For an example of how to implement this interface and its methods in C++, see the Add-In Sample Application.