ScriptObject class wraps a post calculation script that is stored in the project.
These scripts are run automatically when the results are loaded.
The class can be called from Study class.
.
More...
Public Member Functions | |
| bool | IsDisabled () |
| Returns True if the script is disabled. Disabled scripts are not run automatically. | |
| bool | IsValid () |
| Returns True if an object is valid. More... | |
| String | Language () |
| Returns the language used for the script, Python, VBScript or JScript. | |
| void | Read (String &filename) |
| Loads a file and sets the contents into the script object. | |
| void | Run () |
| Executes the script. More... | |
| String | ScriptText () |
| Returns the text of the script. | |
| void | SetDisabled (bool isDisabled) |
| Specifies the script's disabled flag. A disabled script is not run automatically. More... | |
| void | SetLanguage (String &language) |
| Specifies the language for the script. Should be either Python, VBScript or JScript. More... | |
| void | SetPropertiesScriptText (String &text) |
| Specifies the parameter setting script text. This is the script that will be run. More... | |
| void | SetText (String &text) |
| Specifies the script text. This is the script that will be run. More... | |
| void | SetTitle (String &title) |
| Specifies the title of the script. This title appears in the treeview. More... | |
| String | Title () |
| Returns the title of the script object. | |
ScriptObject class wraps a post calculation script that is stored in the project.
These scripts are run automatically when the results are loaded.
The class can be called from Study class.
.
Example of calling the class object:
| bool ScriptObject::IsValid | ( | ) |
Returns True if an object is valid.
| void ScriptObject::Run | ( | ) |
Executes the script.
| void ScriptObject::SetDisabled | ( | bool | isDisabled | ) |
Specifies the script's disabled flag. A disabled script is not run automatically.
| isDisabled | 1 : Invalid
0 : Valid
|
| void ScriptObject::SetLanguage | ( | String & | language | ) |
Specifies the language for the script. Should be either Python, VBScript or JScript.
| language | Script language name Python
VBScript
JScript
|
| void ScriptObject::SetPropertiesScriptText | ( | String & | text | ) |
Specifies the parameter setting script text. This is the script that will be run.
| text | Parameter script text |
| void ScriptObject::SetText | ( | String & | text | ) |
Specifies the script text. This is the script that will be run.
| text | Script text |
| void ScriptObject::SetTitle | ( | String & | title | ) |
Specifies the title of the script. This title appears in the treeview.
| title | Script title |