|
<< Click to Display Table of Contents >>
OnCancel |
OnCancel(ActorID, WriteValue, FeedbackValue, Failed)
Defines which task is executed when the Cancel method, available on an instance of a Command Unit object, is called. The most basic task performed by this event is writing the value of the Cancel Value field, configured in the Command Action area, to the CancelWriteTag property, configured in the Command object, and setting the value of the Failed parameter.
Description of parameters
Name |
Description |
|---|---|
ActorID |
Informs to a script the name of the user passed on the ActorID parameter of the Cancel method in a Command Unit. If omitted when calling that method, assumes Elipse Water Viewer's user logon, "Anonymous" if there is no user logged on, or "System" if that method's call started at the server |
WriteValue |
Informs all values configured in the creation area of Command Actions for this event, according to the type of action, such as "Open" or "Close". This parameter contains the value of the Cancel Value field |
FeedbackValue |
This parameter contains all values configured in the creation area of Command Actions for this event. This parameter initially contains the value of the Cancel FeedBack field. If needed, a script may change this value, and at the end of that script it is the modified value that is expected as a feedback. This allows evaluating incremental-type commands |
Failed |
A Boolean used to indicate a failure detection in the scripts of Command Actions. This value must be set to False if that action succeeds, as it starts that script with its value as True |