Home » Adobe Manuals » Computer Software » Adobe 23102480 » Manual Viewer

Adobe 23102480 Scripting Guide - Page 5

Introduction, About this manual, Conventions in this guide - cs3

UPC - 883919080222

Add to My Manuals
Save this manual to your list of manuals

Page 5 highlights

1 Introduction About this manual This manual provides an introduction to scripting Adobe® Photoshop® CS3 on Mac OS® and Windows®. Chapter one covers the basic conventions used in this manual. Chapter two covers a brief overview of scripting, how to execute scripts, and the Photoshop CS3 object model. Chapter three covers Photoshop CS3-specific objects and components and describes advanced techniques for scripting the Photoshop CS3 application. Code examples are provided in three languages: ● AppleScript ● VBScript ● JavaScriptTM Note: Separate Photoshop CS3 Scripting reference information is provided for each of these languages through the Scripting Reference Manuals provided with this installation, or through the object browsers available for each language. See 'Viewing Photoshop CS3's AppleScript Dictionary' on page 19 and 'Viewing Photoshop CS3's Type Library (VBS)' on page 20. For information about using the Extend Script Object Model Viewer, see the JavaScript Tools Guide. Chapter four covers the Action Manager, which allows you to write scripts that target Photoshop CS3 functionality that is not otherwise accessible in the scripting interface. Note: Please review the README file shipped with Photoshop CS3 for late-breaking news, sample scripts, and information about outstanding issues. Conventions in this guide Code and specific language samples appear in monospaced courier font: app.documents.add Several conventions are used when referring to AppleScript, VBScript and JavaScript. Please note the following shortcut notations: ● AS stands for AppleScript ● VBS stands for VBScript ● JS stands for JavaScript The term "commands" will be used to refer both to commands in AppleScript and methods in VBScript and JavaScript. When referring to specific properties and commands, this manual follows the AppleScript naming convention for that property and the VBScript and JavaScript names appear in parenthesis. For example: "The display dialogs (DisplayDialogs/displayDialogs) property is part of the Application object." 5

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

Match case Limit results 1 per page

Introduction

About this manual

This manual provides an introduction to scripting Adobe

Photoshop

CS3 on Mac OS

and Windows

Chapter one covers the basic conventions used in this manual.

Chapter two covers a brief overview of scripting, how to execute scripts, and the Photoshop CS3 object

model.

Chapter three covers Photoshop CS3-specific objects and components and describes advanced

techniques for scripting the Photoshop CS3 application. Code examples are provided in three languages:

●

AppleScript

●

VBScript

●

JavaScript

Note:

Separate Photoshop CS3 Scripting reference information is provided for each of these languages

through the Scripting Reference Manuals provided with this installation, or through the object

browsers available for each language. See

‘Viewing Photoshop CS3’s AppleScript Dictionary’ on

page 19

and

‘Viewing Photoshop CS3’s Type Library (VBS)’ on page 20

. For information about using

the Extend Script Object Model Viewer, see the

JavaScript Tools Guide

Chapter four covers the Action Manager, which allows you to write scripts that target Photoshop CS3

functionality that is not otherwise accessible in the scripting interface.

Note:

Please review the

README

file shipped with Photoshop CS3 for late-breaking news, sample scripts,

and information about outstanding issues.

Conventions in this guide

Code and specific language samples appear in monospaced courier font:

app.documents.add

Several conventions are used when referring to AppleScript, VBScript and JavaScript. Please note the

following shortcut notations:

●

AS stands for AppleScript

●

VBS stands for VBScript

●

JS stands for JavaScript

The term “commands” will be used to refer both to commands in AppleScript and methods in VBScript and

JavaScript.

When referring to specific properties and commands, this manual follows the AppleScript naming

convention for that property and the VBScript and JavaScript names appear in parenthesis. For example:

“The

display dialogs (DisplayDialogs/displayDialogs)

property is part of the Application

object.”