ScriptArg
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| 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. |
| parent | Application | readonly | The parent of the ScriptArg (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
EventListener 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) |
void clear ()
Clears all script arguments.
string get (name:
string)
Gets the value of a script argument.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the script argument. |
Array of ScriptArg getElements ()
Resolves the object specifier, creating an array of object references.
string getValue (name:
string)
Gets the value of a script argument.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the script argument. |
bool isDefined (name:
string)
Verifies whether the script argument is defined.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the script argument. |
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) |
void restore ()
Restores all script arguments.
void save ()
Saves the script arguments.
void set (name:
string, value:
string)
Sets the value of a script argument.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the script argument. |
| value | string | The value. |
void setValue (name:
string, value:
string)
Sets the value of a script argument.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the script argument. |
| value | string | The value. |
string toSource ()
Generates a string which, if executed, will return the ScriptArg.
Element of
Application.scriptArgs
Return
Array of ScriptArg ScriptArg.getElements ()
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |