Wait - Raise Event Operation (Magic xpa 4.x)
The Wait property indicates whether the event handler or trigger should be performed immediately or placed at the end of the event queue. The default setting for all events, with the exception of Internal, is Yes. The default value for Internal events is No.
The Wait property has three possible options:
-
Yes – The event will be invoked and handled immediately, before executing the command following the Raise Event operation. In this case, the event handler runs synchronously.
-
No – The invoked event is written into the event queue, but is not performed immediately. After the execution of the current logic is completed, and only when the engine reads events from the queue, will it handle the event. In this case the event handler runs asynchronously. When this property is set to No, arguments will always be passed by value and never by reference. The passed arguments will not return changes in the passed arguments’ values.
-
Expression – When the Wait property is set to an expression that is True, the handler or trigger for the event will be performed immediately. If the engine returns False, the invoked event is written into the event queue.
Note: Internal event types should be raised asynchronously. If you want to raise an Internal event and to have the internal handling take effect, you should make sure that the Wait property is set to No. If you set this property to Yes, internal handling for these events is not executed.
How Do I Force Immediate Handling for Events?
How Do I Postpone the Handling of an Event?
