ScriptArg
Arguments to pass to a script.
Go to Property Listing | Method Listing
Methods:
addEventListener, clear, get, getElements, getValue, isDefined, removeEventListener, restore, save, set, setValue, toSource, toSpecifier
Objects:
Hierarchy:
Superclass: Preference
Class: ScriptArg
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
readonly |
The parent of the ScriptArg (a Application). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined clear ()
Clears all script arguments.
String get (name:String)
Gets the value of a script argument.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name of the script argument. |
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 |
The name of the script argument. |
Boolean isDefined (name:String)
Verifies whether the script argument is defined.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name of the script argument. |
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined restore ()
Restores all script arguments.
undefined save ()
Saves the script arguments.
undefined set (name:String, value:String)
Sets the value of a script argument.
undefined setValue (name:String, value:String)
Sets the value of a script argument.
String toSource ()
Generates a string which, if executed, will return the ScriptArg.
String toSpecifier ()
Retrieves the object specifier.
Object of
Application.scriptArgs
Event.parent
EventListener.parent
MutationEvent.parent