Adobe 23102480 Scripting Guide - Page 48

Photoshop CS3

Adobe Photoshop CS3

Scripting Guide

Scripting Photoshop CS3

48

Note:

This type of script corresponds to selecting

Start

Application

in the Script Events Manager (

File >

Scripts > Script Events Manager

) in the Photoshop CS3 application. Please refer to Photoshop CS3

Help for information on using the Script Events Manager.

The

make

(

Add/add

) command requires you to specify an event ID to identify the event to set up

notification for. Many event IDs are listed in an Appendix in the

Adobe Photoshop CS3 JavaScript Scripting

Reference

,

Adobe Photoshop CS3 Visual Basic Scripting Reference

, and

Adobe Photoshop CS3 AppleScript

Scripting Reference

. Some events also operate on several types of objects, and the

make

(

Add/add

)

command requires an additional argument for a class ID, which identifies the object. For example, the

“New” command is used for Document, Art Layer, and Channel objects.

Tip:

You can determine the event and class IDs of any recordable event by using ScriptListener. See

‘Using

ScriptListener to find event IDs and class IDs’ on page 79

.

The following example shows how to set up event notification for an “Open Document” event. First the

script ensures that event notification is enabled, then it sets up the event to trigger the execution of the

Welcome.jsx

file. Once the script completes, any time you open a document outside of a script, it triggers

the notification, which runs the

.jsx

file. This

.jsx

file displays an alert box.

Note:

Notification generally does not take effect on events that occur inside of a script, because these

events are embedded with in an

"AdobeScriptAutomation Scripts"

event.

AS

tell application "Adobe Photoshop CS3"

try

delete notifiers

end try

make new notifier with properties {event:"Opn ", ¬

event file:alias "OS X 10.4.8 US:Users:psauto:Desktop:Welcome.jsx"}

end tell

VBS

Dim appRef,eventFile

Set appRef = CreateObject("Photoshop.Application")

appRef.NotifiersEnabled = True

eventFile = appRef.Path & "Presets\Scripts\Event Scripts Only\Welcome.jsx"

appRef.Notifiers.Add "Opn ", eventFile

JS

app.notifiersEnabled = true

var eventFile = new File(app.path +

"/Presets/Scripts/Event Scripts Only/Welcome.jsx")

app.notifiers.add("Opn ", eventFile)

Using the PathItem Object

To create a

PathItem

object, you must add a

PathItem

to the

PathItems

element or collection for a

document. This requires that you first create an array of

PathPointInfo

objects, which specify the

coordinates of the corners or anchor points of your path. Then you create an array of

SubPathInfo

objects

to contain the

PathPoint

arrays.Once you have the points and a subpath, you can add a new

PathItem

.

The following script creates a

PathItem

object that is a straight line.

Section	Page
Contents	3
Introduction	5
About this manual	5
Conventions in this guide	5
Photoshop CS3 Scripting Basics	7
Scripting Overview	7
Why use scripts instead of actions?	7
Scripting Support in Photoshop CS3	8
JavaScript Support	8
Executing other scripts	9
Startup Scripts	9
Executing JavaScripts from AS or VBS	9
Photoshop CS3 Object Model	9
Containment Hierarchy	10
Application and Document Classes	10
Layer Classes	11
Layer Comp Class	11
Channel Class	11
Selection Class	11
History State Class	12
Document Info Class	12
Path Item, Sub Path Item, and Path Point Classes	12
Preferences Class	12
Notifier Class	12
Count Item Class	12
Color Sampler Class	12
Measurement Scale Class	12
The Containment Hierarchy and the Photoshop CS3 User Interface	12
Additional Objects	14
Constants	14
Creating a Sample Hello World Script	15
Creating and Running an AppleScript	15
Creating and Running a VBScript	16
Creating and Running a JavaScript	17
Scripting Photoshop CS3	19
Viewing Photoshop CS3 Objects, Commands, and Methods	19
Viewing Photoshop CS3’s AppleScript Dictionary	19
Viewing Photoshop CS3’s Type Library (VBS)	20
Targeting and Referencing the Application Object	20
Creating New Objects in a Script	21
Setting the Active Object	23
Setting the Active Document	24
Setting the Active Layer	25
Setting the Active Channels	25
Opening a Document	26
Opening a File with Default File Format	26
Specifying File Formats to Open	27
Saving a Document	29
Setting Application Preferences	30
Allowing or Preventing Dialogs	31
Working with the Photoshop CS3 Object Model	31
Using the Application Object	31
Using the Document Object	32
Manipulating a Document Object	32
Working with Layer Objects	34
Creating an ArtLayer Object	34
Creating a Layer Set Object	35
Referencing ArtLayer Objects	36
Working with Layer Set Objects	37
Linking Layer Objects	38
AS	38
VBS	38
JS	38
Applying Styles to Layers	38
Using the Text Item Object	39
Determining a Layer’s Kind	40
Adding and Manipulating Text in a Text Item Object	40
Working with Selection Objects	41
Creating and Defining a Selection	41
Stroking the Selection Border	42
Inverting Selections	43
Expanding, Contracting, and Feathering Selections	43
Filling a Selection	43
Loading and Storing Selections	44
Working with Channel Objects	45
Changing Channel Types	45
Using the Document Info Object	46
Using History State Objects	46
Using Notifier Objects	47
Using the PathItem Object	48
Working with Color Objects	50
Solid Color Classes	51
Using Hex Values for RGB Color	51
Getting and Converting Colors	51
Comparing Colors	52
Getting a Web Safe Color	52
Working with Filters	53
AS	53
VBS	53
JS	53
Other Filters	53
Understanding Clipboard Interaction	54
Using the Copy and Paste commands	54
Using the Copy Merged Command/Method	55
Working with Units	55
Unit Values	56
Special Unit Value Types	56
AppleScript Unit Considerations	56
Using Unit Values in Calculations	57
Unit Value Usage	57
Setting Ruler and Type Units in a Script	59
Sample Workflow Automation JavaScripts	59
Advanced Scripting	60
Working with Document Preferences	60
Applying Color to a Text Item	63
Applying a Wave Filter	66
Defining the Area of a Selection Object	66
Applying a MotionBlur Filter	69
Action Manager	72
The ScriptListener Plug-In	72
Installing ScriptListener	72
Action Manager Scripting Objects	73
Recording a Script using ScriptListener	73
Using the Action Manager from JavaScript	74
Using the Action Manager from a VBS Script	75
Running JavaScript-based Action Manager code from VBScript	78
Running JavaScript-based Action Manager code from AppleScript	78
Using ScriptListener to find event IDs and class IDs	79

Adobe 23102480 Scripting Guide - Page 48

Using the PathItem Object, File &gt, Scripts > Script Events Manager

Page 48 highlights