Object

Application

The Adobe Illustrator application.

Properties

Type	Access	Description
String[]	readonly	The list of PDF preset names currently available for use.
PPDFile[]	readonly	The list of PPD files currently available for use. For performance reasons, the PPDFile entry only contains the model name and file spec of each PPD file.
Document	read/write	The active document.
Boolean	readonly	Is a web browser available?
String	readonly	The build number of the Adobe Illustrator application.
File[]	readonly	The list of color settings files currently available for use.
CoordinateSystem	read/write	Coordinate System used by script.
File	readonly	The default color settings file for the current application locale.
Documents<Document>	readonly	The open documents.
String[]	readonly	The list of flattener style names currently available for use.
Int32	readonly	The amount of unused memory within the Adobe Illustrator partition.
Boolean	readonly	True if home Screen is Visible.
String	readonly	The Locale of the Adobe Illustrator application.
String	readonly	The application's name.
The	readonly	The object's container.
Boolean	read/write	Does paste operation remember layers structure?
File	readonly	Path specification for the application.
Preferences	readonly	Preferences for Illustrator.
String[]	readonly	The list of print preset names currently available for use.
Printer[]	readonly	The list of installed printers.
String	readonly	The version of the Scripting plugin.
Varies	read/write	The selection visible to the user.
String[]	readonly	The list of presets available for creating a new document.
TextFonts<TextFont>	readonly	Installed fonts.
String[]	readonly	The list of tracing preset names currently available for use.
String	readonly	The class name of the object.
String	readonly	The current users adobe id.
String	readonly	The current user's GUID.
UserInteractionLevel	read/write	What level of interaction with the user should be allowed when handling script commands.
String	readonly	The version of the Adobe Illustrator application.
Boolean	readonly	Is the application visible.

Methods

→ String

Add the specified to the sequencer.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

destinationSequenceID Int32 The UID for the owning sequence.

destinationIndex Int32 The item UID where to insert.

srcItemIDData String The item ID of the item to construct.

type String The source of the item to construct.

→ String

Clear the sequencer.

→ String

Duplicates the specified item(s) from the sequencer.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

item String The item UID(s)

→ String

Opens the specified item from the sequencer in the item editor.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

item String The item UID.

→ Boolean

Retrieves a boolean indicating the presence of errors in the last script to execute.

→ void

Executes the active session in the sequencer.

→ void

Executes the active session in the sequencer.

file File Execute a session file.

→ String

Switches a files relative token and path.

path String The path relative to the folder specified by Relative.

relative String The current relative path token.

newRelative String The new relative path token.

→ String

Prompts the user to save a file or choose a file or directory and returns a relative path string to the file.

path String The path relative to the folder specified by Relative.

relative String The current relative path token.

type String The type of dialog to show in string format.

→ File

Retrieves a file path to the AAT editor swf.

→ File

Retrieves a file path to the AAT error dialog swf.

→ String

Gets an XML string listing the relative paths and the UI strings to display them.

→ String

Get the active session for the sequncer.

→ String

Loads a session file as an extension to the editor.

→ String

Loads the aat model to the editor.

→ String

Loads a session into the sequencer.

→ String

Loads a UI description as an extension to the editor.

→ String

Moves the specified in the sequencer.

sessionIndex Int32 The index in the session of the top-most sequence for the item to move.

moveThisID String The UID of the item to replace.

newSessionIndex Int32 The index in the session of the destination top-most sequence.

destinationSequenceID String The UID for the owning sequence.

destinationIndex Int32 The index where to insert.

→ String

Removes the specified item from the sequencer.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

item String The item UID.

→ String

Replaces the specified to the sequencer.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

replaceThisID Int32 The UID of the item to replace.

srcItemIDData String The item ID of the item to construct.

type String The source of the item to construct.

→ String

Saves the active session in the sequencer to a new file.

→ String

Saves the active session in the sequencer to a file.

→ String

Applies the data used in the item editor to the item.

sessionIndex Int32 The index in the session of the top-most sequence for the item to edit.

item String The item UID.

data String The data to apply in XML format.

→ Boolean

Applies data to the specified item from the sequencer in the item editor.

sessionIndex Int32 The index in the session of the top-most sequence for the item to add.

item String The item UID.

dataID String The data to apply in XML format.

data String The data to apply in XML format.

→ void

→ Boolean

Starts the automation tests for the Sync Settings feature.

→ Boolean

Starts the automation tests for the Typekit Font feature.

→ Matrix

Concatenate two transformation matrices.

matrix Matrix The matrix that is to be added to.

secondMatrix Matrix Second transformation matrix.

→ Matrix

Concatenate a rotation matrix to a transformation matrix.

matrix Matrix The matrix that is to be added to.

angle Number Angle of rotation (in degrees)

→ Matrix

Concatenate a scale matrix to a transformation matrix.

matrix Matrix The matrix that is to be added to.

scaleX? Number Horizontal scaling factor expressed as a percentage (100 = 100%)

scaleY? Number Vertical scaling factor expressed as a percentage (100 = 100%)

→ Matrix

Concatenate a translation to a transformation matrix.

matrix Matrix The matrix that is to be added to.

deltaX? Number Horizontal transformation.

deltaY? Number Vertical transformation.

→ Number[]

Converts a sample-component color from one color space to another.

sourceColorSpace ImageColorSpace The source color space.

sourceColor Number[] The color to convert, an array of color components. First location of the array should contain alpha if source-has-alpha is true.

destColorSpace ImageColorSpace The destination color space.

colorConvertPurpose ColorConvertPurpose The parameter which passes the purpose of conversion.

sourceHasAlpha? Boolean True if alpha channel is present in source color.

destHasAlpha? Boolean True if alpha channel is present in destination color.

→ void

Copy current selection to the clipboard.

→ void

Cut current selection to the clipboard.

→ Boolean

Deletes an existing workspace.

workspaceName String Workspace Name.

→ void

Play an action from the Actions Palette.

action String The name of the action to play (note that the case of letters in the Action name is important and must match the case of the name in the Actions palette)

from String The name of the action set containing the action being played (note that the case of letters in the Action Set name is important and must match the case of the name in the Actions palette)

dialogs? Boolean Are dialog boxes associated with the action to be presented?

→ Boolean

Dump the PGF portion of ai file to txt file.

file File The AI file to be opened.

documentColorSpace? DocumentColorSpace Choose color space only for documents saved with multiple color models (pre-Illustrator 9)

pGFFile File Folder to save the output PGF file.

→ void

Executes a menu command using the menu shortcut string.

menuCommandString String Menu command shortcut.

→ String

Returns the JSON Data required by CCX Welcome.

mode? String Mode for which the data is to be provided.

→ String

Retrieves a string containing the results of the last script to execute.

→ String

Returns the JSON Data required by Hello.

→ Matrix

Returns an identity matrix.

→ Boolean

Returns if the specified filePath is open.

filePath String The filePath to be checked.

→ PPDFileInfo

Get detailed info from the specified PPD file.

name String The model name of the PPD file.

→ File

Given a preset type, returns the full path to the application's default document profile for the type.

presetType DocumentPresetType The preset type.

→ DocumentPreset

Given a preset name, tries and retrieves the settings from the preset template.

preset String The name of the preset.

→ Matrix

Returns a rotation transformation matrix.

angle? Number Angle of rotation (in degrees)

→ Matrix

Returns a scale transformation matrix.

scaleX? Number Horizontal scaling factor expressed as a percentage (100 = 100%)

scaleY? Number Vertical scaling factor expressed as a percentage (100 = 100%)

→ Varies

Get the scriptable help group object that represents the search widget in the app bar.

→ Matrix

Returns a translation matrix.

deltaX? Number Horizontal transformation.

deltaY? Number Vertical transformation.

→ String

Retrieves a string representing the AAT version.

→ Matrix

Invert a matrix.

matrix Matrix The matrix to invert.

→ Boolean

Compares two matrices for equality.

matrix Matrix First transformation matrix to compare.

secondMatrix Matrix Second transformation matrix.

→ Boolean

Checks if fill is active or not.

→ Boolean

Tests if a matrix is singular (cannot be inverted)

matrix Matrix The matrix to check.

→ Boolean

Checks if stroke is active or not.

→ Boolean

Is In Touch Workspace.

→ Boolean

Is user sharing the application usage data.

→ Int32

Launch cep Extension given its ID.

extensionID String Arguments for Launching Extension - ID of extension in manifest.xml of corresponding extension.

→ void

Load an action into action palette.

actionFilePath File The path on the system of the action file to be loaded.

→ void

Load the color settings from the file. If the file is an empty file spec, the color management will be turned off.

fileSpec File File spec for the color settings.

→ Document

Open the specified document file.

file File The file to be opened.

documentColorSpace? DocumentColorSpace Choose color space only for documents saved with multiple color models (pre-Illustrator 9)

options? Varies Options for opening a particular type of file.

→ Document

Open the specified cloud document.

cloudPath String Path of the document to be opened from cloud.

→ Document

For Internal Use.

assetURL File For Internal use.

thumbnailURL File For Internal use.

assetType String For internal use.

options? Varies For internal use.

→ void

Paste clipboard into the current document.

→ void

Quit the application.

→ void

Redo the last transaction.

→ void

Force Illustrator to redraw its window(s)

→ void

Generate Creative Suite ActionScript Wrappers in specified directory.

outputFolder File Location for the output files.

→ Boolean

Resets the current workspace.

→ void

Runs API Tests from the TestAPI Plug-in.

testName String Arguments for Running Tests - eg. Name of Test/Suite.

→ Boolean

Saves a new workspace.

workspaceName String Workspace Name.

→ Boolean

Select tool using toolname.

toolName String Tool Name.

→ String

Sends the script message to the required plugin.

pluginName String Plugin to which message needs to be sent.

messageSelector String Functionality that is to be executed.

inputString String Pass any data encoded in a string.

→ void

For Internal Use.

options Varies Options for the PNG24 export.

→ Color

Invokes application's color picker.

color Color The color to load in the color picker initially.

→ Boolean

Display learn panel with specific content.

manifest String Path of the manifest.

hTMLPage String Url of the html file to be displayed on learn panel.

→ String[]

Get presets from the file.

fileSpec File File spec to import from.

→ Boolean

Switches between workspaces.

workspaceName String Workspace Name.

→ String

Translate the placeholder text to regular text. A method to enter unicode points in hex values.

text String The placeholder text to be translated.

→ String

Returns a string translated from the key and source data passed in.

key String The string to translate.

source String The plugin name from the source of the key.

→ void

Undo the last transaction.

→ void

Unloads an action into action palette.

setName String Name of the set to be unloaded.

actionName String Name of the action to be unloaded.