Adobe 65014293 Scripting Guide - Page 47

C

HAPTER

3: Scripting Photoshop

Working with the Photoshop Object Model

47

AS

set kind of myChannel to selected area channel

VBS

channelRef.ind = 3 'for psSelectedAreaAlphaChannel

'from the constant value PsChannelType

JS

channelRef.kind = ChannelType.SELECTEDAREA

Using the Document Info object

In Photoshop, you can associate information with a document by choosing

File > File Info

.

To accomplish this task in a script, you use the

info-object

(

DocumentInfo/DocumentInfo)

object,

which is stored in the

info

(

Info

/

info

) property of the

Document

object. The following examples

demonstrate how to use the

DocumentInfo

object to set the copyrighted status and owner URL of a

document.

AS

set docInfoRef to info of current document

get EXIF of docInfoRef

set copyrighted of docInfoRef to copyrighted work

set owner url of docInfoRef to "http://www.adobe.com"

get EXIF of docInfoRef

VBS

Set docInfoRef = docRef.Info

docInfoRef.Copyrighted = 1 'for psCopyrightedWork

docInfoRef.OwnerUrl = "http://www.adobe.com"

JS

docInfoRef = docRef.info

docInfoRef.copyrighted = CopyrightedType.COPYRIGHTEDWORK

docInfoRef.ownerUrl = "http://www.adobe.com"

For information about other types of information (properties) you can associate with a document, look up

the following:

➤

In the

Adobe Photoshop CS4 AppleScript Scripting Reference

or in the Photoshop AppleScript Dictionary,

look up the properties for the class

info-object

.

➤

In the

Adobe Photoshop CS4 Visual Basic Scripting Reference

, the

Adobe Photoshop CS4 JavaScript

Scripting Reference

, the Visual Basic Object Browser or the ExtendScript Object Model Viewer, look up

the properties for the

DocumentInfo

object.

Using history state objects

Photoshop keeps a history of the actions that affect documents. Each time you apply a change to an image

in the Photoshop application, you create a

history state

; you can access a document’s history states from

the History palette by selecting

Window > History

. See Photoshop Help for additional information about

History State.

In a script, you can access a

Document

object’s history states using the

HistoryStates

object, which is a

property of the

Document

object. You can use a

HistoryStates

object to reset a document to a previous

state or to fill a

Selection

object.

The following examples revert the document contained in the variable

docRef

back to the form and

properties it had when it was first opened or created. Using history states in this fashion gives you the

ability to undo modifications to the document.

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 47

Using the Document Info object, Using history state objects, File > File Info, Window > History

Page 47 highlights