Cancel

<< Click to Display Table of Contents >>

 

Cancel

Cancel([ActorID])

Executes a Cancel action, where the ActorID parameter is the user name. If omitted, it assumes Elipse Power Viewer's user logon, "Anonymous" if there is no user logged on, or "System" if this method's call started at the server. If there is a pending Operate or Select action (waiting), these actions are canceled and the OnOperateFinished or OnSelectFinished event is immediately triggered, executing the script associated to it and canceling this occurrence. For this action to occur, there are some conditions:

The Unit's parent Command must have its Enabled property set to True

There must be no pending Cancel command in the Command Unit, that is, the ActionInProgress property must be set to 0 (zero, None), 1 (one, Operate), or 2 (two, Select)

The OnCancel's event script must be defined in the configured command type conversion

 

This method waits for a feedback value up to the specified limit time if all the following conditions are met:

The script was successfully executed

The script was not canceled

The feedback limit time of the conversion is not 0 (zero)

The feedback Tag's path is not empty

 

If the feedback value is not used by the Tag inside the limit time or the Tag's path is invalid (but it is not empty), this command is considered as failed. Usage example:

Sub CommandButton1_Click()
  Set CMDUnit = Application.GetObject(_
    "Substation1.Breaker1.Commands.cmdBreakerPosition.Open")
  CMDUnit.Cancel()
End Sub

 

NOTE

The feedback value is only considered if its quality is not bad. Whether this action fails or works, the OnCancelFinished event of the configured conversion is executed, if it was defined.

Was this page useful?