Object Class: _addEventHandler

Object Class: _addEventHandler

Specifies the action that takes place when a particular even occurs

Syntax
Details

Syntax

return = objectName._addEventHandler( metadataList );

return = objectName._addEventHandler( senderName, event, action );

return = objectName._addEventHandler( senderID, event, action );

Argument Type Use Description

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

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

senderName Character Input specifies the name of the object that declares the event has occurred

event Character Input specifies the event that triggers the action

action Character Input specifies the action to take when the event occurs. Actions may take any of the following forms: a method name, libref.catalog.entry.type which is the four-level name of a SAS/AF catalog entry that is invoked as if called with the DISPLAY routine, or libre

senderID Object Input specifies the identifier of the object that declares that the event has occurred

Argument	Type	Use	Description
return	Numeric	Return	returns a value indicating whether the event handler was successfully added: 0 if successful, 1 if not successful
metadataList	List	Update	specifies a list containing the named items for the event handler metadata
senderName	Character	Input	specifies the name of the object that declares the event has occurred
event	Character	Input	specifies the event that triggers the action
action	Character	Input	specifies the action to take when the event occurs. Actions may take any of the following forms: a method name, libref.catalog.entry.type which is the four-level name of a SAS/AF catalog entry that is invoked as if called with the DISPLAY routine, or libre
senderID	Object	Input	specifies the identifier of the object that declares that the event has occurred

Details

You cannot add duplicate event handlers with the _addEventHandler method.

Chapter Contents
Previous
Next
Top of Page