ScriptTask Class

Script Task runtime object
Public Class ScriptTask
This language is not supported or no code example is available.
public class ScriptTask
This language is not supported or no code example is available.
Name Description
Public constructor ScriptTask(RunObj, int) Construct the instance
Top
Name Description
Public property Category String with configured categories of ScriptTask.
Public property Counter Gets the executions amount since the module has started.
Public property Description Gets the ScriptTask Description configured in EditScriptsTasks.
Public property Disable Disables the ScriptTask execution when the value is greather than zero.
Public property Domain Indicates the ScriptTask Domain

Server:

The ScriptTask runs in the Server context, it cannot access Client objects i.e., Displays or client domain tags.

Client:

The ScriptTask runs in each Client where the ModuleScript is running.

Public property ErrorMessage Contains the message with the last (most recent) error that occurred in the script execution.
Public property Expression Gets the expression information.
Public property LastDuration Gets the CPU time used during the last (most recent) execution of the script.
Public property LastRun Contains the TimeSpan of the last (most recent) execution of the script.
Public property Level String with configured levels of ScriptTask.
Public property PeakDateTime Gets the Peak CPU time used during all execution of the script.
Public property Period Period of time required to execute a Task (ms)
Public property Running Indicates if the current script is running.
Public property StopExecutionOnError Flag to indicate if stop script execution on error.
Public property Trigger Gets the Tag or Object that triggers the Task execution.
Top
Methods
 
Name Description
Public method CreateEvent(object, bool, bool, int) Create an event to be executed
Public method GetEvent() Return object containing information being executed
Top
Name Description
Public enumeration e Enum containg list of IDs of runtime objects
Top
T.Modules.Script.ScriptTask

.NET Framework

Supported in: 4.6.2, 4.7

In this article

Definition