Object Class: _addEvent

Object Class: _addEvent

Registers an event on a class or object

Syntax
Details

Syntax

return = objectName._addEvent( metadataList );

return = objectName._addEvent( eventName );

return = objectName._addEvent( eventName, executeType );

return = objectName._addEvent( eventName,executeType,method );

Argument Type Use Description

return Numeric Return returns a value indicating whether the event was successfully added: 0 if successful, 1 if not successful

metadataList List Update specifies a list containing the named items for the event metadata

eventName Character Input specifies the name of the event to add

executeType Character Input specifies when the event gets executed. BEFORE or AFTER indicates the event is automatically sent when the specified method executes. MANUAL implies the event is sent programmatically in SCL using the _sendEvent method

method Character Input specifies the method that triggers the event; used only if executeType is BEFORE or AFTER

Argument	Type	Use	Description
return	Numeric	Return	returns a value indicating whether the event was successfully added: 0 if successful, 1 if not successful
metadataList	List	Update	specifies a list containing the named items for the event metadata
eventName	Character	Input	specifies the name of the event to add
executeType	Character	Input	specifies when the event gets executed. BEFORE or AFTER indicates the event is automatically sent when the specified method executes. MANUAL implies the event is sent programmatically in SCL using the _sendEvent method
method	Character	Input	specifies the method that triggers the event; used only if executeType is BEFORE or AFTER

Details

The _addEvent signature that passes metadataList is valid on both class and instance; the remaining signatures are valid on instance only.

Chapter Contents
Previous
Next
Top of Page