Remove Packet

Software Customisation Reference Manual

Event Driven Graphics : Event Control System (edgCntrl) : Remove Packet

The .remove method will remove the first event in the EDG system that has the passed description. Where a utility has more than one event, then a remove must be used for each event added into the system.

An event can be removed from the system in one of two ways, either forcibly by using the .remove method, giving the event packet description or automatically as defined in the event packet definition (see below).

When an event is removed from to the system, several tasks are performed:

•

The .close method of event packet is executed

•

Removes any associated forms declared against the packet's definition

•

Reinstates the event from the top of the stack, making it the active event

If the event description passed to the remove methods does not exist in the event control system, no error is produced.

The following is a closing method for a form that uses an event packet to perform some form of picking from the graphic view:


-- Define Close Method define method .close() -- Remove event !edgCntrl.remove('<packet description>') -- Hide the form !this.hide() -- End endmethod

Note:

Where there is a form associated with an event packet, the form will automatically be removed by the event system, when the packet is removed from the system.