Creating and Settings Up Event Handler

Event handler is a unit created on the Fore language or an assembly created on the Fore.NET language. Event handler provides a possibility to set actions when a particular event occurs enhancing functionalities of the workspace.

Creating Event Handler Automatically

After executing those actions, the standard dialog box to select object in object navigator opens:

Created unit or assembly contain ready structure where there are all events for workspace:

Class EventsClass: WorkspaceEvents
    Public Sub OnBeforeOpenWorkspace(WorkspaceArgs: IUiWorkspaceCancelEventArgs);
    Begin
    End Sub OnBeforeOpenWorkspace;

    Public Sub OnBeforePrintWorkspace(WorkspaceArgs: IUiWorkspaceCancelEventArgs);
    Begin
    End Sub OnBeforePrintWorkspace;

    Public Sub OnAfterPrintWorkspace(WorkspaceArgs: IUiWorkspaceEventArgs);
    Begin
    End Sub OnAfterPrintWorkspace;

    Public Sub OnBeforeExportWorkspace(WorkspaceArgs: IUiWorkspaceExportCancelEventArgs);
    Begin
    End Sub OnBeforeExportWorkspace;

    Public Sub OnAfterExportWorkspace(WorkspaceArgs: IUiWorkspaceExportEventArgs);
    Begin
    End Sub OnAfterExportWorkspace;

    Public Sub OnBeforeSaveWorkspace(WorkspaceArgs: IUiWorkspaceCancelEventArgs);
    Begin
    End Sub OnBeforeSaveWorkspace;

    Public Sub OnBeforeCreateShape(WorkspaceArgs: IUiWorkspaceShapeCancelEventArgs);
    Begin
    End Sub OnBeforeCreateShape;

    Public Sub OnAfterCreateShape(WorkspaceArgs: IUiWorkspaceShapeEventArgs);
    Begin
    End Sub OnAfterCreateShape;

    Public Sub OnBeforeDeleteShape(WorkspaceArgs: IUiWorkspaceShapeCancelEventArgs);
    Begin
    End Sub OnBeforeDeleteShape;

    Public Sub OnAfterDeleteShape(WorkspaceArgs: IUiWorkspaceShapeEventArgs);
    Begin
    End Sub OnAfterDeleteShape;

End Class EventsClass;

Imports Prognoz.Platform.Interop.Workspace;

Public Class EventsClass: IWxUserEvents

Public Sub OnBeforeOpenWorkspace(Args : UiWorkspaceCancelEventArgs);
Begin
End Sub OnBeforeOpenWorkspace;

Public Sub OnBeforePrintWorkspace(Args : UiWorkspaceCancelEventArgs);
Begin
End Sub OnBeforePrintWorkspace;

Public Sub OnAfterPrintWorkspace(Args : UiWorkspaceEventArgs);
Begin
End Sub OnAfterPrintWorkspace;

Public Sub OnBeforeExportWorkspace(Args : UiWorkspaceExportCancelEventArgs);
Begin
End Sub OnBeforeExportWorkspace;

Public Sub OnAfterExportWorkspace(Args : UiWorkspaceExportEventArgs);
Begin
End Sub OnAfterExportWorkspace;

Public Sub OnBeforeSaveWorkspace(Args : UiWorkspaceCancelEventArgs);
Begin
End Sub OnBeforeSaveWorkspace;

Public Sub OnBeforeCreateShape(Args : UiWorkspaceShapeCancelEventArgs);
Begin
End Sub OnBeforeCreateShape;

Public Sub OnAfterCreateShape(Args : UiWorkspaceShapeEventArgs);
Begin
End Sub OnAfterCreateShape;

Public Sub OnBeforeDeleteShape(Args : UiWorkspaceShapeCancelEventArgs);
Begin
End Sub OnBeforeDeleteShape;

Public Sub OnAfterDeleteShape(Args : UiWorkspaceShapeEventArgs);
Begin
End Sub OnAfterDeleteShape;

End Class EventsClass;

Connecting Event Handler

To connect event handler, select the Event Handler > Setup item on the Home ribbon tab:

In the opened dialog box select unit and class where an event handler is situated:

To set up and edit events in the development environment? click the Open in Development Environment button.

Example of Unit

Executing the example requires that the unit contains the Eventclass class. Add links to the Ui, Workspace system assemblies.

Class EventsClass: WorkspaceEvents
Public Sub OnBeforeOpenWorkspace(Args: IUiWorkspaceCancelEventArgs);
Begin
Winapplication.InformationBox("Message before opening a workspace");
Args.Cancel := False;
End Sub OnBeforeOpenWorkspace;
End Class EventsClass;

After event handler processing, before the workspace opens, the Message Before Opening a Workspace is displayed.