Class
ScriptPreference |
| | Scripting environment preferences. Base Class: Preference |
QuickLinks |
addEventListener, getElements, removeEventListener, toSource, toSpecifier |
Hierarchy
|
|
Properties
| | Property | Type | Access | Description |
|---|
| enableRedraw | bool |
r/w | If true, enables redraw during script execution. |
| eventListeners | EventListeners |
readonly | A collection of event listeners. |
| events | Events |
readonly | A collection of events. |
| isValid | bool |
readonly | Returns true if the object specifier resolves to valid objects. |
| measurementUnit | AutoEnumMeasurementUnits |
r/w | The measurement unit used during script processing. Can return: AutoEnum enumerator or MeasurementUnits enumerator. |
| parent | Application |
readonly | The parent of the ScriptPreference (a Application). |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
| scriptsFolder | File |
readonly | The path to the Scripts folder for the application. |
| scriptsList |
Array
of
Array
of 2 Strings
Files |
readonly | A list of the scripts in the Scripts folder. Can return: Array of Array of 2 Strings or Files. |
| version | string |
r/w | The version of the scripting environment. Can also accept: Real. |
|
Methods
| InstancesEventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The event type. |
| handler | File
JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of ScriptPreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The registered event type. |
| handler | File
JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ScriptPreference.
string toSpecifier ()
Retrieves the object specifier.
|
Element of |
Application.scriptPreferences
|
Return |
Array
of ScriptPreference ScriptPreference.getElements ()
|