Application

The Adobe Illustrator application.

Go to Property Listing | Method Listing

Methods:

aATAddItem, aATClear, aATDuplicateItem, aATEditItem, aATErrorsExist, aATExecuteSession, aATExecuteSessionFromFile, aATFileRelativeChanged, aATFileSaveDialog, aATGetEditorDialogFile, aATGetErrorDialogFile, aATGetListOfRelativePaths, aATGetSession, aATLoadLibExtension, aATLoadModel, aATLoadSessionFile, aATLoadUIExtension, aATMoveItem, aATRemoveItem, aATReplaceItem, aATSaveAsSession, aATSaveSession, applyDataToItem, applySingleDataPointToItem, beep, beginSyncSettingsAutomationTest, beginTypekitFontAutomationTest, concatenateMatrix, concatenateRotationMatrix, concatenateScaleMatrix, concatenateTranslationMatrix, convertSampleColor, copy, cut, deleteWorkspace, doScript, dumpPGFFile, executeMenuCommand, getCCXUserJSONData, getExecutionOutput, getHelloJSONData, getIdentityMatrix, getIsFileOpen, getPPDFileInfo, getPresetFileOfType, getPresetSettings, getRotationMatrix, getScaleMatrix, getScriptableHelpGroup, getTranslationMatrix, getVersionString, invertMatrix, isEqualMatrix, isFillActive, isSingularMatrix, isStrokeActive, isTouchWorkspace, isUserSharingAppUsageData, launchExtension, loadAction, loadColorSettings, open, openCloudDocument, openCloudLibraryAssetForEditing, paste, quit, redo, redraw, reflectCSAW, resetWorkspace, runAPITest, saveWorkspace, selectTool, sendScriptMessage, setThumbnailOptionsForCloudLibrary, showColorPicker, showLearnPanelWithContent, showPresets, switchWorkspace, translatePlaceholderText, translateString, undo, unloadAction

Objects:

Boolean, CoordinateSystem, Document, Documents, File, PPDFile, Preferences, Printer, String, TextFonts, UserInteractionLevel,

Preferences:

Preferences

Property Listing

Property	Type	Access	Description
PDFPresetsList	Array of String	readonly	The list of PDF preset names currently available for use.
PPDFileList	Array of 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.
activeDocument	Document	read/write	The active document.
browserAvailable	Boolean	readonly	Is a web browser available?
buildNumber	String	readonly	The build number of the Adobe Illustrator application.
colorSettingsList	Array of File	readonly	The list of color settings files currently available for use.
coordinateSystem	CoordinateSystem CoordinateSystem.ARTBOARDCOORDINATESYSTEM CoordinateSystem.DOCUMENTCOORDINATESYSTEM	read/write	Coordinate System used by script.
defaultColorSettings	File	readonly	The default color settings file for the current application locale.
documents	Documents Document	readonly	The open documents.
flattenerPresetsList	Array of String	readonly	The list of flattener style names currently available for use.
freeMemory	Int32	readonly	The amount of unused memory within the Adobe Illustrator partition.
homeScreenVisible	Boolean	readonly	True if home Screen is Visible.
locale	String	readonly	The Locale of the Adobe Illustrator application.
name	String	readonly	The application's name.
parent		readonly	The object's container.
pasteRemembersLayers	Boolean	read/write	Does paste operation remember layers structure?
path	File	readonly	Path specification for the application.
preferences	Preferences	readonly	Preferences for Illustrator.
printPresetsList	Array of String	readonly	The list of print preset names currently available for use.
printerList	Array of Printer	readonly	The list of installed printers.
scriptingVersion	String	readonly	The version of the Scripting plugin.
selection	Varies	read/write	The selection visible to the user.
startupPresetsList	Array of String	readonly	The list of presets available for creating a new document.
textFonts	TextFonts TextFont	readonly	Installed fonts.
tracingPresetsList	Array of String	readonly	The list of tracing preset names currently available for use.
typename	String	readonly	The class name of the object.
userAdobeID	String	readonly	The current users adobe id.
userGUID	String	readonly	The current user's GUID.
userInteractionLevel	UserInteractionLevel UserInteractionLevel.DISPLAYALERTS UserInteractionLevel.DONTDISPLAYALERTS	read/write	What level of interaction with the user should be allowed when handling script commands.
version	String	readonly	The version of the Adobe Illustrator application.
visible	Boolean	readonly	Is the application visible.

Method Listing

String aATAddItem (sessionIndex:Int32, destinationSequenceID:Int32, destinationIndex:Int32, srcItemIDData:String, type:String)

Add the specified to the sequencer.

Parameter	Type	Description
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 aATClear ()

Clear the sequencer.

String aATDuplicateItem (sessionIndex:Int32, item:String)

Duplicates the specified item(s) from the sequencer.

Parameter	Type	Description
sessionIndex	Int32	The index in the session of the top-most sequence for the item to add.
item	String	The item UID(s)

String aATEditItem (sessionIndex:Int32, item:String)

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

Parameter	Type	Description
sessionIndex	Int32	The index in the session of the top-most sequence for the item to add.
item	String	The item UID.

Boolean aATErrorsExist ()

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

undefined aATExecuteSession ()

Executes the active session in the sequencer.

undefined aATExecuteSessionFromFile (file:File)

Executes the active session in the sequencer.

Parameter	Type	Description
file	File	Execute a session file.

String aATFileRelativeChanged (path:String, relative:String, newRelative:String)

Switches a files relative token and path.

Parameter	Type	Description
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 aATFileSaveDialog (path:String, relative:String, type:String)

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

Parameter	Type	Description
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 aATGetEditorDialogFile ()

Retrieves a file path to the AAT editor swf.

File aATGetErrorDialogFile ()

Retrieves a file path to the AAT error dialog swf.

String aATGetListOfRelativePaths ()

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

String aATGetSession ()

Get the active session for the sequncer.

String aATLoadLibExtension ()

Loads a session file as an extension to the editor.

String aATLoadModel ()

Loads the aat model to the editor.

String aATLoadSessionFile ()

Loads a session into the sequencer.

String aATLoadUIExtension ()

Loads a UI description as an extension to the editor.

String aATMoveItem (sessionIndex:Int32, moveThisID:String, newSessionIndex:Int32, destinationSequenceID:String, destinationIndex:Int32)

Moves the specified in the sequencer.

Parameter	Type	Description
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 aATRemoveItem (sessionIndex:Int32, item:String)

Removes the specified item from the sequencer.

Parameter	Type	Description
sessionIndex	Int32	The index in the session of the top-most sequence for the item to add.
item	String	The item UID.

String aATReplaceItem (sessionIndex:Int32, replaceThisID:Int32, srcItemIDData:String, type:String)

Replaces the specified to the sequencer.

Parameter	Type	Description
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 aATSaveAsSession ()

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

String aATSaveSession ()

Saves the active session in the sequencer to a file.

String applyDataToItem (sessionIndex:Int32, item:String, data:String)

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

Parameter	Type	Description
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 applySingleDataPointToItem (sessionIndex:Int32, item:String, dataID:String, data:String)

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

Parameter	Type	Description
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.

undefined beep ()

Boolean beginSyncSettingsAutomationTest ()

Starts the automation tests for the Sync Settings feature.

Boolean beginTypekitFontAutomationTest ()

Starts the automation tests for the Typekit Font feature.

Matrix concatenateMatrix (matrix:Matrix, secondMatrix:Matrix)

Concatenate two transformation matrices.

Parameter	Type	Description
matrix	Matrix	The matrix that is to be added to.
secondMatrix	Matrix	Second transformation matrix.

Matrix concatenateRotationMatrix (matrix:Matrix, angle:Number)

Concatenate a rotation matrix to a transformation matrix.

Parameter	Type	Description
matrix	Matrix	The matrix that is to be added to.
angle	Number	Angle of rotation (in degrees)

Matrix concatenateScaleMatrix (matrix:Matrix, [scaleX:Number=Number], [scaleY:Number=Number])

Concatenate a scale matrix to a transformation matrix.

Parameter

Type

Description

matrix

Matrix

The matrix that is to be added to.

scaleX

Number

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

(default: 100.0)

scaleY

Number

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

(default: 100.0)

Matrix concatenateTranslationMatrix (matrix:Matrix, [deltaX:Number=Number], [deltaY:Number=Number])

Concatenate a translation to a transformation matrix.

Parameter

Type

Description

matrix

Matrix

The matrix that is to be added to.

deltaX

Number

Horizontal transformation.

(default: 0.0)

deltaY

Number

Vertical transformation.

(default: 0.0)

Number convertSampleColor (sourceColorSpace:ImageColorSpace, sourceColor:Array of Number, destColorSpace:ImageColorSpace, colorConvertPurpose:ColorConvertPurpose, [sourceHasAlpha:Boolean=Boolean], [destHasAlpha:Boolean=Boolean])

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

Parameter	Type	Description
sourceColorSpace	ImageColorSpace ImageColorSpace.CMYK ImageColorSpace.DeviceN ImageColorSpace.GrayScale ImageColorSpace.Indexed ImageColorSpace.LAB ImageColorSpace.RGB ImageColorSpace.Separation	The source color space.
sourceColor	Array of 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 ImageColorSpace.CMYK ImageColorSpace.DeviceN ImageColorSpace.GrayScale ImageColorSpace.Indexed ImageColorSpace.LAB ImageColorSpace.RGB ImageColorSpace.Separation	The destination color space.
colorConvertPurpose	ColorConvertPurpose ColorConvertPurpose.defaultpurpose ColorConvertPurpose.dummypurpose ColorConvertPurpose.exportpurpose ColorConvertPurpose.previewpurpose	The parameter which passes the purpose of conversion.
sourceHasAlpha	Boolean	True if alpha channel is present in source color. (default: false)
destHasAlpha	Boolean	True if alpha channel is present in destination color. (default: false)

undefined copy ()

Copy current selection to the clipboard.

undefined cut ()

Cut current selection to the clipboard.

Boolean deleteWorkspace (workspaceName:String)

Deletes an existing workspace.

Parameter	Type	Description
workspaceName	String	Workspace Name.

undefined doScript (action:String, from:String, [dialogs:Boolean=Boolean])

Play an action from the Actions Palette.

Parameter	Type	Description
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? (default: true)

Parameter

Type

Description

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?

(default: true)

Boolean dumpPGFFile (file:File, [documentColorSpace:DocumentColorSpace], pGFFile:File)

Dump the PGF portion of ai file to txt file.

Parameter	Type	Description
file	File	The AI file to be opened.
documentColorSpace	DocumentColorSpace DocumentColorSpace.CMYK DocumentColorSpace.RGB	Choose color space only for documents saved with multiple color models (pre-Illustrator 9)
pGFFile	File	Folder to save the output PGF file.

Parameter

Type

Description

file

File

The AI file to be opened.

documentColorSpace

DocumentColorSpace

DocumentColorSpace.CMYK

DocumentColorSpace.RGB

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

pGFFile

File

Folder to save the output PGF file.

undefined executeMenuCommand (menuCommandString:String)

Executes a menu command using the menu shortcut string.

Parameter	Type	Description
menuCommandString	String	Menu command shortcut.

String getCCXUserJSONData ([mode:String=String])

Returns the JSON Data required by CCX Welcome.

Parameter	Type	Description
mode	String	Mode for which the data is to be provided. (default: )

Parameter

Type

Description

mode

String

Mode for which the data is to be provided.

(default: )

String getExecutionOutput ()

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

String getHelloJSONData ()

Returns the JSON Data required by Hello.

Matrix getIdentityMatrix ()

Returns an identity matrix.

Boolean getIsFileOpen (filePath:String)

Returns if the specified filePath is open.

Parameter	Type	Description
filePath	String	The filePath to be checked.

PPDFileInfo getPPDFileInfo (name:String)

Get detailed info from the specified PPD file.

Parameter	Type	Description
name	String	The model name of the PPD file.

File getPresetFileOfType (presetType:DocumentPresetType)

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

Parameter	Type	Description
presetType	DocumentPresetType DocumentPresetType.BasicCMYK DocumentPresetType.BasicRGB DocumentPresetType.Mobile DocumentPresetType.Print DocumentPresetType.Video DocumentPresetType.Web	The preset type.

Parameter

Type

Description

presetType

DocumentPresetType

DocumentPresetType.BasicCMYK

DocumentPresetType.BasicRGB

DocumentPresetType.Mobile

DocumentPresetType.Print

DocumentPresetType.Video

DocumentPresetType.Web

The preset type.

DocumentPreset getPresetSettings (preset:String)

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

Parameter	Type	Description
preset	String	The name of the preset.

Matrix getRotationMatrix ([angle:Number=Number])

Returns a rotation transformation matrix.

Parameter	Type	Description
angle	Number	Angle of rotation (in degrees) (default: 0.0)

Parameter

Type

Description

angle

Number

Angle of rotation (in degrees)

(default: 0.0)

Matrix getScaleMatrix ([scaleX:Number=Number], [scaleY:Number=Number])

Returns a scale transformation matrix.

Parameter	Type	Description
scaleX	Number	Horizontal scaling factor expressed as a percentage (100 = 100%) (default: 100.0)
scaleY	Number	Vertical scaling factor expressed as a percentage (100 = 100%) (default: 100.0)

Parameter

Type

Description

scaleX

Number

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

(default: 100.0)

scaleY

Number

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

(default: 100.0)

Varies getScriptableHelpGroup ()

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

Matrix getTranslationMatrix ([deltaX:Number=Number], [deltaY:Number=Number])

Returns a translation matrix.

Parameter	Type	Description
deltaX	Number	Horizontal transformation. (default: 0.0)
deltaY	Number	Vertical transformation. (default: 0.0)

Parameter

Type

Description

deltaX

Number

Horizontal transformation.

(default: 0.0)

deltaY

Number

Vertical transformation.

(default: 0.0)

String getVersionString ()

Retrieves a string representing the AAT version.

Matrix invertMatrix (matrix:Matrix)

Invert a matrix.

Parameter	Type	Description
matrix	Matrix	The matrix to invert.

Boolean isEqualMatrix (matrix:Matrix, secondMatrix:Matrix)

Compares two matrices for equality.

Parameter	Type	Description
matrix	Matrix	First transformation matrix to compare.
secondMatrix	Matrix	Second transformation matrix.

Boolean isFillActive ()

Checks if fill is active or not.

Boolean isSingularMatrix (matrix:Matrix)

Tests if a matrix is singular (cannot be inverted)

Parameter	Type	Description
matrix	Matrix	The matrix to check.

Boolean isStrokeActive ()

Checks if stroke is active or not.

Boolean isTouchWorkspace ()

Is In Touch Workspace.

Boolean isUserSharingAppUsageData ()

Is user sharing the application usage data.

Int32 launchExtension (extensionID:String)

Launch cep Extension given its ID.

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

undefined loadAction (actionFilePath:File)

Load an action into action palette.

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

undefined loadColorSettings (fileSpec:File)

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

Parameter	Type	Description
fileSpec	File	File spec for the color settings.

Document open (file:File, [documentColorSpace:DocumentColorSpace], [options:Varies])

Open the specified document file.

Parameter	Type	Description
file	File	The file to be opened.
documentColorSpace	DocumentColorSpace DocumentColorSpace.CMYK DocumentColorSpace.RGB	Choose color space only for documents saved with multiple color models (pre-Illustrator 9)
options	Varies	Options for opening a particular type of file.

Parameter

Type

Description

file

File

The file to be opened.

documentColorSpace

DocumentColorSpace

DocumentColorSpace.CMYK

DocumentColorSpace.RGB

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 openCloudDocument (cloudPath:String)

Open the specified cloud document.

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

Document openCloudLibraryAssetForEditing (assetURL:File, thumbnailURL:File, assetType:String, [options:Varies])

For Internal Use.

Parameter	Type	Description
assetURL	File	For Internal use.
thumbnailURL	File	For Internal use.
assetType	String	For internal use.
options	Varies	For internal use.

undefined paste ()

Paste clipboard into the current document.

undefined quit ()

Quit the application.

undefined redo ()

Redo the last transaction.

undefined redraw ()

Force Illustrator to redraw its window(s)

undefined reflectCSAW (outputFolder:File)

Generate Creative Suite ActionScript Wrappers in specified directory.

Parameter	Type	Description
outputFolder	File	Location for the output files.

Boolean resetWorkspace ()

Resets the current workspace.

undefined runAPITest (testName:String)

Runs API Tests from the TestAPI Plug-in.

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

Boolean saveWorkspace (workspaceName:String)

Saves a new workspace.

Parameter	Type	Description
workspaceName	String	Workspace Name.

Boolean selectTool (toolName:String)

Select tool using toolname.

Parameter	Type	Description
toolName	String	Tool Name.

String sendScriptMessage (pluginName:String, messageSelector:String, inputString:String)

Sends the script message to the required plugin.

Parameter	Type	Description
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.

undefined setThumbnailOptionsForCloudLibrary (options:Varies)

For Internal Use.

Parameter	Type	Description
options	Varies	Options for the PNG24 export.

Color showColorPicker (color:Color)

Invokes application's color picker.

Parameter	Type	Description
color	Color	The color to load in the color picker initially.

Boolean showLearnPanelWithContent (manifest:String, hTMLPage:String)

Display learn panel with specific content.

Parameter	Type	Description
manifest	String	Path of the manifest.
hTMLPage	String	Url of the html file to be displayed on learn panel.

String showPresets (fileSpec:File)

Get presets from the file.

Parameter	Type	Description
fileSpec	File	File spec to import from.

Boolean switchWorkspace (workspaceName:String)

Switches between workspaces.

Parameter	Type	Description
workspaceName	String	Workspace Name.

String translatePlaceholderText (text:String)

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

Parameter	Type	Description
text	String	The placeholder text to be translated.

String translateString (key:String, source:String)

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

Parameter	Type	Description
key	String	The string to translate.
source	String	The plugin name from the source of the key.

undefined undo ()

Undo the last transaction.

undefined unloadAction (setName:String, actionName:String)

Unloads an action into action palette.

Parameter	Type	Description
setName	String	Name of the set to be unloaded.
actionName	String	Name of the action to be unloaded.

Object of

global.app