Creating and Settings Up Event Handler

Event handler is a Fore unit. Event handler provides a possibility to set actions when a particular event occurs enhancing functionalities of the workspace.

NOTE. Setting event handler is available only in the desktop application.

Creating Event Handler Automatically

To create an event handler, select the Event Handler > Create > Create Fore Unit item on the Home ribbon tab.

An event handler can also be created in the Event Handling dialog box. Select the Event Handler > Setup item on the Home ribbon tab. In the dialog box that opens select the Create > Create Fore Unit item.

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

The created unit or assembly contain ready structure with all workspace events.

Example of Unit

Copy example

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;

Connecting Event Handler

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

In the dialog box that opens select unit and class where an event handler is located:

1. Select a Fore unit containing a class with the event handler in the Unit box. One can select an object in the drop-down list or click the icon and enter object name. To remove the object from the box, click the button.

2. In the Class box select class containing event handler. One can select a class in the drop-down list or click the icon and enter class name. To remove the class from the box, click the button.

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

Example of Unit

Executing the example requires that the unit contains the Eventclass class.

Add links to the Ui and Workspace system assemblies.

Copy example

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

As a result of event handler work, the specific message is displayed before opening the workspace.

See also:

Building a Workspace

Copy page URL

Back to top

To report a found bug, please, select the text with the bug and click Report a Bug or CTRL+ENTER.

Help system 10.5 of 04/10/2024, © FORESIGHT