Adobe 65014293 Scripting Guide - Page 48

C

HAPTER

3: Scripting Photoshop

Working with the Photoshop Object Model

48

AS

set current history state of current document to history state 1 ¬

of current document

VBS

docRef.ActiveHistoryState = docRef.HistoryStates(1)

JS

docRef.activeHistoryState = docRef.historyStates[0]

N

OTE

:

Reverting back to a previous history state does not remove any later states from the history

collection. Use the

Purge

command to remove later states from the

History States

collection as shown

below:

➤

AS:

purge history caches

➤

VBS:

appRef.Purge(2) 'for psPurgeTarget --> 2 (psHistoryCaches)

➤

JS:

app.purge(PurgeTarget.HISTORYCACHES)

The example below saves the current state, applies a filter, and then reverts back to the saved history state.

AS

set savedState to current history state of current document

filter current layer of current document using motion blur with options ¬

{class:motion blur, angle:20, radius:20}

set current history state of current document to savedState

VBS

Set savedState = docRef.ActiveHistoryState

docRef.ArtLayers(1).ApplyMotionBlur 20, 20

docRef.ActiveHistoryState = savedState

JS

savedState = docRef.activeHistoryState

docRef.artLayers[0].applyMotionBlur( 20, 20 )

docRef.activeHistoryState = savedState

Using Notifier objects

You use the

Notifier

object to tie an event to a script. For example, if you would like Photoshop to

automatically create a new document when you open the application, you could tie a script that creates a

Document

object to an

Open

Application

event.

N

OTE

:

This type of script corresponds to selecting

Start

Application

in the Script Events Manager

(

File > Scripts > Script Events Manager

) in the Photoshop application. Please refer to Photoshop 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 CS4 JavaScript Scripting

Reference

,

Adobe Photoshop CS4 Visual Basic Scripting Reference

, and

Adobe Photoshop CS4 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.

N

OTE

:

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 81

.

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.

Section	Page
Adobe® Creative Suite® 4 Photoshop® Scripting Guide	2
Introduction	6
About this Manual	6
Conventions in this Guide	6
Photoshop Scripting Basics	8
Scripting Overview	8
Why use scripts instead of actions?	8
Scripting Support in Photoshop	9
JavaScript support	9
Executing other scripts	10
Startup scripts	10
Executing JavaScripts from AS or VBS	10
Photoshop Object Model	11
Containment hierarchy	11
Application and document classes	12
Layer classes	12
Layer Comp class	13
Channel class	13
Selection class	13
History State class	13
Document Info class	13
Path Item, Sub Path Item, and Path Point classes	14
Preferences class	14
Notifier class	14
Count Item class	14
Color Sampler class	14
Measurement Scale class	14
The containment hierarchy and the Photoshop user interface	14
Additional objects	16
Constants	16
Creating a sample Hello World script	17
Creating and running an AppleScript	18
Creating and running a VBScript	19
Creating and running a JavaScript	19
Scripting Photoshop	21
Viewing Photoshop Objects, Commands, and Methods	21
Viewing Photoshop’s AppleScript dictionary	21
Viewing Photoshop’s type library (VBS)	22
Targeting and Referencing the Application Object	22
Creating New Objects in a Script	23
Setting the Active Object	25
Setting the active document	26
Setting the active layer	27
Setting the active channels	28
Opening a Document	28
Opening a file with default file format	28
Specifying file formats to open	29
Saving a Document	31
Setting Application Preferences	32
Allowing or Preventing Dialogs	33
Working with the Photoshop Object Model	33
Using the Application object	34
Using the Document object	34
Manipulating a document object	35
Working with layer objects	36
Creating an ArtLayer object	37
Creating a Layer Set object	38
Referencing ArtLayer objects	38
Working with Layer Set objects	39
Linking layer objects	40
Applying styles to layers	40
Using the Text Item object	41
Determining a layer’s kind	41
Adding and manipulating text in a Text Item object	42
Working with Selection objects	42
Creating and defining a selection	43
Stroking the selection border	44
Inverting selections	44
Expanding, contracting, and feathering selections	44
Filling a selection	45
Loading and storing selections	45
Working with Channel objects	46
Changing channel types	46
Using the Document Info object	47
Using history state objects	47
Using Notifier objects	48
Using the PathItem object	49
Working with color objects	51
Solid color classes	52
Using hex values for RGB color	52
Getting and converting colors	52
Comparing colors	53
Getting a Web-safe color	53
Working with Filters	53
Other filters	54
Understanding Clipboard Interaction	54
Using the copy and paste commands	54
Using the copy merged command/method	55
Working with Units	56
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	60
Advanced Scripting	60
Working with document preferences	61
Applying color to a text item	64
Applying a wave filter	66
Defining the area of a selection object	67
Applying a MotionBlur filter	71
Action Manager	73
The ScriptListener Plug-In	73
Installing ScriptListener	73
Action Manager Scripting Objects	74
Recording a Script using ScriptListener	74
Using the Action Manager from JavaScript	75
Using the Action Manager from a VBS Script	76
Running JavaScript-based Action Manager code from VBScript	79
Running JavaScript-based Action Manager code from AppleScript	80
Using ScriptListener to find event IDs and class IDs	81

Adobe 65014293 Scripting Guide - Page 48

Using Notifier objects, Adobe Photoshop CS4 Visual Basic Scripting Reference

Page 48 highlights