InDesign2026
API 21.5.1.73
Object

ScriptArg

Arguments to pass to a script.

Preference ›ScriptArg
Hierarchy

Application

ScriptArg

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application readonly The parent of the ScriptArg (a Application).
Object read/write A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Clears all script arguments.

→ String

Gets the value of a script argument.

name String The name of the script argument.
→ ScriptArg[]

Resolves the object specifier, creating an array of object references.

→ String

Gets the value of a script argument.

name String The name of the script argument.
→ Boolean

Verifies whether the script argument is defined.

name String The name of the script argument.
→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Restores all script arguments.

→ void

Saves the script arguments.

→ void

Sets the value of a script argument.

name String The name of the script argument.
value String The value.
→ void

Sets the value of a script argument.

name String The name of the script argument.
value String The value.
→ String

Generates a string which, if executed, will return the ScriptArg.

→ String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a ScriptArg.

Return 1

Methods that return a ScriptArg.