OnSelect

<< Click to Display Table of Contents >>

 

OnSelect

OnSelect(ActorID, WriteValue, FeedbackValue, Failed)

Defines which task is executed when the Select method, available on an instance of the Command Unit object, is called. The most basic task performed by this script is writing the value of the Select Value field (configured in the Command Action area) to the SelectWriteTag 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 to the Select method in the Command Unit. If omitted when calling that method, 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

WriteValue

Informs all values configured in the creation area of Command Actions for the OnSelect event, according to the action type, such as "Open" or "Close". This parameter has the value of the Select Value field

FeedbackValue

This parameter contains all values configured in the creation area of the Command Actions for the OnSelect event. This parameter initially has the value of the Select FeedBack field. If needed, a script may change this value, and at the end of that script the modified value is the expected returned value. This allows evaluating incremental-type commands

Failed

A Boolean used to indicate a failure detection in the Command Action scripts. This value must be set to False if that action succeeds, as it starts that script with its value as True

Was this page useful?