Event Repository (Magic xpa 3.x)
You can access the Event repository by selecting User Events from the Task menu or pressing Ctrl+U.
In each task you can define user-defined events to be handled in your project whenever these events are raised or triggered.
A user-defined event is a logical definition of an occurrence. For example, you can define an event called ‘Add Customer’. The event definition by itself will not effect the project. This logical definition allows you to define the handling for such a logical occurrence.
The Event repository includes the following columns:
|
|
|
|
Description
|
This is a descriptive name of the event. The event name is used to select this event when a handler is defined for it.
|
|
Trigger Type
|
This is the pre-defined event type you wish to be used as a trigger for an event.
The available options for this property are System, Internal, Time, Expression, and None.
When the trigger type is set to None (i.e. No trigger), this event can only be raised through the Raise Event operation.
See also How Do I Map Keyboard Strokes to Magic xpa Internal Events?
|
|
Trigger
|
The actual value that triggers the event. You can use this column to set a different event that will automatically trigger your User event. This property only applies when you have set a trigger type other than None. In this column, you can zoom to define the event you wish to trigger.
-
For a System event, the Key Definition dialog box appears for you to enter the key combination to trigger the event.
-
For an Internal event, the Magic xpa Event list appears.
-
For a Timer event, you can set the time interval.
-
For an Expression event, you can zoom to the Expression Editor to define or select the required expression.
If you do not need a trigger for the User event, set the trigger type to None.
If None is set as a trigger, the user-defined event can only be raised by a Raise Event operation.
|
|
Parameters
|
You can define data attributes that can be used to pass data values back and forth between the application and user-defined event. This column shows the number of defined parameters. Zooming from this field opens the Event Parameters window, where you can define any number of required parameters.
You can pass arguments along with the Raise Event operation on triggering an event. The passed argument values are received by the parameter variables defined in the corresponding logic unit.
When creating a new logic unit for a User event, on selecting a User event set with parameter definitions, the Studio prompts you with the option of automatically creating the parameter variables in the logic unit according to the parameter definitions of the selected User event.
|
|
Force Exit
|
This property allows you to define the level from which the Magic xpa engine will exit before handling the event. For more information, click here.
|
|
Public Name
|
This is available for the Main Program only. For the Main Program, you are required to provide a public name for the user event because Magic xpa will use the public name of the user event and not of the program when searching for a corresponding handler.
|
|
Expose
|
This is available for the Main Program only. Select this check box to expose the event.
When using the Raise Public Event operation from a component or from a Rich Client task, only exposed events can be raised.
|
Note: In the Event repository, Magic xpa enables you to define the trigger type and value, which will raise the event. In some cases, the event should be raised according to the application logic, regardless of whether the trigger is specified in the Event repository. In those cases, you can use the Raise Event operation to trigger the event.
