From .NET, we have two approaches available for connecting to COM events.<\/P>
- Delegate Event Model<\/LI>
- Connection Point Model<\/LI><\/OL>
Delegate Event Model<\/STRONG><\/U><\/P>
The delegate event model is typically more natural to .NET developers. This approach allows you to handle specific events rather than every event that an event set exposes.<\/P>
If you open the Object Browser and search for ISEApplicationEvents<\/STRONG><\/EM>, you will see the raw interface definition. This raw interface is not what we need in the delegate event model.<\/P>
<\/P>
There is a hidden class that is generated by the type library importer named ISEApplicationEvents_Event<\/STRONG> <\/EM>that we need to leverage in this approach. In order to see the hidden class ISEApplicationEvents_Event<\/STRONG><\/EM>, modify the Object Browser settings as shown below to Show Hidden Types And Members<\/STRONG><\/EM>.<\/P>
<\/P>
With the Object Browser settings in place, now search for ISEApplicationEvents_Event<\/STRONG>. <\/EM><\/P>
<\/P>
Now that we are aware that ISEApplicationEvents_Event<\/STRONG> <\/EM>exists, we can leverage it with the following sample code. Please note that the code below is for demonstration purposes only and does not handle situations like when the BeforeQuit event is raised.<\/P>
*Note that the ISEApplicationEvents_Event class will not be available in the code editor intellisense since it is a hidden class. You will have to manually type the full name and it will resolve.<\/STRONG><\/EM><\/P>
Visual Basic – Delegate Event Model Example<\/STRONG><\/P>
Imports System
\nImports System.Runtime.InteropServices
\nImports System.Windows.Forms<\/p>\nNamespace EventTest
\n Partial Public Class Form1
\n Inherits Form<\/p>\nPrivate _application As SolidEdgeFramework.Application
\n Private _applicationEvents As SolidEdgeFramework.ISEApplicationEvents_Event<\/p>\nPublic Sub New()
\n InitializeComponent()
\n End Sub<\/p>\nPrivate Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
\n ‘ Connect to Solid Edge.
\n _application = DirectCast(Marshal.GetActiveObject(“SolidEdge.Application”), SolidEdgeFramework.Application)<\/p>\n‘ Connect to application events.
\n _applicationEvents = CType(_application.ApplicationEvents, SolidEdgeFramework.ISEApplicationEvents_Event)
\n AddHandler _applicationEvents.AfterDocumentSave, AddressOf _applicationEvents_AfterDocumentSave
\n AddHandler _applicationEvents.BeforeDocumentSave, AddressOf _applicationEvents_BeforeDocumentSave
\n End Sub<\/p>\nPrivate Sub _applicationEvents_AfterDocumentSave(ByVal theDocument As Object)
\n ‘ Handle AfterDocumentSave.
\n End Sub<\/p>\nPrivate Sub _applicationEvents_BeforeDocumentSave(ByVal theDocument As Object)
\n ‘ Handle BeforeDocumentSave.
\n End Sub<\/p>\nPrivate Sub Form1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs)
\n ‘ Disconnect to application events.
\n RemoveHandler _applicationEvents.BeforeDocumentSave, AddressOf _applicationEvents_BeforeDocumentSave
\n RemoveHandler _applicationEvents.AfterDocumentSave, AddressOf _applicationEvents_AfterDocumentSave
\n _applicationEvents = Nothing
\n End Sub
\n End Class
\nEnd Namespace<\/PRE>C# – Event Delegate Model Example<\/STRONG><\/P>
using System;
\nusing System.Runtime.InteropServices;
\nusing System.Windows.Forms;<\/p>\nnamespace EventTest
\n{
\n public partial class Form1 : Form
\n {
\n private SolidEdgeFramework.Application _application;
\n private SolidEdgeFramework.ISEApplicationEvents_Event _applicationEvents;<\/p>\npublic Form1()
\n {
\n InitializeComponent();
\n }<\/p>\nprivate void Form1_Load(object sender, EventArgs e)
\n {
\n \/\/ Connect to Solid Edge.
\n _application = (SolidEdgeFramework.Application)Marshal.GetActiveObject(“SolidEdge.Application”);<\/p>\n\/\/ Connect to application events.
\n _applicationEvents = (SolidEdgeFramework.ISEApplicationEvents_Event)_application.ApplicationEvents;
\n _applicationEvents.AfterDocumentSave += _applicationEvents_AfterDocumentSave;
\n _applicationEvents.BeforeDocumentSave += _applicationEvents_BeforeDocumentSave;
\n }<\/p>\nvoid _applicationEvents_AfterDocumentSave(object theDocument)
\n {
\n \/\/ Handle AfterDocumentSave.
\n }<\/p>\nvoid _applicationEvents_BeforeDocumentSave(object theDocument)
\n {
\n \/\/ Handle BeforeDocumentSave.
\n }<\/p>\nprivate void Form1_FormClosing(object sender, FormClosingEventArgs e)
\n {
\n \/\/ Disconnect to application events.
\n _applicationEvents.BeforeDocumentSave -= _applicationEvents_BeforeDocumentSave;
\n _applicationEvents.AfterDocumentSave -= _applicationEvents_AfterDocumentSave;
\n _applicationEvents = null;
\n }
\n }
\n}<\/PRE>Connection Point Model<\/STRONG><\/U><\/P>
The Connection Point Model is a more raw, manual approach to handling events. It involves having a class implement an event interface, ISEApplicationEvents in this case. This means you will be handling every event that a particular event set raises.<\/P>
In order to do this from .NET, we will need to leverage the IConnectionPointContainer<\/STRONG><\/EM> and IConnectionPoint<\/STRONG><\/EM> interfaces from the System.Runtime.InteropServices.ComTypes<\/STRONG><\/EM> namespace.<\/P>
Visual Basic – Connection Point Model Example<\/STRONG><\/P>
Option Infer On<\/p>\n
Imports System
\nImports System.Runtime.InteropServices
\nImports System.Runtime.InteropServices.ComTypes
\nImports System.Windows.Forms<\/p>\nNamespace EventTest
\n Partial Public Class Form1
\n Inherits Form
\n Implements SolidEdgeFramework.ISEApplicationEvents<\/p>\nPrivate _application As SolidEdgeFramework.Application
\n Private _connectionPoint As IConnectionPoint
\n Private _cookie As Integer<\/p>\nPublic Sub New()
\n InitializeComponent()
\n End Sub<\/p>\nPrivate Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
\n ‘ Connect to Solid Edge.
\n _application = DirectCast(Marshal.GetActiveObject(“SolidEdge.Application”), SolidEdgeFramework.Application)<\/p>\nConnectEvents()
\n End Sub<\/p>\nPrivate Sub Form1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs)
\n DisconnectEvents()
\n End Sub<\/p>\nPrivate Sub ConnectEvents()
\n ‘ Get the event GUID.
\n Dim typeGuid = GetType(SolidEdgeFramework.ISEApplicationEvents).GUID<\/p>\n‘ Get a reference to the IConnectionPointContainer.
\n Dim container As IConnectionPointContainer = DirectCast(_application, IConnectionPointContainer)<\/p>\n‘ Lookup the IConnectionPoint.
\n container.FindConnectionPoint(typeGuid, _connectionPoint)<\/p>\n‘ Advise the sink.
\n _connectionPoint.Advise(Me, _cookie)
\n End Sub<\/p>\nPrivate Sub DisconnectEvents()
\n ‘ Unadvise the sink.
\n _connectionPoint.Unadvise(_cookie)<\/p>\n‘ Clear variables.
\n _cookie = 0
\n _connectionPoint = Nothing
\n End Sub<\/p>\n#Region “ISEApplicationEvents”<\/p>\n
Public Sub AfterActiveDocumentChange(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub AfterCommandRun(ByVal theCommandID As Integer)
\n End Sub<\/p>\nPublic Sub AfterDocumentOpen(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub AfterDocumentPrint(ByVal theDocument As Object, ByVal hDC As Integer, ByRef ModelToDC As Double, ByRef Rect As Integer)
\n End Sub<\/p>\nPublic Sub AfterDocumentSave(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub AfterEnvironmentActivate(ByVal theEnvironment As Object)
\n End Sub<\/p>\nPublic Sub AfterNewDocumentOpen(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub AfterNewWindow(ByVal theWindow As Object)
\n End Sub<\/p>\nPublic Sub AfterWindowActivate(ByVal theWindow As Object)
\n End Sub<\/p>\nPublic Sub BeforeCommandRun(ByVal theCommandID As Integer)
\n End Sub<\/p>\nPublic Sub BeforeDocumentClose(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub BeforeDocumentPrint(ByVal theDocument As Object, ByVal hDC As Integer, ByRef ModelToDC As Double, ByRef Rect As Integer)
\n End Sub<\/p>\nPublic Sub BeforeDocumentSave(ByVal theDocument As Object)
\n End Sub<\/p>\nPublic Sub BeforeEnvironmentDeactivate(ByVal theEnvironment As Object)
\n End Sub<\/p>\nPublic Sub BeforeQuit()
\n End Sub<\/p>\nPublic Sub BeforeWindowDeactivate(ByVal theWindow As Object)
\n End Sub<\/p>\n#End Region
\n End Class
\nEnd Namespace<\/PRE>C# – Connection Point Model Example<\/STRONG><\/P>
using System;
\nusing System.Runtime.InteropServices;
\nusing System.Runtime.InteropServices.ComTypes;
\nusing System.Windows.Forms;<\/p>\nnamespace EventTest
\n{
\n public partial class Form1 : Form, SolidEdgeFramework.ISEApplicationEvents
\n {
\n private SolidEdgeFramework.Application _application;
\n private IConnectionPoint _connectionPoint;
\n private int _cookie;<\/p>\npublic Form1()
\n {
\n InitializeComponent();
\n }<\/p>\nprivate void Form1_Load(object sender, EventArgs e)
\n {
\n \/\/ Connect to Solid Edge.
\n _application = (SolidEdgeFramework.Application)Marshal.GetActiveObject(“SolidEdge.Application”);<\/p>\nConnectEvents();
\n }<\/p>\nprivate void Form1_FormClosing(object sender, FormClosingEventArgs e)
\n {
\n DisconnectEvents();
\n }<\/p>\nprivate void ConnectEvents()
\n {
\n \/\/ Get the event GUID.
\n var typeGuid = typeof(SolidEdgeFramework.ISEApplicationEvents).GUID;<\/p>\n\/\/ Get a reference to the IConnectionPointContainer.
\n IConnectionPointContainer container = (IConnectionPointContainer)_application;<\/p>\n\/\/ Lookup the IConnectionPoint.
\n container.FindConnectionPoint(ref typeGuid, out _connectionPoint);<\/p>\n\/\/ Advise the sink.
\n _connectionPoint.Advise(this, out _cookie);
\n }<\/p>\nprivate void DisconnectEvents()
\n {
\n \/\/ Unadvise the sink.
\n _connectionPoint.Unadvise(_cookie);<\/p>\n\/\/ Clear variables.
\n _cookie = 0;
\n _connectionPoint = null;
\n }<\/p>\n#region ISEApplicationEvents<\/p>\n
public void AfterActiveDocumentChange(object theDocument)
\n {
\n }<\/p>\npublic void AfterCommandRun(int theCommandID)
\n {
\n }<\/p>\npublic void AfterDocumentOpen(object theDocument)
\n {
\n }<\/p>\npublic void AfterDocumentPrint(object theDocument, int hDC, ref double ModelToDC, ref int Rect)
\n {
\n }<\/p>\npublic void AfterDocumentSave(object theDocument)
\n {
\n }<\/p>\npublic void AfterEnvironmentActivate(object theEnvironment)
\n {
\n }<\/p>\npublic void AfterNewDocumentOpen(object theDocument)
\n {
\n }<\/p>\npublic void AfterNewWindow(object theWindow)
\n {
\n }<\/p>\npublic void AfterWindowActivate(object theWindow)
\n {
\n }<\/p>\npublic void BeforeCommandRun(int theCommandID)
\n {
\n }<\/p>\npublic void BeforeDocumentClose(object theDocument)
\n {
\n }<\/p>\npublic void BeforeDocumentPrint(object theDocument, int hDC, ref double ModelToDC, ref int Rect)
\n {
\n }<\/p>\npublic void BeforeDocumentSave(object theDocument)
\n {
\n }<\/p>\npublic void BeforeEnvironmentDeactivate(object theEnvironment)
\n {
\n }<\/p>\npublic void BeforeQuit()
\n {
\n }<\/p>\npublic void BeforeWindowDeactivate(object theWindow)
\n {
\n }<\/p>\n#endregion
\n }
\n}<\/PRE>