Beruflich Dokumente
Kultur Dokumente
bc
Contents
1
Introduction ................................................................................................................................. 5
Changes Since Earlier Versions.................................................................................................................................................. 5
VBScript Interface........................................................................................................................ 7
Working with the Properties Tables ........................................................................................................................................ 7
Working with the Methods Tables ........................................................................................................................................... 7
ActionDescriptor ............................................................................................................................................................................ 9
ActionList.........................................................................................................................................................................................12
ActionReference ...........................................................................................................................................................................15
Application .....................................................................................................................................................................................17
ArtLayer............................................................................................................................................................................................24
ArtLayers..........................................................................................................................................................................................35
BatchOptions .................................................................................................................................................................................36
BitmapConversionOptions .......................................................................................................................................................38
BMPSaveOptions ..........................................................................................................................................................................39
CameraRAWOpenOptions ........................................................................................................................................................40
Channel............................................................................................................................................................................................42
Channels ..........................................................................................................................................................................................43
CMYKColor......................................................................................................................................................................................49
ColorSampler .................................................................................................................................................................................50
ColorSamplers ...............................................................................................................................................................................51
ContactSheetOptions .................................................................................................................................................................52
CountItem .......................................................................................................................................................................................54
CountItems .....................................................................................................................................................................................55
DCS1_SaveOptions......................................................................................................................................................................56
DCS2_SaveOptions......................................................................................................................................................................57
DICOMOpenOptions ...................................................................................................................................................................58
Document .......................................................................................................................................................................................59
DocumentInfo ...............................................................................................................................................................................68
Documents .....................................................................................................................................................................................71
EPSOpenOptions ..........................................................................................................................................................................72
EPSSaveOptions............................................................................................................................................................................73
ExportOptionsIllustrator ............................................................................................................................................................74
ExportOptionsSaveForWeb ......................................................................................................................................................75
GalleryBannerOptions ................................................................................................................................................................77
GalleryCustomColorOptions ....................................................................................................................................................78
GalleryImagesOptions ................................................................................................................................................................79
GalleryOptions...............................................................................................................................................................................81
GallerySecurityOptions ..............................................................................................................................................................83
GalleryThumbnailOptions.........................................................................................................................................................84
GIFSaveOptions.............................................................................................................................................................................85
GrayColor.........................................................................................................................................................................................87
HistoryState ....................................................................................................................................................................................88
HistoryStates ..................................................................................................................................................................................89
HSBColor..........................................................................................................................................................................................90
IndexedConversionOptions .....................................................................................................................................................91
3
JPEGSaveOptions .........................................................................................................................................................................93
LabColor ..........................................................................................................................................................................................94
LayerComp......................................................................................................................................................................................95
LayerComps....................................................................................................................................................................................96
Layers................................................................................................................................................................................................97
LayerSet ...........................................................................................................................................................................................98
LayerSets ...................................................................................................................................................................................... 100
MeasurementLog ...................................................................................................................................................................... 102
MeasurementScale ................................................................................................................................................................... 103
NoColor ......................................................................................................................................................................................... 104
Notifier........................................................................................................................................................................................... 105
Notifiers......................................................................................................................................................................................... 106
PathItem ....................................................................................................................................................................................... 108
PathItems ..................................................................................................................................................................................... 112
PathPoint...................................................................................................................................................................................... 113
PathPointInfo.............................................................................................................................................................................. 114
PathPoints.................................................................................................................................................................................... 115
PDFOpenOptions ...................................................................................................................................................................... 116
PDFSaveOptions ........................................................................................................................................................................ 117
PhotoCDOpenOptions ............................................................................................................................................................ 120
PhotoshopSaveOptions .......................................................................................................................................................... 121
PICTFileSaveOptions ................................................................................................................................................................ 122
PicturePackageOptions........................................................................................................................................................... 123
PixarSaveOptions ...................................................................................................................................................................... 124
PNGSaveOptions ....................................................................................................................................................................... 125
Preferences .................................................................................................................................................................................. 126
PresentationOptions ................................................................................................................................................................ 131
RawFormatOpenOptions ....................................................................................................................................................... 132
RawSaveOptions........................................................................................................................................................................ 133
RGBColor....................................................................................................................................................................................... 134
Selection ....................................................................................................................................................................................... 135
SGIRGBSaveOptions ................................................................................................................................................................. 141
SolidColor..................................................................................................................................................................................... 142
SubPathInfo................................................................................................................................................................................. 143
SubPathItem................................................................................................................................................................................ 144
SubPathItems.............................................................................................................................................................................. 145
TargaSaveOptions..................................................................................................................................................................... 146
TextFont........................................................................................................................................................................................ 147
TextFonts...................................................................................................................................................................................... 148
TextItem........................................................................................................................................................................................ 149
TiffSaveOptions.......................................................................................................................................................................... 155
XMPMetadata ............................................................................................................................................................................. 157
Introduction
This reference describes the objects and commands in the Adobe Photoshop CS 3 VBScript dictionary. A
companion document, Photoshop CS3 Scripting Guide, describes basic scripting concepts and the
Photoshop object model. This document provides reference details of the Photoshop object model, and
additional information on VBScript-specific features.
This book contains the following sections:
This introduction, which describes scripting support in Adobe Photoshop CS3, and lists changes to the
VBScript interface since the previous release.
VBScript Interface on page 7, which describes the objects of the VBScript type library for Adobe
Photoshop CS3.
Scripting Constants on page 158, which describes the enumerated values defined for use with Adobe
Photoshop CS3 VBScript properties and methods.
Documentation Changes:
Documentation that provides an overview of Scripting is now found in a new document entitled
Introduction to Scripting, instead of in the Photoshop CS3 Scripting Guide.
Photoshop CS3 has an Extended Version and a Standard Version. Some additional features are available
in the Extended Version.
CountItems provides support in scripting for the Count Tool. A new collection, CountItems, is defined,
with a corresponding CountItems property on Document, that refers to the collection CountItems.
ColorSamplers have been provided for the Document object. A new collection, ColorSamplers, is
defined, with a corresponding ColorSamplers property on Document that refers to the collection
ColorSamplers.
DICOMOpenOptions is a new class that provides opens when opening a file in the DICOM format; this
The measurement scale feature adds a MeasurementScale property to the Document object, which
accesses the MeasurementScale object. The MeasurementScale property on Document is read-only
(i.e. you cannot create a new MeasurementScale object), but the properties of the MeasurementScale
object ( PixelLength, LogicalLength, and LogicalUnits) can be set directly. This feature is only
available in the Extended Version.
Application.OpenDialog: Allows you to use the Photosho open dialog to select files.
Introduction
Document.Duplicate: Provides new parameters for naming the duplciated document and setting
Documents.Add: Provides new parameters for document depth and color profile name.
New properties:
Solid, boolean, added to Selection object, indicates if the bounding rectangle is solid.
Modified enumerations:
Bug fixes
The Document.ResizeImage command now behaves correctly for percentages. In CS2, it was off by 2
decimal places. (E.g 25% = 0.25)
The LensBlurOptions object has been removed. All options for the Lens Blur filter now appear directly
as parameters to the ArtLayer.ApplyLensBlur() method.
Fixed CameraRAWOpenOptions.
VBScript Interface
The objects of the VBScript type library for Adobe Photoshop CS3 are presented alphabetically and in
tabular format in this chapter.
Object properties and methods are described in separate tables for each object. See Working with the
Properties Tables on page 7 and Working with the Methods Tables on page 7 for information on how to
use these tables.
Sample code for several object model classes is given to help illustrate the syntax as well as usage of the
object class.
Property
Value Type
DisplayDialogs PsDialogModes
What it is
Read-write. Controls whether or not Adobe Photoshop CS3
displays dialog boxes.
Parameter(s)
When a parameter type or return value is a constant or another object, the value is a hypertext link to
the constants or objects listing. In the following Methods table sample, the parameter type
ActionDescriptor is an object; the parameter type DialogModes is a constant; the return value
ActionDescriptor is also an object.
Parameters can be required or optional. Optional parameters are indicated in the table by square
brackets ([]). See Working with Method Parameters on page 8 for information on using parameters.
A description, if applicable
Method
VBScript Interface
Parameter Type
ExecuteAction
(EventID
[, Descriptor]
[, DisplayDialogs])
Returns
What it does
ActionDescriptor
Number (Long)
ActionDescriptor
PsDialogModes
VBScript Interface
ActionDescriptor
A record of key-value pairs for actions, such as those included on the Adobe Photoshop CS3 Actions menu.
Note: The ActionDescriptor class is part of the Action Manager functionality. See the Photoshop CS3
Scripting Guide.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
typename
String
Methods
Method
Parameter Type
Returns
What it does
Clears the descriptor.
Clear
()
Erase
(Key)
Number (Long)
GetBoolean
(Key)
GetClass
(Key)
Number (Long)
Number (Long)
Number (Long)
ActionList
Number (Long)
Number (Long)
GetObjectType
(Key)
Number (Long)
Number (Long)
GetList
(Key)
Number (Long)
GetKey
(Index)
Number (Double)
Number (Long)
GetInteger
(Key)
Number (Long)
GetEnumerationValue
(Key)
Number (Long)
Number (Long)
GetEnumerationType
(Key)
Number (Long)
GetDouble
(Key)
Boolean
Number (Long)
Number (Long)
Method
VBScript Interface
Parameter Type
Number (Long)
object.
String
GetPath
(Key)
GetObjectValue
(Key)
Returns
10
Number (Long)
GetReference
(Key)
GetString
(Key)
ActionDescriptor
PutBoolean
(Key,
Value)
Number (Long)
Boolean
PutClass
((Key,
Value)
Number (Long)
Number (Long)
PutDouble
(Key,
Value)
Number (Long)
Number (Double)
PutEnumerated
(Key,
EnumType,
Value)
Number (Long)
Number (Long)
Number (Long)
PutInteger
(Key,
Value)
Number (Long)
Number (Long)
PutList
(Key,
Value)
Number (Long)
Number (Double)
Boolean
Boolean
Number (Long)
IsEqual
(otherDesc)
PsDescValueType
Number (Long)
HasKey
(Key)
Number (Long)
GetUnitDoubleValue
(Key)
String
Number (Long)
GetUnitDoubleType
(Key)
Number (Long)
GetType
(Key)
ActionReference
Number (Long)
Number (Long)
ActionList
Method
VBScript Interface
Parameter Type
PutObject
(Key,
ClassID,
Value)
Number (Long)
Number (Long)
ActionDescriptor
PutPath
(Key,
Value)
Number (Long)
String
Number (Long)
ActionReference
PutString
(Key,
Value)
Number (Long)
String
PutUnitDouble
(Key,
UnitID,
Value)
PutReference
(Key,
Value)
Returns
11
Number (Long)
Number (Long)
Number (Double)
VBScript Interface
12
ActionList
The list of commands that comprise an Action (such as an Action created using the Actions palette in the
Adobe Photoshop CS3 application).
Note: The actionList object is part of the Action Manager functionality. For details on using the Action
Manager, see the Photoshop CS3 Scripting Guide.
Properties
Property
Value Type
What it is
Application
Object (Application)
Count
Number (Long)
typename
String
Methods
With the exception of the Clear() method, you use the methods of this object to either get the value of a
specific type of data in the list or set (put) the value type.
Method
Parameter Type
Returns
What it does
Clears the list.
Clear
()
GetBoolean
(Index)
GetClass
(Index)
Number (Long)
Number (Long)
ActionList
Number (Long)
ActionDescriptor
Number (Long)
GetObjectValue
(Index)
Number (Long)
Number (Long)
GetObjectType
(Index)
Number (Long)
GetList
(Index)
Number (Double)
Number (Long)
GetInteger
(Index)
Number (Long)
GetEnumerationValue
(Index)
Number (Long)
Number (Long)
GetEnumerationType
(Index)
Number (Long)
GetDouble
(Index)
Boolean
Number (Long)
Number (Long)
Method
VBScript Interface
Parameter Type
GetPath
(Index)
13
Returns
String
Number (Long)
String
PsDescValueType
Number (Long)
Number (Double)
Number (Long)
Boolean
GetReference
(Index)
Number (Long)
GetString
(Index)
Number (Long)
GetType
(Index)
Number (Long)
GetUnitDoubleType
(Index)
Number (Long)
GetUnitDoubleValue
(Index)
PutBoolean
(Value)
PutClass
(Value)
Number (Long)
PutDouble
(Value)
Number (Double)
PutEnumerated
(EnumType,
Value)
Number (Long)
Number (Long)
Number (Long)
ActionList
PutInteger
(Value)
PutList
(Value)
PutObject
(ClassID,
Value)
Number (Long)
ActionDescriptor
PutPath
(Value)
String
PutReference
(Value)
ActionReference
Method
VBScript Interface
Parameter Type
Number (Long)
Number (Double)
PutUnitDouble
(UnitID,
Value)
String
PutString
(Value)
Returns
14
VBScript Interface
15
ActionReference
A reference object that contains the data describing the object you are referring to.
Note: The actionReference object is part of the Action Manager functionality. See the Photoshop CS3
Scripting Guide.
Properties
Property
Value type
What it does
Application
Object
(Application)
typename
String
Methods
Method
GetContainer
Parameter Type
Returns
What it does
ActionReference
()
Number (Long)
Number (Long)
Number (Long)
()
GetEnumeratedType
()
GetEnumeratedValue
()
GetForm
()
GetIdentifier
Number (Long)
String
Number (Long)
()
GetIndex
()
GetName
()
GetOffset
()
Method
VBScript Interface
Parameter Type
GetProperty
Returns
Number (Long)
16
()
Number (Long)
Number (Long)
Number (Long)
Number (Long)
PutClass
(DesiredClass)
PutEnumerated
(DesiredClass,
EnumType,
Value)
PutIdentifier
(DesiredClass,
Value)
Number (Long)
Number (Long)
PutIndex
(DesiredClass,
Value)
Number (Long)
Number (Long)
PutName
(DesiredClass,
Value)
Number (Long)
String
PutOffset
(DesiredClass,
Value)
Number (Long)
Number (Long)
PutProperty
(DesiredClass,
Value)
Number (Long)
Number (Long)
VBScript Interface
17
Application
The Adobe Adobe Photoshop CS3 application object. The Application object contains all other Adobe
Photoshop CS3 objects.
Properties
Property
Value Type
What it is
ActiveDocument
Document
Application
Object
(Application)
BackgroundColor
SolidColor
ColorSettings
String
DisplayDialogs
PsDialogModes
Documents
Documents
Fonts
TextFonts
ForegroundColor
SolidColor
FreeMemory
Number (Double)
Locale
String
MacintoshFileTypes
Array of String
MeasurementLog
MeasurementLog
Name
String
Notifiers
Notifiers
NotifiersEnabled
Boolean
Path
String
VBScript Interface
18
Property
Value Type
What it is (Continued)
Preferences
Preferences
PreferencesFolder
String
RecentFiles
Array of String
ScriptingBuildDate
String
ScriptingVersion
String
typename
String
Version
String
Visible
Boolean
WinColorSettings
String
WindowsFileTypes
Array of String
VBScript Interface
19
Methods
Method
Parameter Type
Batch
(InputFiles,
Action,
From
[, Options])
Returns
What it does
String
Array of String
String
String
BatchOptions
Note: The
inputFiles
parameter
specifies the
source for the
files (as an
array of
String) to be
manipulated
by the Batch
command.
None
ChangeColorSettings
([Name]
[, File])
String
String
CharIDToTypeID
(CharID)
DoAction
(Action,
From)
String
Array
PsJavaScriptExecutionMode
String
String
ActionDescriptor Plays an
ExecuteAction
(EventID
[, Descriptor]
[, DisplayDialogs])
none
String
Array
PsJavaScriptExecutionMode
DoJavaScriptFile
(JavaScriptFile,
[, Arguments]
[, ExecutionMode]))
String
String
DoJavaScript
(JavaScriptCode,
[, Arguments]
[, ExecutionMode]))
Number (Long)
String
Number (Long)
ActionDescriptor
PsDialogModes
ActionManager event.
Method
VBScript Interface
Parameter Type
Returns
ActionReference
ActionDescriptor Obtains an
ActionDescriptor.
ExecuteActionGet
(Reference)
Boolean
FeatureEnabled
(Name
)
20
String
What it does
Determines whether
the feature specified
by Name is enabled.
The following
features are
supported as values
for Name:
photoshop/extend
ed
photoshop/standa
rd
photoshop/trial
Loads a support
document from the
specified file path
location.
Load
(Document)
String
MakeContactSheet
(InputFiles
[, Options])
MakePDFPresentation
(InputFiles
OutputFiles
[, Options])
String
Creates a contact
sheet from the
specified files.
String
Creates a PDF
presentation file from
the specified input
files.
Array of String
ContactSheetOptions
Array of String
String
PresentationOptions
MakePhotomerge
String
String
Deprecated for
Adobe Photoshop
CS3.
String
String
GalleryOptions
Array of String
(InputFiles)
MakePicturePackage
(InputFiles
[, Options])
Array of String
PicturePackageOptions
Creates a picture
package from the
specified input files.
Method
VBScript Interface
Parameter Type
Open
(Document
[, As]
[, AsSmartObject]
)
Returns
What it does
Document
String
object (open options)
Boolean
AsSmartObject
(default:false)
indicates whether to
create a smart object
around the opened
document.
Array of String
OpenDialog
21
()
Purge
(Target)
PsPurgeTarget
Quit
()
Refresh
()
StringIDToTypeID
(StringID)
TypeIDToCharID
(TypeID)
Converts from a
String ID to a runtime
ID.
String
Converts from a
runtime ID to a
character ID.
String
Converts from a
runtime ID to a String
ID.
Number (Long)
TypeIDToStringID
(TypeID)
Number (Long)
String
Number (Long)
VBScript Interface
Application.vbs
'
'
'
'
22
VBScript Interface
PDFPresentation.vbs
' use all the files in the Samples folder
Dim appRef, inputFiles(), i, outputFile, options, objWshShell
Set appRef = CreateObject("Photoshop.Application")
' get all the files found in this folder
Set fsoRef = CreateObject( "Scripting.FileSystemObject" )
Set folderRef = fsoRef.GetFolder( appRef.Path & "Samples\" )
ReDim inputFiles(folderRef.Files.Count-1)
i = 0
For Each f in folderRef.Files
inputFiles(i) = f.Path
i = i + 1
Next
' Get a shell object so we can point to the desktop
Set shellRef = WScript.CreateObject("Wscript.Shell")
outputFile = shellRef.SpecialFolders("Desktop") & "\VBSPresentation.pdf"
' there are defaults but I like to set the options myself
Set options = CreateObject("Photoshop.PresentationOptions")
options.Presentation = true
options.PDFFileOptions.Encoding = 2 'for PsPDFEncoding --> 2 (psPDFJPEG)
options.AutoAdvance = true
options.Interval = 5
options.Loop = false
options.Transition = 10 'for PsTransitionType --> 10 (psRandom)
' create the presentation
appRef.MakePDFPresentation inputFiles, outputFile, options
Set objWshShell = WScript.CreateObject("Wscript.Shell")
WScript.Echo "Presentation file saved in: " &
_
shellRef.SpecialFolders("Desktop") & "\VBSPresentation.pdf"
23
VBScript Interface
24
ArtLayer
An object within a document that contains the visual elements of the image (equivalent to a layer in the
Adobe Photoshop CS3 application).
Properties
Property
Value Type
What it is
AllLocked
Boolean
Application
Object
(Application)
BlendMode
PsBlendMode
Bounds
Array
FillOpacity
100.0).
Grouped
Boolean
IsBackgroundLayer
Boolean
Kind
PsLayerKind
LinkedLayers
Array of
Read-only. The layers linked to this layer.
ArtLayer and/or
LayerSet
Name
String
Opacity
100.0).
Parent
Object
(Document)
VBScript Interface
25
Property
Value Type
What it is (Continued)
PixelsLocked
Boolean
PositionLocked
Boolean
TextItem
TextItem
TransparentPixelsLocked
Boolean
typename
String
Visible
Boolean
Methods
Method
Parameter Type
AdjustBrightnessContrast
(Brightness,
Contrast)
Number (Long)
Number (Long)
AdjustColorBalance
([Shadows]
[, Midtones]
[, Highlights]
[, PreserveLuminosity]
Array of Number
Array of Number
Array of Number
Boolean
Returns
What it does
Adjusts the brightness (-100 100) and contrast (-100 - 100).
Adjusts the color balance of the
layers component channels. For
Shadows, Midtones, and
Highlights, the array must
include three values (-100 - 100),
which represent cyan or red,
magenta or green, and yellow or
blue, when the document mode
is CMYK or RGB.
Note: See mode in the Properties
table of the Document
object.
AdjustCurves
(CurveShape)
Array of points
(Array (Array(x, y)))
AdjustLevels
(InputRangeStart,
InputRangeEnd,
InputRangeGamma,
OutputRangeStart,
OutputRangeEnd)
Number
Number
Number
Number
Number
(Long)
(Long)
(Double)
(Long)
(Long)
Method
VBScript Interface
Parameter Type
ApplyAddNoise
(Amount,
Distribution,
Monochromatic)
Number (Double)
PsNoiseDistribution
Boolean
Returns
26
ApplyAverage
()
ApplyBlur
()
ApplyBlurMore
()
ApplyClouds
()
ApplyCustomFilter
(Characteristics,
Scale,
Offset)
Array of twenty-five
Numbers (Long)
Number (Long)
Number (Long)
ApplyDeInterlace
(EliminateFields,
CreateFields)
PsEliminateFields
PsCreateFields
ApplyDespeckle
()
ApplyDifferenceClouds
()
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
PsDisplacementMapType
PsUndefinedAreas
String
Number (Long)
Number (Long)
Number (Double)
ApplyDiffuseGlow
(Graininess,
GlowAmount,
ClearAmount)
ApplyDisplace
(HorizontalScale,
VerticalScale,
DisplacementType,
UndefinedAreas,
DisplacementMapFiles)
ApplyDustAndScratches
(Radius,
Threshold)
ApplyGaussianBlur
(Radius)
Method
VBScript Interface
Parameter Type
ApplyGlassEffect
(Distortion,
Smoothness,
Scaling
[, Invert]
[, Texture]
[, TextureFile])
Number (Long)
Number (Long)
Number (Long)
Boolean
PsTextureType
String
ApplyHighPass
(Radius)
Number (Double)
ApplyLensBlur
([Source]
[, FocalDistance]
[, InvertDepthMap]
[, Shape]
[, Radius]
[, BladeCurvature]
[, Rotation]
[, Brightness]
[, Threshold]
[, Amount]
[, Distribution]
[, Monochromatic]
)
Returns
27
PsDepthMapSource
Number (Long)
Boolean
PsGeometry
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
PsNoiseDistribution
Boolean
Method
VBScript Interface
Parameter Type
ApplyLensFlare
(Brightness,
FlareCenter,
LensType)
Number (Long)
Array (Double)
PsLensType
Number (Double)
Number (Double)
Number (Long)
Number (Double)
ApplyMinimum
(Radius)
ApplyMotionBlur
(Angle,
Radius)
ApplyMedianNoise
(Radius)
Number (Double)
ApplyMaximum
(Radius)
Returns
28
ApplyNTSC
()
ApplyOceanRipple
(Size,
Magnitude)
Number (Long)
Number (Long)
ApplyOffset
(Horizontal,
Vertical,
UndefinedAreas)
Number (Double)
Number (Double)
PsOffsetUndefinedAreas
PsPolarConversionType
Number (Long)
PsRadialBlurMethod
PsRadialBlurQuality
Number (Long)
PsRippleSize
ApplyPolarCoordinates
(Conversion)
ApplyRadialBlur
(Amount,
BlurMethod,
BlurQuality)
ApplyRipple
(Amount,
Size)
ApplySharpen
()
Number (Long)
ApplyPinch
(Amount)
Method
VBScript Interface
Parameter Type
Returns
29
ApplySharpenEdges
()
ApplySharpenMore
()
ApplyShear
(Curve,
UndefinedAreas)
Array of points
(Array (Array(x, y)))
PsUndefinedAreas
ApplySmartBlur
(Radius,
Threshold,
BlurQuality,
Mode)
Number (Double)
Number (Double)
PsSmartBlurQuality
PsSmartBlurMode
String
ApplyStyle
(StyleName)
Number (Long)
PsSpherizeMode
ApplySpherize
(Amount,
Mode)
ApplyTextureFill
(TextureFile)
String
Number (Long)
Number (Double)
Number (Double)
Number (Long)
ApplyTwirl
(Angle)
ApplyUnSharpMask
(Amount,
Radius,
Threshold)
ApplyWave
(GeneratorNumber,
MinimumWavelength,
MaximumWavelength,
MinimumAmplitude,
MaximumAmplitude,
HorizontalScale,
VerticalScale,
WaveType,
UndefinedAreas,
RandomSeed)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
Number (Long)
PsWaveType
PsUndefinedAreas
Number (Long)
Method
VBScript Interface
Parameter Type
ApplyZigZag
(Amount,
Ridges,
Style)
Number (Long)
Number (Long)
PsZigZagType
AutoContrast
()
AutoLevels
()
Clear
()
Copy
([Merge])
Returns
30
Boolean
Cut
()
Desaturate
()
Duplicate
([RelativeObject]
[, InsertionLocation])
Object (ArtLayer or
LayerSet)
PsElementPlacement
Equalize
()
Invert
()
Link
(With)
on the screen.
Object (ArtLayer or
LayerSet)
Method
VBScript Interface
Parameter Type
Merge
()
MixChannels
(OutputChannels
[, Monochrome])
Returns
31
Array of Array of
Number (Double)
Boolean
Object (ArtLayer or
LayerSet)
PsElementPlacement
PhotoFilter
([FillColor]
[, Density]
[, PreserveLuminosity])
SolidColor
Number (Long)
Boolean
Posterize
(Levels)
Number (Long)
Rasterize
(Target)
PsRasterizeType
Method
VBScript Interface
Parameter Type
Resize
([Horizontal]
[, Vertical]
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
Rotate
(Angle
[, Anchor])
Number (Double)
PsAnchorPosition
SelectiveColor
(SelectionMethod
[, Reds]
[, Yellows]
[, Greens]
[, Cyans]
[, Blues]
[, Magentas]
[, Whites]
[, Neutrals]
[, Blacks])
PsAdjustmentReference
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
Array of Number (Long)
ShadowHighlight
([ShadowAmount]
[, ShadowWidth]
[, ShadowRadius]
[, HighlightAmount]
[, HighlightWidth]
[, HighlightRadius]
[, ColorCorrection]
[, MidtoneContrast]
[, BlackClip]
[, WhiteClip])
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
(Long)
(Long)
(Long)
(Long)
(Long)
(Long)
(Long)
(Long)
(Double)
(Double)
Threshold
(Level)
Number (Long)
Translate
([DeltaX]
[, DeltaY])
Unlink
()
Number (Double)
Number (Double)
Returns
32
VBScript Interface
33
Sample Script
The following script closes any open documents (files), then opens each file in the Samples folder, creating
an art layer for each image and using the images file name as the layer name.
ArtLayer.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, mergedDoc
Dim fsoRef, folderRef, topLeftH, topLeftV, docH, docV, docName, selRegion
Dim x, y, layer1, layer2
Set appRef = CreateObject("Photoshop.Application")
' Save the current preferences
startRulerUnits = appRef.Preferences.RulerUnits
startTypeUnits = appRef.Preferences.TypeUnits
startDisplayDialogs = appRef.DisplayDialogs
' Set Photoshop CS3 to use pixels and display no dialogs
appRef.Preferences.RulerUnits = 1 'for PsUnits --> 1 (psPixels)
appRef.Preferences.TypeUnits = 1 'for PsTypeUnits --> 1 (psPixels)
appRef.DisplayDialogs = 3 'for PsDialogModes --> 3 (psDisplayNoDialogs)
' Close all the open documents
Do While appRef.Documents.Count
appRef.ActiveDocument.Close()
Loop
' Create a new document to merge all the samples into
Set mergedDoc = appRef.Documents.Add(1000, 1000, 72, "Merged Samples", 2, 3, 1)
'enumerated values 2 = PsNewDocumentMode --> 2 (PsNewRGB) and
'3 = PsDocumentFill --> 3 (psTransparent)
' get all the files found in this folder
Set fsoRef = CreateObject( "Scripting.FileSystemObject" )
Set folderRef = fsoRef.GetFolder( appRef.Path & "Samples\" )
Randomize
' open each file
For Each f in folderRef.Files
appRef.Open f.Path
' use the document name for the layer name in the merged document
docName = appRef.ActiveDocument.Name
' flatten the document so we get everything and then copy
appRef.ActiveDocument.flatten()
appRef.ActiveDocument.Selection.SelectAll()
appRef.ActiveDocument.Selection.Copy()
' dont save anything we did
appRef.ActiveDocument.Close(2)
'the enumerated value Close(2) = PsSaveOptions >2 (psDoNotSaveChanges)
' make a random selection on the document to paste into
' by dividing the document up in 4 quadrants and pasting
' into one of them by selecting that area
topLeftH = Int(Rnd() * 2)
topLeftV = Int(Rnd() * 2)
VBScript Interface
34
VBScript Interface
35
ArtLayers
The collection of ArtLayer objects in the document.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object
(Document)
typename
String
Methods
Method
Parameter Type
Add
Returns
What it does
ArtLayer
Number
(long)
ArtLayer
Nothing
()
Index
(ItemPtr)
Object
(ArtLayer)
Item
(ItemKey)
RemoveAll
()
Number (Long)
VBScript Interface
36
BatchOptions
Options to specify when running a Batch command.
Properties
Property
Value type
What it is
Application
Object (Application)
Destination
DestinationFolder
String
ErrorFile
String
FileNaming
Array of
(PsFileNamingType
options)
MacintoshCompatible
Boolean
OverrideOpen
Boolean
OverrideSave
Boolean
StartingSerial
Number (Long)
VBScript Interface
37
Property
Value type
What it is (Continued)
SuppressOpen
Boolean
SuppressProfile
Boolean
typename
String
UnixCompatible
Boolean
WindowsCompatible
Boolean
VBScript Interface
38
BitmapConversionOptions
Options to specify when converting an image to Bitmap mode.
Note: Convert color images to grayscale before converting the image to bitmap mode. See Desaturate
on page 30 (in the Properties table of the ArtLayer object).
Properties
Property
Value Type
What it is
Angle
Number (Double)
Application
Object (Application)
Frequency
Number (Double)
Method
PatternName
String
Resolution
Number (Double)
Shape
PsBitmapHalfToneType
typename
String
VBScript Interface
BMPSaveOptions
Options that can be specified when saving a document in BMP format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object
(Application)
Depth
PsBMPDepthType
FlipRowOrder
Boolean
OSType
PsOperatingSystem
RLECompression
Boolean
typename
String
39
VBScript Interface
40
CameraRAWOpenOptions
Options that can be specified when opening a document in Camera Raw format.
Properties
Property
Value type
What it is
Application
Object (Application)
BitsPerChannel
PsBitsPerChannelType
BlueHue
Number (Long)
BlueSaturation
Number (Long)
Brightness
Number (Long)
ChromaticAberrationBY
Number (Long)
ChromaticAberrationRC
Number (Long)
ColorNoiseReduction
Number (Long)
ColorSpace
PsColorSpaceType
Contrast
Number (Long)
Exposure
Number (Double)
GreenHue
Number (Long)
GreenSaturation
Number (Long)
LuminanceSmoothing
Number (Long)
RedHue
Number (Long)
RedSaturation
Number (Long)
Resolution
Number (Double)
VBScript Interface
41
Property
Value type
What it is (Continued)
Saturation
Number (Long)
Settings
Shadows
Number (Long)
ShadowTint
Number (Long)
Sharpness
Number (Long)
Size
PsCameraRAWSize
Temperature
Number (Long)
Tint
Number (Long)
typename
String
VignettingAmount
Number (Long)
VignettingMidpoint
Number (Long)
WhiteBalance
PsWhiteBalanceType
VBScript Interface
42
Channel
Object that stores information about a color element in the image, analogous to a plate in the printing
process that applies a single color. The documents color mode determines the number of default
channels; for example, an RGB document has four default channels:
A channel can also be an alpha channel, which stores selections as masks, or a spot channel, which stores
spot colors.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Color
Object
(SolidColor)
Histogram
Array of 256
Numbers (Long)
Kind
PsChannelType
Name
String
Opacity
Number (Double)
Parent
Object (Document)
typename
String
Visible
Boolean
Methods
Method
Parameter Type
Returns
What it does
Deletes the channel.
Delete
()
Channel
Duplicate
([TargetDocument])
Merge
()
Document
VBScript Interface
43
Channels
The collection of Channel objects in the document. See Channel on page 42.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
typename
String
Parameter Type
Returns
What it does
Channel
Number (Long)
Channel
Methods
Method
Add
()
Index
(ItemPtr)
Object (Channel)
Item
(ItemKey)
Number(Long)
RemoveAll
()
Sample Script
The following script checks for any open documents (files); if no documents are open, it opens fish.psd
in the Samples folder.
The script then creates the histogram for each channel in the document and creates a log file named
Histogram.log on your Desktop. The file maps out the histogram for each channel and includes the
following information:
Pixel count row by row, represented in rows of Xs, produces a strobe effect, as a progression of dialogs
display.
Histogram.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, docRef
VBScript Interface
44
VBScript Interface
45
VBScript Interface
46
Case 1
visibleChannelCount
Case 5
visibleChannelCount
Case 6
visibleChannelCount
Case 8
visibleChannelCount
Case 2
visibleChannelCount
Case 4
visibleChannelCount
Case 3
visibleChannelCount
Case 8
visibleChannelCount
Case 7
visibleChannelCount
Case Else
visibleChannelCount
End Select
VBScript Interface
= 1
= 1
= 1
= 2
= 3
= 3
= 4
= 4
= (inDocument.Channels.Count + 1)
= (inDocument.Channels.Count + 1)
47
VBScript Interface
numPixels = 0
sum1 = 0.0
sum2 = 0.0
' Compute totals for the various statistics
For gray = 0 To 255
x = inputArray(gray)
numPixels = numPixels + x
sum1 = sum1 + x * gray
sum2 = sum2 + x * (gray * gray)
Next
AverageHistogram =
sum1 / numPixels
End Function
Private Function MedianHistogram(inputArray, numPixels)
Dim gray, total, mid
gray = 0
total = inputArray(0)
mid = (numPixels + 1) / 2
Do While (total < mid)
gray = gray + 1
total = total + inputArray(gray)
Loop
MedianHistogram = gray
End Function
48
VBScript Interface
49
CMYKColor
The definition of a CMYK color.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Black
Number (Double) Read-write. The black color value (as percent) (0.0 - 100.0).
Cyan
Number (Double) Read-write. The cyan color value (as percent) (0.0 - 100.0).
Magenta
(0.0 - 100.0).
Read-only. The class name of the referenced CMYKColor object.
typename
String
Yellow
(0.0 - 100.0).
VBScript Interface
50
ColorSampler
A color sampler for the document.
Note: For additional information about color samplers, see Adobe Photoshop CS3 help on the Color
SamplerTool.
Properties
Property
Value type
What it is
Color
SolidColor
Position
Array of Number
(Double)
Parent
object
(Document)
typename
String
Parameter type
Returns
Methods
Method
Move
(position)
Array of Number
(Double)
What it does
Moves the color sampler to a new location
in the document.
The position parameter (x,y) represents
the new horizontal and vertical locations,
respectively, of the moved color sampler.
Delete
()
VBScript Interface
51
ColorSamplers
The collection of ColorSampler objects in the document. See ColorSampler.
Properties
Property
Value Type
What it is
Length
number (Long)
Parent
typename
string
Parameter Type
Returns
What it does
ColorSampler
Methods
Method
Add
(position)
Index
(ItemPtr)
Array of Number
(Double)
object
(ColorSampler)
Item
(ItemKey)
RemoveAll
()
number
ColorSampler
VBScript Interface
52
ContactSheetOptions
Options that can be specified for a contact sheet.
Properties
Property
Value Type
What it is
AcrossFirst
Boolean
Application
Object
(Application)
BestFit
Boolean
Caption
Boolean
ColumnCount
Number (Long)
Flatten
Boolean
Font
PsGalleryFontType
FontSize
Number (Long)
Height
Number (Long)
Horizontal
Number (Long)
Mode
PsNewDocumentMode
Resolution
Number (Double)
RowCount
Number (Long)
typename
String
UseAutoSpacing
Boolean
VBScript Interface
53
Property
Value Type
What it is (Continued)
Vertical
Number (Long)
Width
Number (Long)
VBScript Interface
54
CountItem
A counted item in the document. Also see the method AutoCount, defined on Document.
Note: CountItem is available in the Extended Version only.
For additional information about count items, see Adobe Photoshop CS3 help on the Count Tool.
Properties
Property
Value type
What it is
Position
Array of Number
(Double)
Parent
object
(Document)
typename
string
Parameter type
Returns
Methods
Method
Delete
()
What it does
Deletes the CountItem object.
VBScript Interface
55
CountItems
The collection of CountItems objects in the document. See CountItem.
Note: CountItems is available in the Extended Version only.
Properties
Property
Value Type
What it is
Length
Number (Long)
Parent
typename
String
Parameter Type
Returns
What it does
CountItem
Methods
Method
Add
(position)
Index
Array of Number
(Double)
object(CountItem)
Number (Long)
Number (Long)
Document
(ItemPtr)
Item
(ItemKey)
RemoveAll
()
VBScript Interface
56
DCS1_SaveOptions
Options that can be specified when saving a CMYK document in DCS1 format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
DCS
PsDCSType
Read-write. Default: 3.
EmbedColorProfile
Boolean
Encoding
HalftoneScreen
Boolean
Interpolation
Boolean
Preview
PsPreviewType
TransferFunction
Boolean
typename
String
VectorData
Boolean
VBScript Interface
57
DCS2_SaveOptions
Options that can be specified when saving a CMYK document in DCS2 format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
DCS
PsDCSType
EmbedColorProfile
Boolean
Encoding
PsSaveEncoding
HalftoneScreen
Boolean
Interpolation
Boolean
MultiFileDCS
Boolean
Preview
PsPreviewType
SpotColors
Boolean
TransferFunction
Boolean
typename
String
VectorData
Boolean
VBScript Interface
58
DICOMOpenOptions
Options that can be specified when opening a DICOM format document.
Note: DICOMOpenOptions is available in the Extended Version only.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Anonymize
Boolean
Columns
Number (Long)
Reverse
Boolean
Rows
Number (Long)
ShowOverlays
Boolean
typename
String
WindowLevel
Number (Long)
WindowWidth
Number (Long)
VBScript Interface
59
Document
The active containment object for layers and all most objects in the script; the basic canvas for the file.
Note: In Adobe Photoshop CS3, a document can also be referred to as an image or a canvas.
The term image refers to the entire document and its contents. You can trim or crop an image.
You resize an image using the ResizeImage() method.
The term canvas refers to the space in which the document sits on the screen. You can rotate or
flip the canvas. You resize the canvas using the ResizeCanvas() method.
Properties
Property
Value Type
What it is
ActiveChannels
Array (Channel
objects)
(HistoryState)
ActiveHistoryState
Object
(HistoryState)
ActiveLayer
Object (ArtLayer or
LayerSet)
Application
ActiveHistoryBrushSource Object
belongs to.
ArtLayers
Object (ArtLayers)
BackgroundLayer
Object (ArtLayer)
BitsPerChannel
Channels
Object (Channels)
ColorProfileName
String
ColorProfileType.
ColorProfileType
PsColorProfileType
ColorSamplers
ColorSamplers
ComponentChannels
Array (Channel
objects)
VBScript Interface
Property
Value Type
What it is (Continued)
CountItems
CountItems
60
String
Height
Number (Double)
Histogram
Array of 256
Numbers (Long)
HistoryStates
Object
(HistoryStates)
Info
Object
(DocumentInfo)
LayerComps
Object (LayerComps)
Layers
Object (Layers)
LayerSets
Object (LayerSets)
Managed
Boolean
MeasurementScale
MeasurementScale
Mode
PsDocumentMode
Name
String
Parent
Path
String
PathItems
Object (PathItems)
PixelAspectRatio
Number (Double)
QuickMaskMode
Boolean
VBScript Interface
61
Property
Value Type
What it is (Continued)
Resolution
Number (Double)
Saved
Boolean
Selection
Object (Selection)
typename
String
Width
Number (Double)
XMPMetadata
VBScript Interface
62
Methods
Method
Parameter Type
AutoCount
(channel,
threshold)
Channel
Number (Long)
Returns
What it does
Counts the number of
objects in a document.
Creates a CountItem object
for each object counted.
Note: The AutoCount
feature is available
in the Extended
Version only.
For additional
information about
how to set up
objects to count,
please see the
Count Tool in the
Adobe Photoshop
CS3 Help
Changes the color profile.
ChangeMode
(DestinationMode
[, Options])
PsChangeMode
object
(BitmapConversionOptions
or
IndexedConversionOptions
)
Close
([Saving])
PsSaveOptions
Method
VBScript Interface
Parameter Type
Returns
ConvertProfile
(DestinationProfile,
Intent
[, BlackPointCompensation]
[, Dither])
63
String
PsIntent
Boolean
Boolean
Note: The
DestinationProfi
le parameter must
be either a string
that names the
color mode or
Working RGB,
Working CMYK,
Working Gray, Lab
Color (meaning
one of the working
color spaces or Lab
color)
Crops the document. The
first parameter is an array
of four coordinates that
mark the portion
remaining after cropping,
in the following order: left,
top, right, bottom.
Crop
(Bounds
[, Angle]
[, Width]
[, Height])
Array(Double)
Number (Double)
Number (Double)
Number (Double)
Document
Duplicate
([Name ]
[, MergeLayersOnly]
)
string
boolean
ExportDocument
(ExportIn
[, ExportAs]
[, Options])
String
PsExportType
ExportOptionsIllustrator
or
ExportOptionsSaveForWeb
Flatten
()
PsDirection
String
FlipCanvas
(Direction)
ImportAnnotations
(File)
Method
VBScript Interface
Parameter Type
Returns
()
ArtLayer
Paste
Boolean
PrintOut
([PostScriptEncoding]
[, SourceSpace]
[, PrintSpace]
[, Intent]
[BlackPointCompensation])
MergeVisibleLayers
([IntoSelection])
64
PsPrintEncoding
PsSourceSpaceType
String
PsIntent
Boolean
Note: PrintSpace
specifies the color
space for the
printer. Valid values
are nothing (that is,
the same as the
source); or Working
RGB, Working CMYK,
Working Gray, Lab
Color (meaning
one of the working
color spaces or Lab
color); or a string
specifying a specific
colorspace. Default:
nothing).
Rasterizes all layers.
RasterizeAllLayers
()
RecordMeasurements
([Source]
[, DataPoints])
PsMeasurementSource
array of strings
ResizeCanvas
([Width]
[, Height]
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
ResizeImage
([Width]
[, Height]
[, Resolution]
[, ResampleMethod])
RevealAll
()
Number (Double)
Number (Double)
Number (Double)
PsResampleMethod
Record measurements of
document.
Changes the size of the
canvas to display more or
less of the image but does
not change the image size.
See ResizeImage.
Changes the size of the
image.
Method
VBScript Interface
Parameter Type
Returns
RotateCanvas
(Angle)
65
Number (Double)
Save
()
SaveAs
(SaveIn
[, Options]
[, AsCopy]
[, ExtensionType])
String
object (corresponding
SaveOptions object*)
Boolean
PsExtensionType
* Examples:
BMPSaveOptions
DCS2_SaveOptions
JPEGSaveOptions
TiffSaveOptions
etc.
PsSaveDocumentType
SplitChannels
()
Trap
(Width)
Number (Long)
Trim
([Type]
[, Top]
[, Left]
[, Bottom]
[, Right])
PsTrimType
Boolean
Boolean
Boolean
Boolean
VBScript Interface
66
Sample Script
The following script creates a document that contains two images (a flower and a duck) obtained from the
Adobe Photoshop CS3 Samples folder and employs the following steps:
1. Determine which image is larger.
2. Resize the smaller image to match the larger image.
3. Create a merged document twice as high as either image in order to hold both images.
4. Select part of the document and paste the flower into the selection. T
5. Invert the selection and paste the duck into the lower part of the document.
6. Position the flower over the duck.
Document.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, flowerDoc
Dim duckDoc, mergedDoc, selRegion
Set appRef = CreateObject("Photoshop.Application")
' Save the current preferences
startRulerUnits = appRef.Preferences.RulerUnits
startTypeUnits = appRef.Preferences.TypeUnits
startDisplayDialogs = appRef.DisplayDialogs
' Set Photoshop CS2 to use pixels and display no dialogs
appRef.Preferences.RulerUnits = 1 'for PsUnits --> 1 (psPixels)
appRef.Preferences.TypeUnits = 1 'for PsTypeUnits --> 1 (psPixels)
appRef.DisplayDialogs = 3 'for PsDialogModes --> 3 (psDisplayNoDialogs)
' first close all the open documents
Do While appRef.Documents.Count
appRef.ActiveDocument.Close
Loop
' Open the flower and duck files from the samples folder
Set flowerDoc = appRef.Open(appRef.Path + "/Samples/sunflower.psd")
Set duckDoc = appRef.Open(appRef.Path + "/Samples/Ducky.tif")
' Find out which document is larger
' Resize the smaller document the to the larger documents size
' The resize requires the document be the active/front document
If (flowerDoc.Width * flowerDoc.Height) > (duckDoc.Width * duckDoc.Height) Then
appRef.ActiveDocument = duckDoc
duckDoc.Resize flowerDoc.Width, flowerDoc.Height
Else
appRef.ActiveDocument = flowerDoc
flowerDoc.ResizeImage duckDoc.Width, duckDoc.Height
End If
' Create a new document twice as high as two files
Set mergedDoc = appRef.Documents.Add(duckDoc.Width, duckDoc.Height * 2, _
duckDoc.Resolution, "flowerOverDuck")
' Copy the flower to the top; make it the active document so we can manipulate it
appRef.ActiveDocument = flowerDoc
VBScript Interface
flowerDoc.ActiveLayer.Copy
'Paste the flower to the merged document, making the merged document active
appRef.ActiveDocument = mergedDoc
' Select a square area at the top of the new document
selRegion = Array(Array(0, 0), _
Array(mergedDoc.Width, 0), _
Array(mergedDoc.Width, mergedDoc.Height / 2), _
Array(0, mergedDoc.Height / 2), _
Array(0, 0))
' Create the selection
mergedDoc.Selection.Select(selRegion)
'Paste in the flower
mergedDoc.Paste
' do the same thing for the duck
appRef.ActiveDocument = duckDoc
duckDoc.ActiveLayer.Copy
appRef.ActiveDocument = mergedDoc
mergedDoc.Selection.Select(selRegion)
' Inverting the selection so the bottom of the document is now selected
mergedDoc.Selection.Invert
' Paste the duck
mergedDoc.Paste
' get rid of our originals without modifying them
duckDoc.Close( 2) 'for PsSaveOptions --> 2 (psDoNotSaveChanges)
flowerDoc.Close( 2)
' Reset the application preferences
appRef.Preferences.RulerUnits = startRulerUnits
appRef.Preferences.TypeUnits = startTypeUnits
appRef.DisplayDialogs = startDisplayDialogs
67
VBScript Interface
68
DocumentInfo
Metadata about a Document object. These values can be set by choosing File > File Info in the Adobe
Photoshop CS3 application.
Note: The DocumentInfo object corresponds to the Info property of the Application object. You use
the property name Info, rather thanthe object name, DocumentInfo, in a script, as in the following
sample, which sets the Author, Caption, and Copyrighted properties:
Dim docRef
docRef = Open(fileList[i])
' set the file info
docRef.Info.Author = "Mr. Adobe Programmer"
docRef.Info.Caption = "Adobe photo shoot"
docRef.Info.Copyrighted = 1
Properties
Property
Value Type
What it is
Application
Object (Application)
Author
String
authorPosition
String
Read-write.
Caption
String
Read-write.
CaptionWriter
String
Read-write.
Category
String
Read-write.
City
String
Read-write.
Copyrighted
PsCopyrightedType
CopyrightNotice
String
Read-write.
Country
String
Read-write.
CreationDate
String
Read-write.
Credit
String
Read-write.
EXIF
Array of Arrays:
Array(Array (tag, tag
data)), ...)
Headline
String
Read-write.
Instructions
String
Read-write.
Read-write.
VBScript Interface
Property
Value Type
What it is (Continued)
JobName
String
Read-write.
Keywords
Array (Strings)
OwnerUrl
String
Read-write.
Parent
Object (Document)
ProvinceState
String
Read-write.
Source
String
Read-write.
SupplementalCategories
Array (Strings)
Read-write.
Title
String
Read-write.
TransmissionReference
String
Read-write.
typename
String
Urgency
PsUrgency
Read-write.
Sample Script
The following script checks to see if any documents are open. If none are open, it opens the sample file
fish.psd.
The script then sets the following document info (metadata):
Country: USA
State: CA
Note: After the script finishes running, choose File > File Info to display the metadata set by the script.
DocumentInfo.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, docRef
Set appRef = CreateObject("Photoshop.Application")
' Save the current preferences
startRulerUnits = appRef.Preferences.RulerUnits
startTypeUnits = appRef.Preferences.TypeUnits
startDisplayDialogs = appRef.DisplayDialogs
' Set Photoshop CS3 to use pixels and display no dialogs
69
VBScript Interface
70
VBScript Interface
71
Documents
The collection of open Document objects.
Note: See Document on page 59 for information on the Document object.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object
(Application)
typename
String
Methods
Method
Parameter Type
Add
([Width]
[, Height]
[, Resolution]
[, Name]
[, Mode]
[, InitialFill]
[,PixelAspectRatio]
[,BitsPerChannel]
[,ColorProfileName])
Index
(ItemKey)
What it does
Document
Number (Double)
Number (Double)
Number (Double)
String
PsNewDocumentMode
PsDocumentFill
Number (Double)
PsBitsPerChannelType
String
object(Document)
Number
(Long)
Number (Long)
Document
(ItemPtr)
Item
Returns
VBScript Interface
72
EPSOpenOptions
Options that can be specified when opening an EPS format document.
Properties
Property
Value Type
What it is
AntiAlias
Boolean
Application
Object
(Application)
ConstrainProportions
Boolean
Height
Number (Double)
Mode
PsOpenDocumentMode
Resolution
Number (Double)
typename
String
Width
Number (Double)
VBScript Interface
73
EPSSaveOptions
Options that can be specified when saving a document in EPS format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
EmbedColorProfile
Boolean
Encoding
PsSaveEncoding
HalftoneScreen
Boolean
Interpolation
Boolean
Preview
PsPreviewType
PsColorManagement
Boolean
TransferFunction
Boolean
TransparentWhites
Boolean
typename
String
VectorData
Boolean
VBScript Interface
74
ExportOptionsIllustrator
Options that can be specified when exporting a PathItem object to an Adobe Illustrator file.
Properties
Property
Value Type
What it is
Application
Object (Application)
Path
PsIllustratorPathType
PathName
String
typename
String
VBScript Interface
75
ExportOptionsSaveForWeb
Options that can be specified when optimizing a document for the Web, or for devices.
Properties
Property
Value type
What it is
Application
Object (Application)
Blur
Number (Double)
ColorReduction
PsColorReductionType
Colors
Number (Long)
Dither
PsDitherType
DitherAmount
Number (Long)
Format
PsSaveDocumentType
IncludeProfile
Boolean
Interlaced
Boolean
Lossy
Number (Long)
MatteColor
RGBColor
Optimized
Boolean
PNG8
Boolean
Quality
Number (Long)
VBScript Interface
76
Property
Value type
What it is (Continued)
Transparency
Boolean
TransparencyAmount
Number (Long)
TransparencyDither
PsDitherType
typename
String
WebSnap
Number (Long)
VBScript Interface
77
GalleryBannerOptions
Options that define the BannerOptions property of the GalleryOptions object. See GalleryOptions on
page 81.
Tip: You can preserve default values for many GalleryBannerOptions properties by setting the
GalleryOptions property PreserveAllMetadata to true or by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web Photo
Gallery dialog.
Properties
Property
Value Type
What it is
Application
Object (Application)
ContactInfo
String
Date
String
Font
PsGalleryFontType
FontSize
Number (Long)
Photographer
String
SiteName
String
typename
String
VBScript Interface
78
GalleryCustomColorOptions
Options that define the customColorOptions property of the GalleryOptions object. See
GalleryOptions on page 81.
Tip: You can preserve default values for many GalleryCustomColorOptions properties by setting the
GalleryOptions property PreserveAllMetadata to true or by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web Photo
Gallery dialog.
Properties
Property
Value Type
What it is
ActiveLinkColor
Object (RGBColor)
Application
Object (Application)
BackgroundColor
Object (RGBColor)
BannerColor
Object (RGBColor)
LinkColor
Object (RGBColor)
TextColor
Object (RGBColor)
typename
String
VisitedLinkColor
Object (RGBColor)
VBScript Interface
79
GalleryImagesOptions
Options that define the ImagesOptions property of the GalleryOptions object. See GalleryOptions on
page 81.
Tip: You can preserve default values for many GalleryImagesOptions properties by setting the
GalleryOptions property PreserveAllMetadata to true or by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web Photo
Gallery dialog.
Properties
Property
Value Type
What it is
Application
Object (Application)
Border
Number (Long)
Caption
Boolean
Dimension
Number (Long)
Font
PsGalleryFontType
FontSize
Number (Long)
ImageQuality
Number (Long)
IncludeCopyright
Boolean
IncludeCredits
Boolean
VBScript Interface
Property
Value Type
What it is (Continued)
IncludeFilename
Boolean
80
Boolean
NumericLinks
Boolean
ResizeConstraint
PsGalleryConstrainType
ResizeImages
Boolean
typename
String
VBScript Interface
81
GalleryOptions
Options that can be specified for a Web photo gallery.
Tip: You can preserve default values for many GalleryOptions properties by choosing File > Automate
> Web Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web
Photo Gallery dialog.
Properties
Property
Value Type
What it is
AddSizeAttributes
Boolean
Application
Object (Application)
BannerOptions
Object (GalleryBannerOptions)
CustomColorOptions
Object
(GalleryCustomColorOptions)
EmailAddress
String
ImagesOptions
Object (GalleryImagesOptions)
IncludeSubFolders
Boolean
LayoutStyle
String
PreserveAllMetadata Boolean
SecurityOptions
Object (GallerySecurityOptions)
ThumbnailOptions
String
VBScript Interface
82
Property
Value Type
What it is (Continued)
UseShortExtension
Boolean
UseUTF8Encoding
Boolean
VBScript Interface
83
GallerySecurityOptions
Options that define the SecurityOptions property of the GalleryOptions object. See GalleryOptions
on page 81.
Tip: You can preserve default values for many GallerySecurityOptions properties by setting the
GalleryOptions property PreserveAllMetadata to true or by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web Photo
Gallery dialog.
Properties
Property
Value Type
What it is
Application
Object (Application)
Content
PsGallerySecurityType
Font
PsGalleryFontType
FontSize
Number (Long)
Opacity
Number (Long)
Text
String
TextColor
Object (RGBColor)
TextPosition
PsGallerySecurityTextPositionType
TextRotate
PsGallerySecurityTextRotateType
typename
String
VBScript Interface
84
GalleryThumbnailOptions
Options that define the thumbnailOptions property of the GalleryOptions object. See GalleryOptions
on page 81.
Tip: You can preserve default values for many GalleryThumbnailOptions properties by setting the
GalleryOptions property PreserveAllMetadata to true or by choosing File > Automate > Web
Photo Gallery, and then choosing Preserve all metadata on the Options area of the Web Photo
Gallery dialog.
Properties
Property
Value Type
What it is
Application
Object (Application)
Border
Number (Long)
Caption
Boolean
ColumnCount
Number (Long)
Dimension
Number (Long)
Font
PsGalleryFontType
FontSize
Number (Long)
IncludeCopyright
Boolean
IncludeCredits
Boolean
IncludeFilename
Boolean
IncludeTitle
Boolean
RowCount
Number (Long)
Size
typename
String
VBScript Interface
85
GIFSaveOptions
Options that can be specified when saving a document in GIF format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Colors
Number (Long)
(psMacOSPalette);
(psWindowsPalette);
(psWebPalette); 5 (psUniform);
(psLocalPerceptual); or
(psLocalSelective).
See Palette.
Dither
PsDitherType
DitherAmount
Number (Long)
Forced
PsForcedColors
Interlaced
Boolean
Matte
PsMatteType
Palette
PsPaletteType
PreserveExactColors
Boolean
VBScript Interface
86
Property
Value Type
What it is (Continued)
Transparency
Boolean
typename
String
VBScript Interface
87
GrayColor
Options for defining a gray color.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Gray
Number (Double)
typename
String
VBScript Interface
88
HistoryState
A version of the document stored automatically (and added to the HistoryStates collection), which
preserves the documents state, each time the document is saved.
Note: See HistoryStates on page 89 for information about the HistoryStates collection.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Name
String
Parent
Snapshot
Boolean
typename
String
VBScript Interface
89
HistoryStates
The collection of HistoryState objects in the document.
Note: See HistoryState on page 88 for more information on HistoryState objects.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object (Document)
typename
String
Parameter Type
Returns
What it does
Number (Long)
HistoryState
Methods
Method
Index
(ItemPtr)
Object
(HistoryState)
Item
(ItemKey)
Number (Long)
VBScript Interface
90
HSBColor
Options that can be specified for a color object using the HSB color model.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Brightness
Hue
Saturation
typename
String
VBScript Interface
91
IndexedConversionOptions
Options that can be specified when converting an RGB image to an indexed color model.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Colors
Number (Long)
(psMacOSPalette)
(psWindowsPalette)
(psWebPalette)
(psUniform)
(psLocalPerceptual)
(psLocalSelective)
(psLocalAdaptive)
See Palette.
Dither
PsDitherType
DitherAmount
Number (Long)
Forced
PsForcedColors
Matte
PsMatteType
Palette
PsPaletteType
PreserveExactColors
Boolean
VBScript Interface
92
Property
Value Type
What it is (Continued)
Transparency
Boolean
typename
String
VBScript Interface
JPEGSaveOptions
Options that can be specified when saving a document in JPEG format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
EmbedColorProfile
Boolean
FormatOptions
Matte
PsMatteType
Quality
Number (Long)
Scans
Number (Long)
typename
String
93
VBScript Interface
LabColor
Options that can be specified when defining a color object using the LAB color model.
Properties
Property
Value Type
What it is
Application
Object
(Application)
typename
String
94
VBScript Interface
95
LayerComp
A snapshot of a state of the layers in a document (can be used to view different page layouts or
compositions).
Properties
Property
Value Type
What it is
Appearance
Boolean
Application
Object (Application)
Comment
String
Name
String
Parent
Object (Document)
Position
Boolean
Selected
Boolean
typename
String
Visibility
Boolean
Methods
Method
Apply
Parameter Type
Returns
What it does
Applies the layer comp to the document.
()
Delete
()
Recapture
()
ResetfromComp
()
VBScript Interface
96
LayerComps
The collection of LayerComp objects in the document.
Note: See LayerComp on page 95 for information on LayerComp objects.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object (Document)
typename
String
Parameter Type
Returns
What it does
LayerComp
Number (Long)
LayerComp
Methods
Method
Add
(Name,
Comment,
Appearance,
Position,
Visibility)
String
String
Boolean
Boolean
Boolean
Index
(ItemPtr)
Object (LayerComp)
Item
(ItemKey)
RemoveAll
()
Number (Long)
VBScript Interface
97
Layers
The collection of layer objects, including ArtLayer and LayerSet objects, in the document.
Note: See ArtLayer on page 24 for information on ArtLayer objects. See LayerSet on page 98 for
information on LayerSet objects.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
typename
String
Method
Parameter Type
Returns
What it does
Index
Object
(ArtLayer or
LayerSet)
Number (Long)
Number (Long)
Object
(ArtLayer or
LayerSet)
Methods
(ItemPtr)
Item
(ItemKey)
RemoveAll
()
VBScript Interface
98
LayerSet
A group of layer objects, which can include ArtLayer objects and other (nested) LayerSet objects. A
single command or set of commands manipulates all layers in a LayerSet object.
Properties
Property
Value Type
What it is
AllLocked
Boolean
Application
Object
(Application)
ArtLayers
BlendMode
PsBlendMode
Bounds
Array(Double)
EnabledChannels
Array (Channel
objects)
Layers
Object (Layers)
LayerSets
LinkedLayers
Array (ArtLayer
and/or LayerSet)
Name
String
Opacity
Number (Double)
Parent
Object (Document
or LayerSet)
typename
String
Visible
Boolean
VBScript Interface
99
Methods
Method
Parameter Type
Returns
What it does
Deletes the LayerSet object.
Delete
()
Duplicate
([RelativeObject]
[, InsertionLocation])
object (ArtLayer
or LayerSet)
PsElementPlacement
Object
(LayerSet)
Link
(With)
Object (ArtLayer or
LayerSet)
ArtLayer
Merge
()
Object
(Application)
PsElementPlacement
Resize
([Horizontal]
[, Vertical]
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
Rotate
(Angle
[, Anchor])
Number (Double)
PsAnchorPosition
Translate
([DeltaX]
[, DeltaY])
Unlink
()
Move
(RelativeObject,
InsertionLocation)
Number (Double)
Number (Double)
VBScript Interface
100
LayerSets
The collection of LayerSet objects in the document.
Note: See LayerSet on page 98 for information on LayerSet objects.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
typename
String
Parameter Type
Returns
What it does
LayerSet
Number (Long)
LayerSet
Methods
Method
Add
()
Index
(ItemPtr)
Object
(LayerSet)
Item
(ItemKey)
Number (Long)
RemoveAll
()
Sample Script
The following script creates three layer sets, then nests a second layer set in each layer set, and then
creates a text layer in each nested set that displays the text Layer in n Set Inside n Set, where n represents
the ordinal number of the set (first, second, or third).
LayerSets.vbs
Dim appRef, docRef, myLayerSets(3,3),
textArray, i, myLayers(3)
VBScript Interface
101
VBScript Interface
102
MeasurementLog
The measurement log for the application. See MeasurementLog (in the Properties table for the Application
object.)
Note: The MeasurementLog feature is available in the Extended Version only.
Because the MeasurementLog class is a property of the Application object, you use the property
name, measurementLog, rather than the class name, MeasurementLog, in your code.
Methods
Method
Parameter type
String
PsMeasurementRange
array of strings
Delete a measurement.
DeleteMeasurements
([Range])
What it does
Export some measurement(s).
ExportMeasurements
([File]
[, Range])
[, DataPoints])
Returns
PsMeasurementRange
VBScript Interface
MeasurementScale
The measurement scale for the document. See MeasurementScale (in the Properties table for the
Document object.)
Note: The MeasurementScale feature is available in the Extended Version only.
Properties
Property
Value Type
What it is
PixelLength
number (Long)
LogicalLength
number (Double)
LogicalUnits
String
103
VBScript Interface
NoColor
An object that represents a missing color.
Properties
Property
Value type
What it is
Application
Object
(Application)
typename
String
104
VBScript Interface
105
Notifier
An event-handler object that tells the script to execute specified code when a specified event occurs.
Properties
Property
Value type
What it is
Application
Object
(Application)
Event
String
EventClass
String
EventFile
File
Parent
Object
(Application)
typename
String
Parameter type
Returns
Methods
Method
Remove
What it does
Deletes the Notifier object.
()
VBScript Interface
106
Notifiers
The collection of Notifier objects in the document; the Notifiers property of the Application object.
Note: See Notifier on page 105 for information on Notifier objects. See Notifiers (in the Properties table
of the Application object).
Properties
Property
Value type
What it is
Application
Object
(Application)
Count
Number (Long)
EventClass
String
Parent
Object
(Application)
typename
String
VBScript Interface
107
Methods
Method
Parameter type
Add
(Event,
EventFile
[, EventClass])
Returns
What it does
Notifier
String
String
String
Index
(ItemPtr)
Item
(ItemKey)
RemoveAll
()
Number (Long)
Notifier
Object
(Notifier)
Number (Long)
VBScript Interface
108
PathItem
A path or drawing object, such as the outline of a shape or a straight or curved line, which contains sub
paths that comprise its geometry.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Kind
PsPathKind
Name
String
Parent
Object
(Document)
SubPathItems
Object
Read-only. The sub path objects for this PathItem
(SubPathItems)
object.
typename
String
Methods
Method
Parameter Type
()
Deselect
()
Duplicate
String
FillPath
([FillColor]
[,
[,
[,
[,
[,
[,
Mode]
Opacity]
PreserveTransparency]
Feather]
WholePath]
AntiAlias])
MakeClippingPath
([Flatness])
What it does
Deletes this PathItem
object.
Delete
(Name)
Returns
Object (SolidColor,
ArtLayer, HistoryState);
or String
PsColorBlendMode
Number (Double)
Boolean
Number (Double)
Boolean
Boolean
Number (Double)
Method
VBScript Interface
Parameter Type
MakeSelection
([Feather]
[, AntiAlias]
[, Operation])
Number (Double)
Boolean
PsSelectionType
Returns
109
Select
()
StrokePath
([Tool]
[, SimulatePressure])
PsToolType
Boolean
Sample Script
The following creates a path in three segments: two diagonal lines that form a V, and a curved line above
the V that makes it look like a 2D ice cream cone.
Paths.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, docRef
Dim lineArray(1), lineArray2(1), lineArray3(2), lineSubPathArray(2), myPathItem
Set appRef = CreateObject("Photoshop.Application")
' Save the current preferences
startRulerUnits = appRef.Preferences.RulerUnits
startTypeUnits = appRef.Preferences.TypeUnits
startDisplayDialogs = appRef.DisplayDialogs
' Set Photoshop CS3 to use pixels and display no dialogs
appRef.Preferences.RulerUnits = 1 'for PsUnits --> 1 (psPixels)
appRef.Preferences.TypeUnits = 1 'for PsTypeUnits --> 1 (psPixels)
appRef.DisplayDialogs = 3 'for PsDialogModes --> 3 (psDisplayNoDialogs)
' first close all the open documents
Do While appRef.Documents.Count
appRef.ActiveDocument.Close
Loop
' create a document to work with
Set docRef = appRef.Documents.Add(5000, 7000, 72, "Simple Line")
'line #1--its a straight line so the coordinates for anchor, left, and
'right for each point have the same coordinates
Set lineArray(0) = CreateObject("Photoshop.PathPointInfo")
lineArray(0).Kind = 2 ' for PsPointKind --> 2 (psCornerPoint)
lineArray(0).Anchor = Array(100, 100)
lineArray(0).LeftDirection = lineArray(0).Anchor
lineArray(0).RightDirection = lineArray(0).Anchor
VBScript Interface
110
VBScript Interface
111
VBScript Interface
112
PathItems
The collection of PathItem objects in the document.
Note: See PathItem on page 108 for information on PathItem objects.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object
(Document)
typename
String
Methods
Method
Parameter Type
Returns
What it does
Add
String
(Name,
EntirePath) Array (SubPathInfo
objects)
(ItemPtr)
Number
(Long)
Number (Long)
Item
(ItemKey)
RemoveAll
()
Object (PathItem)
Index
VBScript Interface
113
PathPoint
Information about an array of PathPointInfo objects.
Note: You do not use the PathPoint object to create points that make up a path. Rather, you use the
PathPoint object to retrieve information about the points that describe path segments. To create
path points, use the PathPointInfo objects. See PathPointInfo on page 114.
Properties
Property
Value Type
What it is
Anchor
Array(Double)
Application
Object (Application)
Kind
PsPointKind
LeftDirection
Array(Double)
Parent
Object (SubPathItem)
RightDirection
Array(Double)
typename
String
VBScript Interface
114
PathPointInfo
A point on a path, expressed as an array of three coordinate arrays: the anchor point, left direction point,
and right direction point. For paths that are straight segments (not curved), the coordinates of all three
points are the same. For curved segments, the coordinates are different. The difference between the
anchor point and the left or right direction points determines the arc of the curve. You use the left
direction point to bend the curve outward or make it convex; you use the right direction point to bend
the curve inward or make it concave.
Properties
Property
Value Type
What it is
Anchor
Array
Application
Object
(Application)
Kind
PsPointKind
LeftDirection
Array(Double)
RightDirection Array(Double)
typename
String
VBScript Interface
115
PathPoints
A collection of PathPoint objects that comprises the PathPoints property of the SubPathItem object.
Note: See SubPathItem on page 144 for more information.
Properties
Property
Value Type
What it is
Read-only. The application that the collection belongs to.
Count
Number (Long)
Parent
Object (SubPathItem)
typename
String
Method
Parameter type
Returns
What it does
Object (PathPoint)
Number
(Long)
PathPoint
Index
(ItemPtr)
Item
(ItemKey)
Number (Long)
VBScript Interface
116
PDFOpenOptions
Options that can be specified when opening a document in generic PDF format.
Properties
Property
Value Type
What it is
AntiAlias
Boolean
Application
belongs to.
BitsPerChannel
ConstrainProportions
Boolean
CropPage
PsCropToType
Height
Double
Mode
PsOpenDocumentMode
Name
String
Page
Number (Long)
Resolution
Number (Double)
SuppressWarnings
Boolean
typename
String
UsePageNumber
Boolean
Width
Double
VBScript Interface
117
PDFSaveOptions
Options that can be specified when saving a document in PDF format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Annotations
Boolean
Application
Object (Application)
ColorConversion
Boolean
ConvertToEightBit
Boolean
Descripton
String
DestinationProfile
String
DowngradeColorProfile
Boolean
DownSample
PsPDFResampleType
DownSampleSize
Number (Double)
DownSampleSizeLimit
Number (Double)
EmbedColorProfile
Boolean
EmbedFonts
Boolean
EmbedThumbnail
Boolean
Encoding
PsPDFEncoding
Interpolation
Boolean
VBScript Interface
118
Property
Value Type
What it is (Continued)
JPEGQuality
Number (Long)
Layers
Boolean
OptimizeForWeb
Boolean
OutputCondition
String
OutputConditionID
String
PDFCompatibility
PsPDFCompatibilityType
PDFStandard
PsPDFStandardType
PreserveEditing
Boolean
PresetFile
String
ProfileInclusionPolicy
Boolean
RegistryName
String
SpotColors
Boolean
TileSize
Number (Long)
Transparency
Boolean
typename
String
UseOutlines
Boolean
VBScript Interface
119
Property
Value Type
What it is (Continued)
VectorData
Boolean
View
Boolean
VBScript Interface
120
PhotoCDOpenOptions
DEPRECATED in Adobe Photoshop CS3. Kodak PhotoCD is now found in the Goodies folder on the Adobe
Photoshop CS3 Install DVD.
Options to be specified when opening a Kodak Photo CD (PCD) files, including high-resolution files from
Pro Photo CD discs.
Properties
Property
Value Type
What it is
Application
belongs to.
ColorProfileName
String
ColorSpace
PsPhotoCDColorSpace
Orientation
PsOrientation
PixelSize
PsPhotoCDSize
Resolution
Number (Double)
typename
String
VBScript Interface
121
PhotoshopSaveOptions
Options that can be specified when saving a document in PSD format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Annotations
Boolean
Application
Object
(Application)
EmbedColorProfile
Boolean
Layers
Boolean
SpotColors
Boolean
typename
String
VBScript Interface
122
PICTFileSaveOptions
Options that can be specified when saving a document in PICT format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object
(Application)
Compression
PsPICTCompression
Read-write. Default: 1)
EmbedColorProfile
Boolean
Resolution
typename
String
VBScript Interface
123
PicturePackageOptions
Options that can be specified for a Picture Package.
Property
Value type
What it is
Application
Object (Application)
Content
PsPicturePackageTextType
Flatten
Boolean
Font
PsGalleryFontType
FontSize
Number (Long)
Layout
String
Mode
PsNewDocumentMode
Opacity
Number (Long)
Resolution
Number (Double)
Text
String
TextColor
RGBColor
TextPosition
PsGallerySecurityTextPositionType
TextRotate
PsGallerySecurityTextRotateType
typename
String
VBScript Interface
PixarSaveOptions
Options that can be specified when saving a document in Pixar format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object (Application)
typename
String
124
VBScript Interface
PNGSaveOptions
Options that can be specified when saving a document in PNG format.
Properties
Property
Value Type
What it is
Application
Object (Application)
Interlaced
Boolean
typename
String
125
VBScript Interface
126
Preferences
Options to define for the Preferences property of the Application object. See Preferences on page 18
(in the Properties table for the Application object).
Note: Defining the Preferences properties is basically equivalent to selecting Edit > Preferences
(Windows) or Photoshop > Preferences in the Adobe Photoshop CS3 application. For explanations
of individual settings, please refer to Adobe Photoshop CS3 Help.
VBScript Interface
127
Properties
Property
Value Type
What it is
AdditionalPluginFolder
String
UseAdditionalPluginFolder.
Application
Object (Application)
AskBeforeSavingLayeredTIFF
Boolean
AutoUpdateOpenDocuments
Boolean
BeepWhenDone
Boolean
ColorChannelsInColor
Boolean
ColorPicker
PsColorPicker
Read-write.
ColumnGutter
Number (Double)
ColumnWidth
Number (Double)
CreateFirstSnapshot
Boolean
DynamicColorSliders
Boolean
EditLogItems
PsEditLogItemsType
UseHistoryLog.
VBScript Interface
128
Property
Value Type
What it is (Continued)
ExportClipboard
Boolean
FontPreviewSize
psFontPreviewType
GamutWarningOpacity
Number (Double)
GridSize
PsGridSize
GridStyle
PsGridLineStyle
GridSubDivisions
Number (Long)
Read-write. (1 - 100)
GuideStyle
PsGuideLineStyle
ImageCacheLevels
Number (Long)
ImagePreviews
PsSaveBehavior
Interpolation
PsResampleMethod
KeyboardZoomResizesWindows
Boolean
MaximizeCompatibility
PsQueryStateType
MaxRAMuse
Number (Long)
NonLinearHistory
Boolean
NumberOfHistoryStates
Number (Long)
OtherCursors
use.
VBScript Interface
129
Property
Value Type
What it is (Continued)
PaintingCursors
PsPaintingCursors
Parent
Object (Application)
PixelDoubling
Boolean
PointSize
PsPointType
RecentFileListLength
Number (Long)
RulerUnits
PsUnits
SaveLogItems
PsSaveLogItemsType
SaveLogItemsFile
String
SavePaletteLocations
Boolean
ShowAsianTextOptions
Boolean
ShowEnglishFontNames
Boolean
ShowSliceNumber
Boolean
ShowToolTips
Boolean
SmartQuotes
Boolean
typename
String
TypeUnits
PsTypeUnits
VBScript Interface
130
Property
Value Type
What it is (Continued)
UseAdditionalPluginFolder
Boolean
UseHistoryLog
Boolean
UseLowerCaseExtension
Boolean
UseShiftKeyForToolSwitch
Boolean
UseVideoAlpha
Boolean
VBScript Interface
131
PresentationOptions
Options that can be specified for PDF presentations.
Properties
Property
Value Type
What it is
Application
Object
(Application)
AutoAdvance
Boolean
IncludeFilename
Boolean
Interval
Number (Long)
Loop
Boolean
Magnification
PDFSaveOptions
Presentation
Boolean
Transition
PsTransitionType
typename
String
VBScript Interface
132
RawFormatOpenOptions
Options that can be specified when opening a document in RAW format.
Properties
Property
Value Type
What it is
Application
Object
(Application)
BitsPerChannel
Number (Long)
ByteOrder
PsByteOrder
ChannelNumber
Number (Long)
HeaderSize
Number (Long)
Height
Number (Long)
InterleaveChannels
Boolean
RetainHeader
Boolean
typename
String
Width
Number (Long)
VBScript Interface
RawSaveOptions
Options that can be specified when saving a document in RAW format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object (Application)
SpotColors
Boolean
typename
String
133
VBScript Interface
134
RGBColor
The definition of a color in RGB color mode.
Properties
Property
Value Type
What it is
Application
Object (Application)
Blue
Number (Double)
Green
Number (Double)
HexValue
String
Red
Number (Double)
typename
String
VBScript Interface
135
Selection
The selected area of a document or layer.
Properties
Property
Value Type
What it is
Application
Object (Application)
Bounds
Array of
Number(Double)
Parent
Object (Document)
Solid
Boolean
typename
String
Methods
Method
Parameter Type
()
Contract
Number (Double)
Copy
([Merge])
What it does
Clears the selection and does
not copy it to the clipboard.
Clear
(By)
Returns
Boolean
Cut
()
Deselect
()
Number (Double)
Number (Double)
Expand
(By)
Feather
(By)
Method
VBScript Interface
Parameter Type
Fill
(Filltype
[, Mode]
[, Opacity]
[, PreserveTransparency])
Object (SolidColor, or
HistoryState)
PsColorBlendMode
Number (Long)
Boolean
Grow
(Tolerance,
AntiAlias)
Number (Long)
Boolean
Returns
136
Invert
()
MakeWorkPath
Channel
PsSelectionType
Boolean
Number (Double)
([Tolerance])
Resize
([Horizontal]
[, Vertical]
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
Number (Double)
PsAnchorPosition
Number (Double)
PsAnchorPosition
RotateBoundary
(Angle
[, Anchor])
Select
(Region
[, Type]
[, Feather]
[, AntiAlias])
SelectAll
()
Rotate
(Angle
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
ResizeBoundary
([Horizontal]
[, Vertical]
[, Anchor])
Array (Points:
Array (Array
(x,y),...)
PsSelectionType
Number (Double)
Boolean
Method
VBScript Interface
Parameter Type
Fill
(Filltype
[, Mode]
[, Opacity]
[, PreserveTransparency])
Object (SolidColor, or
HistoryState)
PsColorBlendMode
Number (Long)
Boolean
Grow
(Tolerance,
AntiAlias)
Number (Long)
Boolean
Returns
137
Invert
()
MakeWorkPath
Channel
PsSelectionType
Boolean
Number (Double)
([Tolerance])
Resize
([Horizontal]
[, Vertical]
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
Number (Double)
PsAnchorPosition
Number (Double)
PsAnchorPosition
RotateBoundary
(Angle
[, Anchor])
Select
(Region
[, Type]
[, Feather]
[, AntiAlias])
SelectAll
()
Rotate
(Angle
[, Anchor])
Number (Double)
Number (Double)
PsAnchorPosition
ResizeBoundary
([Horizontal]
[, Vertical]
[, Anchor])
Array (Points:
Array (Array
(x,y),...)
PsSelectionType
Number (Double)
Boolean
Method
VBScript Interface
Parameter Type
Returns
SelectBorder
(Width)
Number (Double)
Similar
(Tolerance,
AntiAlias)
Number (Long)
Boolean
Smooth
(Radius)
Number (Long)
Object (SolidColor)
Number (Long)
PsStrokeLocation
PsColorBlendMode
Number (Long)
Boolean
Translate
([DeltaX]
[, DeltaY])
Number (Double)
Number (Double)
TranslateBoundary
([DeltaX]
[, DeltaY])
Channel
PsSelectionType
Stroke
(StrokeColor,
Width
[, Location]
[, Mode]
[, Opacity]
[, PreserveTransparency])
Store
(Into
[, Combination])
138
Number (Double)
Number (Double)
Sample Script
The following script creates a checkerboard using the following steps:
Selection.vbs
Dim appRef, startRulerUnits, startTypeUnits, startDisplayDialogs, docSize
VBScript Interface
139
VBScript Interface
140
VBScript Interface
SGIRGBSaveOptions
Options that can be specified when saving a document in SGIRGB format.
Note: The SGIRGB format is not installed automatically with Adobe Photoshop CS3.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object (Application)
SpotColors
Boolean
typename
String
141
VBScript Interface
142
SolidColor
A color definition used in the document.
Properties
Property
Value Type
What it is
Application
Object
(Application)
CMYK
Object (CMYKColor)
Gray
Object (GrayColor)
HSB
Object (HSBColor)
Lab
Object (LabColor)
Model
PsColorModel
RGB
Object (RGBColor)
typename
String
Methods
Method
Parameter Type
IsEqual
(Color)
SolidColor
Returns
What it does
Boolean
VBScript Interface
143
SubPathInfo
An array of PathPointInfo objects that describes a straight or curved segment of a path.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Closed
Boolean
EntireSubPath
Array (PathPoint
objects)
Read-write.
Operation
PsShapeOperation
typename
String
VBScript Interface
144
SubPathItem
Information about a path.
Note: You do not use the SubPathItem object to create a path. Rather, you create path segments using
the SubPathInfo object. Use the SubPathItem object to retrieve information about a path. (Note
that all of the SubPathItem objects properties are Read-only.)
Properties
Property
Value Type
What it is
Application
Object
(Application)
Closed
Boolean
Operation
PsShapeOperation
Parent
PathPoints
Object
(PathPoints)
typename
String
VBScript Interface
SubPathItems
A collection of SubPathItem objects. See SubPathItem.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object
(PathItem)
typename
String
Method
Parameter type
Returns
What it does
Index
Object
(SubPathItem)
Number
(Long)
Number (Long)
SubPathItem
Methods
(ItemPtr)
Item
(ItemKey)
145
VBScript Interface
146
TargaSaveOptions
Options that can be set when saving a document in TGA (Targa) format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Application
Object (Application) Read-only. The application that the object belongs to.
Resolution
RLECompression
Boolean
typename
String
VBScript Interface
TextFont
Details about a font in the TextFonts collection.
Note: See TextFonts for more information on the TextFonts collection.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Family
String
Name
String
Parent
Object
(Application)
PostScriptName
String
Style
String
typename
String
147
VBScript Interface
148
TextFonts
The collection of fonts available on your computer.
Note: The TextFonts object corresponds to the Fonts property of the Application object. In a script,
you use Fonts to refer to a TextFonts object. The following sample demonstrates how to use the
Count property of the TextFonts object to display a dialog that indicates the number of fonts
installed on the machine.
Correct:
Alert appRef.Fonts.Count
Incorrect:
Alert appRef.TextFonts.Count
See Application on page 17, specifically the Fonts property, for more information.
Properties
Property
Value Type
What it is
Application
Object
(Application)
Count
Number (Long)
Parent
Object
(Application)
typename
String
Parameter Type
Returns
What it does
Number (Long)
TextFont
Methods
Method
Index
(ItemPtr)
Object
(TextFont)
Item
(ItemKey)
Number (Long)
VBScript Interface
149
TextItem
The text in an ArtLayer object whose Kind propertys value is 2.
Note: See ArtLayer, specifically the Kind property, for more information.
Properties
Property
Value Type
What it is
AlternateLigatures
Boolean
AntiAliasMethod
PsAntiAlias
Application
Object
(Application)
AutoKerning
PsAutoKernType
AutoLeadingAmount
Number (Double)
BaselineShift
Number (Double)
Capitalization
PsCase
Color
Object
(SolidColor)
Contents
String
DesiredGlyphScaling
Number (Double)
VBScript Interface
150
Property
Value Type
What it is (Continued)
DesiredLetterScaling
Number (Double)
Direction
PsDirection
FauxBold
Boolean
FauxItalic
Boolean
FirstLineIndent
Number (Double)
Font
String
HangingPunctuation
Boolean
Height
Number (Double)
VBScript Interface
151
Property
Value Type
What it is (Continued)
HorizontalScale
Number (Long)
HyphenateAfterFirst
Number (Long)
HyphenateBeforeLast
Number (Long)
HyphenateCapitalWords
Boolean
Hyphenation
Boolean
HyphenationZone
Number (Double)
HyphenLimit
Number (Long)
Justification
PsJustification
Kind
PsTextType
Language
PsLanguage
Leading
Number (Double)
LeftIndent
Number (Double)
Ligatures
Boolean
MaximumGlyphScaling
Number (Double)
VBScript Interface
Property
Value Type
What it is (Continued)
MaximumLetterScaling
Number (Double)
MaximumWordScaling
MinimumGlyphScaling
152
Number (Double)
MinimumLetterScaling
Number (Double)
VBScript Interface
153
Property
Value Type
What it is (Continued)
MinimumWordScaling
Number (Double)
OldStyle
Boolean
Parent
Object
(ArtLayer)
Position
Array of Number
(Double)
RightIndent
Number (Double)
Size
Number (Double)
SpaceAfter
Number (Double)
SpaceBefore
Number (Double)
StrikeThru
TextComposer
PsTextComposer
VBScript Interface
Property
Value Type
What it is (Continued)
Tracking
Number (Double)
154
String
Underline
PsUnderlineType
UseAutoLeading
Boolean
VerticalScale
Number (Long)
WarpBend
Number (Double)
WarpDirection
PsDirection
WarpStyle
PsWarpStyle
WarpVerticalDistortion
Number (Double)
Width
Number (Double)
Methods
Method
ConvertToShape
()
CreatePath
()
What it does
Converts the text item and its containing layer to
a fill layer with the text changed to a clipping
path.
Creates a clipping path from the outlines of the
actual text items (such as letters or words).
VBScript Interface
155
TiffSaveOptions
Options that can be specified when saving a document in TIFF format.
Properties
Property
Value Type
What it is
AlphaChannels
Boolean
Annotations
Boolean
Application
belongs to.
ByteOrder
PsByteOrder
EmbedColorProfile
Boolean
ImageCompression
PsTIFFEncodingType
InterleaveChannels
Boolean
JPEGQuality
Number (Long)
Read-write. The quality of the produced image (0 12), which is inversely proportionate to the
amount of JPEG compression.
Note: Valid only when ImageCompression = 3
(psTiffJPEG).
LayerCompression
Boolean
SaveImagePyramid
Boolean
SpotColors
Boolean
VBScript Interface
Property
Value Type
What it is (Continued)
Transparency
Boolean
typename
String
156
VBScript Interface
157
XMPMetadata
Camera raw image file settings stored in an XMP file in the same folder as the raw file with the same base
name and an XMP extension.
Properties
Property
Value Type
What it is
Application
Object
Read-only. The application that the object belongs
(Application)
to.
Parent
Object
(Document)
RawData
String
typename
String
Scripting Constants
This section lists and describes the enumerations defined for use with Adobe Photoshop CS3 VBScript
properties and methods.
XXX
Constant type
Values
What it means
PsAdjustmentReference
1 (psRelative)
2 (psAbsolute)
PsAnchorPosition
1
2
3
4
5
6
7
8
9
(psTopLeft)
(psTopCenter)
(psTopRight)
(psMiddleLeft)
(psMiddleCenter)
(psMiddleRight)
(psBottomLeft)
(psBottomCenter)
(psBottomRight)
PsAntiAlias
1
2
3
4
5
(psNoAntialias)
(psSharp)
(psCrisp)
(psStrong)
(psSmooth)
PsAutoKernType
1 (psManual)
2 (psMetrics)
3 (psOptical)
PsBatchDestinationType
1 (psNoDestination)
2 (psSaveAndClose)
3 (psFolder)
PsBitmapConversionType
1
2
3
4
5
(psHalfThreshold)
(psPatternDither)
(psDiffusionDither)
(psHalftoneScreen)
(psCustomPattern)
PsBitmapHalfToneType
1
2
3
4
5
6
(psHalftoneRound)
(psHalftoneDiamond)
(psHalftoneEllipse)
(psHalftoneLine)
(psHalftoneSquare)
(psHalftoneCross)
PsBitsPerChannelType
1 (psDocument1Bit)
8 (psDocument8Bits)
16 (psDocument16Bits)
32 (psDocument32Bits)
158
Scripting Constants
159
Constant type
Values
What it means
PsBlendMode
1 (psPassThrough)
2 (psNormalBlend)
3 (psDissolve)
4 (psDarken)
5 (psMultiply)
6 (psColorBurn)
7 (psLinearBurn)
8 (psLighten)
9 (psScreen)
10 (psColorDodge)
11 (psLinearDodge)
12 (psOverlay)
13 (psSoftLight)
14 (psHardLight)
15 (psVividLight)
16 (psLinearLight)
17 (psPinLight)
18 (psDifference)
19 (psExclusion)
20 (psHue)
21 (psSaturationBlend)
22 (psColorBlend)
23 (psLuminosity)
26 (psHardMix)
PsBMPDepthType
1 (psBMP1Bit)
4 (psBMP4Bits)
8 (psBMP8Bits)
16 (psBMP16Bits)
24 (psBMP24Bits)
32 (psBMP32Bits)
60 (psBMP_X1R5G5B5)
61 (psBMP_A1R5G5B5)
62 (psBMP_R5G6B5)
63 (psBMP_X4R4G4B4)
64 (psBMP_A4R4G4B4)
65 (psBMP_R8G8B8)
66 (psBMP_X8R8G8B8)
67 (psBMP_A8R8G8B8)
PsByteOrder
1 (psIBMByteOrder)
2 (psMacOSByteOrder)
PsCameraRAWSettingsType
0 (psCameraDefault)
1 (psSelectedImage)
2 (psCustomSettings)
PsCameraRAWSize
0
1
2
3
4
5
PsCase
1 (psNormalCase)
2 (psAllCaps)
3 (psSmallCaps)
(psMinimumCameraRAW)
(psSmallCameraRAW)
(psMediumCameraRAW)
(psLargeCameraRAW)
(psExtraLargeCameraRAW)
(psMaximumCameraRAW)
Scripting Constants
160
Constant type
Values
What it means
PsChangeMode
1
2
3
4
5
6
7
PsChannelType
1 (psComponentChannel)
2
(psMaskedAreaAlphaChannel)
3
(psSelectedAreaAlphaChannel
)
4 (psSpotColorChannel)
PsColorBlendMode
2 (psNormalBlendColor)
3 (psDissolveBlend)
4 (psDarkenBlend)
5 (psMultiplyBlend)
6 (psColorBurnBlend)
7 (psLinearBurnBlend)
8 (psLightenBlend)
9 (psScreenBlend)
10 (psColorDodgeBlend)
11 (psLinearDodgeBlend)
12 (psOverlayBlend)
13 (psSoftLightBlend)
14 (psHardLightBlend)
15 (psVividLightBlend)
16 (psLinearLightBlend)
17 (psPinLightBlend)
18 (psDifferenceBlend)
19 (psExclusionBlend)
20 (psHueBlend)
21 (psSaturationBlendColor
22 (psColorBlendMode)
23 (psLuminosityBlend
24 (psBehindBlend)
25 (psClearBlend)
26 (psHardMixBlend)
PsColorModel
1 (psGrayscaleModel)
2 (psRGBModel)
3 (psCMYKModel)
4 (psLabModel)
5 (psHSBModel)
50 (psNoModel)
PsColorPicker
1
2
3
4
PsColorProfileType
1 (psNo)
2 (psWorking)
3 (psCustom)
(psConvertToGrayscale)
The type of color mode to use.
(psConvertToRGB)
(psConvertToCMYK)
Note: Color images must be changed
(psConvertToLab)
to grayscale (1) mode before
(psConvertToBitmap)
you can change them to bitmap
(psConvertToIndexedColor)
(psConvertToMultiChannel)
(5) mode.
(psAdobeColorPicker)
(psAppleColorPicker)
(psWindowsColorPicker)
(psPlugInColorPicker)
Scripting Constants
161
Constant type
Values
What it means
PsColorReductionType
0
1
2
3
4
5
6
7
8
(psPerceptualReduction)
(psSelective)
(psAdaptive)
(psRestrictive)
(psCustomReduction)
(psBlackWhiteReduction)
(psSFWGrayscale)
(psMacintoshColors)
(psWindowsColors)
PsColorSpaceType
0
1
2
3
(psAdobeRGB)
(psColorMatchRGB)
(psProPhotoRGB)
(psSRGB)
PsCopyrightedType
1 (psCopyrightedWork)
2 (psPublicDomain)
3 (psUnmarked)
PsCreateFields
1 (psDuplication)
2 (psInterpolation)
PsCropToType
0
1
2
3
4
5
PsDCSType
1 (psNoComposite)
2 (psGrayscaleComposite)
3 (psColorComposite)
(psBoundingBox)
(psMediaBox)
(psCropBox)
(psBleedBox)
(psTrimBox)
(psArtBox)
(psNoSource)
(psTransparencyChannel)
(psLayerMask)
(psImageHighlight)
PsDepthMapSource
1
2
3
4
PsDescValueType
1 (psIntegerType)
2 (psDoubleType)
3 (psUnitDoubleType)
4 (psStringType)
5 (psBooleanType)
6 (psListType)
7 (psObjectType)
8 (psEnumeratedType)
9 (psReferenceType)
10 (psClassType)
11 (psAliasType)
12 (psRawType)
PsDialogModes
1 (psDisplayAllDialogs)
2 (psDisplayErrorDialogs)
3 (psDisplayNoDialogs)
PsDirection
1 (psHorizontal)
2 (psVertical)
Scripting Constants
162
Constant type
Values
What it means
PsDisplacementMapType
1 (psStretchToFit)
2 (psTile)
PsDitherType
1
2
3
4
PsDocumentFill
1 (psWhite)
2 (psBackgroundColor)
3 (psTransparent)
PsDocumentMode
1
2
3
4
5
6
7
8
PsEditLogItemsType
1 (psSessionOnly)
2 (psConcise)
3 (psDetailed)
PsElementPlacement
0
1
2
3
4
(psNoDither)
(psDiffusion)
(psPattern)
(psNoise)
(psGrayscale)
(psRGB)
(psCMYK)
(psLab)
(psBitmap)
(psIndexedColor)
(psMultiChannel)
(psDuotone)
(psPlaceInside)
(psPlaceAtBeginning)
(psPlaceAtEnd)
(psPlaceBefore)
(psPlaceAfter)
PsEliminateFields
1 (psOddFields)
2 (psEvenFields)
PsExportType
1 (psIllustratorPaths)
2 (psSaveForWeb)
PsExtensionType
2 (psLowercase)
3 (psUppercase)
Scripting Constants
163
Constant type
Values
What it means
PsFileNamingType
1 (psDocumentNameMixed)
2 (psDocumentNameLower)
3 (psDocumentNameUpper)
4 (psSerialNumber1)
5 (psSerialNumber2)
6 (psSerialNumber3)
7 (psSerialNumber4)
8 (psSerialLetterLower)
9 (psSerialLetterUpper)
10 (psMmddyy)
11 (psMmdd)
12 (psYyyymmdd)
13 (psYymmdd)
14 (psYyddmm)
15 (psDdmmyy)
16 (psDdmm)
17 (psExtensionLower)
18 (psExtensionUpper)
psFontPreviewType
0
1
2
3
(psFontPreviewNone)
(psFontPreviewSmall)
(psFontPreviewMedium)
(psFontPreviewLarge)
PsForcedColors
1
2
3
4
(psNoForced)
(psBlackWhite)
(psPrimaries)
(psWeb)
PsFormatOptionsType
1 (psStandardBaseline)
2 (psOptimizedBaseline)
3 (psProgressive)
PsGalleryConstrainType
1 (psConstrainWidth)
2 (psConstrainHeight)
3 (psConstrainBoth)
PsGalleryFontType
1
2
3
4
(psArial)
(psCourierNew)
(psHelvetica)
(psTimesNewRoman)
PsGallerySecurityTextPositionType
1
2
3
4
5
(psCentered)
(psUpperLeft)
(psLowerLeft)
(psUpperRight)
(psLowerRight)
PsGallerySecurityTextRotateType
1
2
3
4
5
(psZero)
(psClockwise45)
(psClockwise90)
(psCounterClockwise45)
(psCounterClockwise90)
Scripting Constants
164
Constant type
Values
What it means
PsGallerySecurityType
1
2
3
4
5
6
7
(psNoSecurity)
(psCustomSecurityText)
(psFilename)
(psCopyright)
(psCaption)
(psCredit)
(psTitle)
PsGalleryThumbSizeType
1
2
3
4
(psSmall)
(psMedium)
(psLarge)
(psCustomThumbnail)
PsGeometry
0
1
2
3
4
5
(psTriangle)
(psPentagon)
(psHexagon)
(psSquareGeometry)
(psHeptagon)
(psOctagon)
PsGridLineStyle
1 (psGridSolidLine)
2 (psGridDashedLine)
3 (psGridDottedLine)
PsGridSize
1
2
3
4
PsGuideLineStyle
1 (psGuideSolidLine)
2 (psGuideDashedLine)
PsIllustratorPathType
1 (psDocumentBounds)
2 (psAllPaths)
3 (psNamedPath)
PsIntent
1
2
3
4
PsJavaScriptExecutionMode
1 (psNeverShowDebugger)
2 (psDebuggerOnError)
3 (psBeforeRunning)
PsJustification
1
2
3
4
5
6
7
(psNoGrid)
(psSmallGrid)
(psMediumGrid)
(psLargeGrid)
(psPerceptual)
(psSaturation)
(psRelativeColorimetric)
(psAbsoluteColorimetric)
(psLeft)
(psCenter)
(psRight)
(psLeftJustified)
(psCenterJustified)
(psRightJustified)
(psFullyJustified)
Scripting Constants
165
Constant type
Values
PsLanguage
1 (psEnglishUSA)
The language to use.
2 (psEnglishUK)
3 (psFrench)
4 (psCanadianFrench)
5 (psFinnish)
6 (psGerman)
7 (psOldGerman)
8 (psSwissGerman)
9 (psItalian)
10 (psNorwegian)
11 (psNynorskNorwegian)
12 (psPortuguese)
13 (psBrazillianPortuguese)
14 (psSpanish)
15 (psSwedish)
16 (psDutch)
17 (psDanish)
PsLayerCompressionType
1 (psRLELayerCompression)
2 (psZIPLayerCompression)
PsLayerKind
1 (psNormalLayer)
The kind of ArtLayer object.
2 (psTextLayer)
3 (psSolidFillLayer)
4 (psGradientFillLayer)
5 (psPatternfillLayer)
6 (psLevelsLayer)
7 (psCurvesLayer)
8 (psColorBalanceLayer)
9
(psBrightnessContrastLayer)
10 (psHueSaturationLayer)
11 (psSelectiveColorLayer)
12 (psChannelMixerLayer)
13 (psGradientMapLayer)
14 (psInversionLayer)
15 (psThresholdLayer)
16 (psPosterizeLayer)
17 (psSmartObjectLayer)
18 (psPhotoFilterLayer)
19 (psExposureLayer)
20 (psLayer3D)
21 (psVideoLayer)
PsLayerType
1 (psArtLayer)
2 (psLayerSet)
PsLensType
1
2
3
5
PsMagnificationType
0 (psActualSize)
1 (psFitPage)
PsMatteType
1
2
3
4
5
6
7
(psZoomLens)
(psPrime35)
(psPrime105)
(psMoviePrime)
(psNoMatte)
(psForegroundColorMatte)
(psBackgroundColorMatte)
(psWhiteMatte)
(psBlackMatte)
(psSemiGray)
(psNetscapeGrayMatte)
What it means
Scripting Constants
166
Constant type
Values
What it means
PsMeasurementRange
1 (psAllMeasurements)
2 (psActiveMeasurements)
PsMeasurementSource
1 (psMeasureSelection)
2 (psMeasureCountTool)
3 (psMeasureRulerTool)
PsNewDocumentMode
1
2
3
4
5
PsNoiseDistribution
1 (psUniformNoise)
2 (psGaussianNoise)
PsOffsetUndefinedAreas
1 (psOffsetSetToLayerFill)
2 (psOffsetWraparound)
3
(psOffsetRepeatEdgePixels)
PsOpenDocumentMode
1
2
3
4
PsOpenDocumentType
1 (psPhotoshopOpen)
2 (psBMPOpen)
3 (psCompuServeGIFOpen)
4 (psPhotoshopEPSOpen)
5 (psFilmstripOpen)
6 (psJPEGOpen)
7 (psPCXOpen)
8 (psPhotoshopPDFOpen)
9 (psPhotoCDOpen)
10 (psPICTFileFormatOpen)
11
(psPICTResourceFormatOpen)
12 (psPixarOpen)
13 (psPNGOpen)
14 (psRawOpen)
15 (psScitexCTOpen)
16 (psTargaOpen)
17 (psTIFFOpen)
18 (psPhotoshopDCS_1Open)
19 (psPhotoshopDCS_2Open)
21 (psPDFOpen)
22 (psEPSOpen)
23 (psEPSPICTPreviewOpen)
24 (psEPSTIFFPreviewOpen)
25 (psAliasPIXOpen)
26 (psElectricImageOpen)
27 (psPortableBitmapOpen)
28 (psWavefrontRLAOpen)
29 (psSGIRGBOpen)
30 (psSoftImageOpen)
31 (psWirelessBitmapOpen)
32 (psCameraRAWOpen)
33 (psDICOMOpen)
PsOperatingSystem
(psNewGray)
(psNewRGB)
(psNewCMYK)
(psNewLab)
(psNewBitmap)
(psOpenGray)
(psOpenRGB)
(psOpenCMYK)
(psOpenLab)
1 (psOS2)
2 (psWindows)
Scripting Constants
167
Constant type
Values
What it means
PsOrientation
1 (psLandscape)
2 (psPortrait)
PsOtherPaintingCursors
1 (psStandardOther)
2 (psPreciseOther)
PsPaintingCursors
1 (psStandard)
2 (psPrecise)
3 (psBrushsize)
PsPaletteType
1 (psExact)
2 (psMacOSPalette)
3 (psWindowsPalette
4 (psWebPalette)
5 (psUniform)
6 (psLocalPerceptual)
7 (psLocalSelective)
8 (psLocalAdaptive)
9 (psMasterPerceptual)
10 (psMasterSelective)
11 (psMasterAdaptive)
12 (psPreviousPalette)
PsPathKind
1
2
3
4
5
(psNormalPath)
(psClippingPath)
(psWorkPath)
(psVectorMask)
(psTextMask)
PsPDFCompatibilityType
1
2
3
4
(psPDF13)
(psPDF14)
(psPDF15)
(psPDF16)
PsPDFEncoding
0 (psPDFNone)
1 (psPDFZip)
2 (psPDFJPEG)
3 (psPDFPDFZip4Bit)
4 (psPDFJPEGHIGH)
5 (psPDFJPEGMEDHIGH)
6 (psPDFJPEGMED)
7 (psPDFJPEGMEDLOW)
8 (psPDFJPEGLOW)
9 (psPDFJPEG2000High)
10 (psPDFJPEG2000MEDHIGH)
11 (psPDFJPEG2000MED)
12 (psPDFJPEG2000MEDLOW)
13 (psPDFJPEG2000LOW)
14 (psPDFJPEG2000LOSSLESS)
PsPDFResampleType
0
1
2
3
(psNoResample)
(psPDFAverage)
(psPDFSubSample)
(psPDFBicubic)
Scripting Constants
168
Constant type
Values
What it means
PsPDFStandardType
0
1
2
3
4
(psNoStandard)
(psPDFX1A2001)
(psPDFX1A2003)
(psPDFX32002)
(psPDFX32003)
PsPhotoCDColorSpace
1
2
3
4
(psRGB8)
(psRGB16)
(psLab8)
(psLab16)
1
2
3
4
5
6
(psMinimumPhotoCD)
(psSmallPhotoCD)
(psMediumPhotoCD)
(psLargePhotoCD)
(psExtralargePhotoCD)
(psMaximumPhotoCD)
PsPhotoCDSize
psMinimumPhotoCD = 64x96
psSmallPhotoCD = 128x192
psMediumPhotoCD = 256x384
psLargePhotoCD = 512x768
psExtralargePhotoCD = 1024x1536
psMaximumPhotoCD = 2048x3072
PsPICTCompression
1
2
4
5
6
(psNoPICTCompression)
(psJPEGLowPICT)
(psJPEGMediumPICT)
(psJPEGHighPICT)
(psJPEGMaximumPICT)
PsPicturePackageTextType
1
2
3
4
5
6
7
(psNoText)
(psUserText)
(psFilenameText)
(psCopyrightText)
(psCaptionText)
(psCreditText)
(psOriginText)
PsPointKind
1 (psSmoothPoint)
2 (psCornerPoint)
PsPointType
1 (psPostScriptPoints)
2 (psTraditionalPoints)
PsPICTBitsPerPixels
Scripting Constants
169
Constant type
Values
What it means
PsPolarConversionType
1 (psRectangularToPolar)
2 (psPolarToRectangular)
PsPreviewType
1 (psNoPreview)
2 (psMonochromeTIFF)
3 (psEightbitTIFF)
PsPrintEncoding
1 (psBinaryEncoding)
2 (psJPEGEncoding)
3 (psAsciiEncoding)
PsPurgeTarget
1
2
3
4
PsQueryStateType
1 (psAlways)
2 (psAsk)
3 (psNever)
PsRadialBlurMethod
1 (psSpin)
2 (psZoom)
PsRadialBlurQuality
1 (psRadialBlurDraft)
2 (psRadialBlurGood)
3 (psRadialBlurBest)
PsRasterizeType
1
2
3
4
5
6
PsReferenceFormType
1 (psReferenceNameType)
The type of an ActionReference object.
2 (psReferenceIndexType)
3
(psReferenceIdentifierType)
4 (psReferenceOffsetType)
5
(psReferenceEnumeratedType)
6 (psReferencePropertyType)
7 (psReferenceClassType)
PsResampleMethod
1
2
3
4
5
6
PsRippleSize
1 (psSmallRipple)
2 (psMediumRipple)
3 (psLargeRipple)
PsSaveBehavior
1 (psNeverSave)
2 (psAlwaysSave)
3 (psAskWhenSaving)
(psUndoCaches)
(psHistoryCaches)
(psClipboardCache)
(psAllCaches)
(psTextContents)
(psShape)
(psFillContent)
(psLayerClippingPath)
(psEntireLayer)
(psLinkedLayers)
(psNoResampling)
(psNearestNeighbor)
(psBilinear)
(psBicubic)
(psBicubicSharper)
(psBicubicSmoother)
Scripting Constants
170
Constant type
Values
What it means
PsSaveDocumentType
1 (psPhotoshopSave)
2 (psBMPSave)
3 (psCompuServeGIFSave)
4 (psPhotoshopEPSSave)
6 (psJPEGSave)
7 (psPCXSave)
8 (psPhotoshopPDFSave)
10 (psPICTFileFormatSave)
12 (psPixarSave)
13 (psPNGSave)
14 (psRawSave)
15 (psScitexCTSave)
16 (psTargaSave)
17 (psTIFFSave)
18 (psPhotoshopDCS_1Save)
19 (psPhotoshopDCS_2Save)
25 (psAliasPIXSave)
26 (psElectricImageSave)
27 (psPortableBitmapSave)
28 (psWavefrontRLASave)
29 (psSGIRGBSave)
30 (psSoftImageSave)
31 (psWirelessBitmapSave)1
PsSaveEncoding
1
2
3
4
5
6
PsSaveLogItemsType
1 (psMetadata)
2 (psLogFile)
3 (psLogFileAndMetadata)
PsSaveOptions
1 (psSaveChanges)
2 (psDoNotSaveChanges)
3 (psPromptToSaveChanges)
PsSelectionType
1
2
3
4
(psReplaceSelection)
(psExtendSelection)
(psDiminishSelection)
(psIntersectSelection)
PsShapeOperation
1
2
3
4
(psShapeAdd)
(psShapeXOR)
(psShapeIntersect)
(psShapeSubtract)
PsSmartBlurMode
1 (psSmartBlurNormal)
2 (psSmartBlurEdgeOnly)
3 (psSmartBlurOverlayEdge)
(psBinary)
(psJPEGLow)
(psAscii)
(psJPEGMedium)
(psJPEGHigh)
(psJPEGMaximum)
Scripting Constants
171
Constant type
Values
What it means
PsSmartBlurQuality
1 (psSmartBlurLow)
2 (psSmartBlurMedium)
3 (psSmartBlurHigh)
PsSourceSpaceType
1 (psDocumentSpace)
2 (psProofSpace)
PsSpherizeMode
1 (psNormalSpherize)
2 (psHorizontalSpherize)
3 (psVerticalSpherize)
PsStrikeThruType
1 (psStrikeOff)
2 (psStrikeHeight)
3 (psStrikeBox)
PsStrokeLocation
1 (psInsideStroke)
2 (psCenterStroke)
3 (psOutsideStroke)
PsTargaBitsPerPixels
16 (psTarga16Bits)
24 (psTarga24Bits)
32 (psTarga32Bits)
PsTextComposer
1 (psAdobeSingleLine)
2 (psAdobeEveryLine)
PsTextType
1 (psPointText)
2 (psParagraphText)
PsTextureType
1
2
3
4
5
(psBlocksTexture)
(psCanvasTexture)
(psFrostedTexture)
(psTinyLensTexture)
(psTextureFile)
PsTIFFEncodingType
1
2
3
4
(psNoTIFFCompression)
(psTiffLZW)
(psTiffJPEG)
(psTiffZIP)
PsToolType
1 (psPencil)
The tool selection.
2 (psBrush)
3 (psEraser)
4 (psBackgroundEraser)
5 (psCloneStamp)
6 (psPatternStamp)
7 (psHealingBrush)
8 (psHistoryBrush)
9 (psArtHistoryBrush)
10 (psSmudge)
11 (psBlur)
12 (psSharpen)
13 (psDodge)
14 (psBurn)
15 (psSponge)
16 (psColorReplacementTool)
Scripting Constants
172
Constant type
Values
What it means
PsTransitionType
1 (psBlindsHorizontal)
2 (psBlindsVertical)
3 (psDissolveTransition)
4 (psBoxIn)
5 (psBoxOut)
6 (psGlitterDown)
7 (psGlitterRight)
8 (psGlitterRightDown)
9 (psNoTransition)
10 (psRandom)
11 (psSplitHorizontalIn)
12 (psSplitHorizontalOut)
13 (psSplitVerticalIn)
14 (psSplitVerticalOut)
15 (psWipeDown)
16 (psWipeLleft)
17 (psWipeRight)
18 (psWipeUp)
PsTrimType
0 (psTransparentPixels)
1 (psTopLeftPixel)
9 (psBottomRightPixel
PsTypeUnits
1 (psTypePixels)
4 (psTypeMM)
5 (psTypePoints)
PsUndefinedAreas
1 (psWrapAround)
2 (psRepeatEdgePixels)
PsUnderlineType
1 (psUnderlineOff)
2 (psUnderlineRight)
3 (psUnderlineLeft)
PsUnits
1
2
3
4
5
6
7
(psPixels)
(psInches)
(psCM)
(psMM)
(psPoints)
(psPicas)
(psPercent)
PsUrgency
0
1
2
3
4
5
6
7
8
(psNone)
(psLow)
(psTwo)
(psThree)
(psFour)
(psNormal)
(psSix)
(psSeven)
(psHigh)
Scripting Constants
173
Constant type
Values
What it means
PsWarpStyle
1 (psNone)
2 (psArc)
3 (psArcLower)
4 (psArcUpper)
5 (psArch)
6 (psBulge)
7 (psShellLower)
8 (psShellUpper)
9 (psFlag)
10 (psWave)
11 (psFish)
12 (psRise)
13 (psFishEye)
14 (psInflate)
15 (psSqueeze)
16 (psTwist)
PsWaveType
1 (psSine)
2 (psTriangular)
3 (psSquare)
PsWhiteBalanceType
0
1
2
3
4
5
6
7
8
PsZigZagType
1 (psAroundCenter)
2 (psOutFromCenter)
3 (psPondRipples)
(psAsShot)
(psAuto)
(psDaylight)
(psCloudy)
(psShade)
(psTungsten)
(psFluorescent)
(psFlash)
(psCustomCameraSettings)
4-char ID or String
3DTransform
'TdT '
Average
'Avrg'
ApplyStyle
'ASty'
Assert
'Asrt'
AccentedEdges
'AccE'
Add
'Add '
AddNoise
'AdNs'
AddTo
'AddT'
Align
'Algn'
All
'All '
AngledStrokes
'AngS'
ApplyImage
'AppI'
BasRelief
'BsRl'
Batch
'Btch'
BatchFromDroplet
'BtcF'
Blur
'Blr '
BlurMore
'BlrM'
Border
'Brdr'
Brightness
'BrgC'
CanvasSize
'CnvS'
ChalkCharcoal
'ChlC'
ChannelMixer
'ChnM'
174
175
Event
4-char ID or String
Charcoal
'Chrc'
Chrome
'Chrm'
Clear
'Cler'
Close
'Cls '
Clouds
'Clds'
ColorBalance
'ClrB'
ColorHalftone
'ClrH'
ColorRange
'ClrR'
ColoredPencil
'ClrP'
ContactSheet
"0B71D221-F8CE-11d2-B21B-0008C75B322
C"
ConteCrayon
'CntC'
Contract
'Cntc'
ConvertMode
'CnvM'
Copy
'copy'
CopyEffects
'CpFX'
CopyMerged
'CpyM'
CopyToLayer
'CpTL'
Craquelure
'Crql'
CreateDroplet
'CrtD'
Crop
'Crop'
Crosshatch
'Crsh'
Crystallize
'Crst'
Curves
'Crvs'
Custom
'Cstm'
Cut
'cut '
CutToLayer
'CtTL'
Cutout
'Ct
DarkStrokes
'DrkS'
DeInterlace
'Dntr'
DefinePattern
'DfnP'
Defringe
'Dfrg'
Delete
'Dlt '
Desaturate
'Dstt'
'
176
Event
4-char ID or String
Deselect
'Dslc'
Despeckle
'Dspc'
DifferenceClouds
'DfrC'
Diffuse
'Dfs '
DiffuseGlow
'DfsG'
DisableLayerFX
'dlfx'
Displace
'Dspl'
Distribute
'Dstr'
Draw
'Draw'
DryBrush
'DryB'
Duplicate
'Dplc'
DustAndScratches
'DstS'
Emboss
'Embs'
Equalize
'Eqlz'
Exchange
'Exch'
Expand
'Expn'
Export
'Expr'
Jumpto
'Jpto'
ExportTransparentImage
"02879e00-cb66-11d1-bc43-0060b0a13dc
4"
Extrude
'Extr'
Facet
'Fct '
Fade
'Fade'
Feather
'Fthr'
Fibers
'Fbrs'
Fill
'Fl
FilmGrain
'FlmG'
Filter
'Fltr'
FindEdges
'FndE'
FitImage
"3caa3434-cb67-11d1-bc43-0060b0a13dc
4"
FlattenImage
'FltI'
Flip
'Flip'
Fragment
'Frgm'
'
Event
4-char ID or String
Fresco
'Frsc'
GaussianBlur
'GsnB'
Get
'getd'
Glass
'Gls '
GlowingEdges
'GlwE'
Gradient
'Grdn'
GradientMap
'GrMp'
Grain
'Grn '
GraphicPen
'GraP'
Group
'GrpL'
Grow
'Grow'
HalftoneScreen
'HlfS'
Hide
'Hd
HighPass
'HghP'
HSBHSL
'HsbP'
HueSaturation
'HStr'
ImageSize
'ImgS'
Import
'Impr'
InkOutlines
'InkO'
Intersect
'Intr'
IntersectWith
'IntW'
Inverse
'Invs'
Invert
'Invr'
LensFlare
'LnsF'
Levels
'Lvls'
LightingEffects
'LghE'
Link
'Lnk '
Make
'Mk
Maximum
'Mxm '
Median
'Mdn '
MergeLayers
'Mrg2'
MergeLayersOld
'MrgL'
MergeSpotChannel
'MSpt'
'
'
177
178
Event
4-char ID or String
MergeVisible
'MrgV'
Mezzotint
'Mztn'
Minimum
'Mnm '
ModeChange
"8cba8cd6-cb66-11d1-bc43-0060b0a13dc
4"
Mosaic
'Msc '
Mosaic_PLUGIN
'MscT'
MotionBlur
'MtnB'
Move
'move'
NTSCColors
'NTSC'
NeonGlow
'NGlw'
Next
'Nxt '
NotePaper
'NtPr'
Notify
'Ntfy'
Null
typeNull
OceanRipple
'OcnR'
Offset
'Ofst'
Open
'Opn '
Paint
'Pnt '
PaintDaubs
'PntD'
PaletteKnife
'PltK'
Paste
'past'
PasteEffects
'PaFX'
PasteInto
'PstI'
PasteOutside
'PstO'
Patchwork
'Ptch'
Photocopy
'Phtc'
PicturePackage
"4C1ABF40-DD82-11d2-B20F-0008C75B322
C"
Pinch
'Pnch'
Place
'Plc '
Plaster
'Plst'
PlasticWrap
'PlsW'
Play
'Ply '
179
Event
4-char ID or String
Pointillize
'Pntl'
Polar
'Plr '
PosterEdges
'PstE'
Posterize
'Pstr'
Previous
'Prvs'
'Prnt'
ProfileToProfile
'PrfT'
Purge
'Prge'
Quit
'quit'
RadialBlur
'RdlB'
Rasterize
'Rstr'
RasterizeTypeSheet
'RstT'
RemoveBlackMatte
'RmvB'
RemoveLayerMask
'RmvL'
RemoveWhiteMatte
'RmvW'
Rename
'Rnm '
ReplaceColor
'RplC'
Reset
'Rset'
ResizeImage
"1333cf0c-cb67-11d1-bc43-0060b0a13dc
4"
Reticulation
'Rtcl'
Revert
'Rvrt'
Ripple
'Rple'
Rotate
'Rtte'
RoughPastels
'RghP'
Save
'save'
Select
'slct'
SelectiveColor
'SlcC'
Set
'setd'
SharpenEdges
'ShrE'
Sharpen
'Shrp'
SharpenMore
'ShrM'
Shear
'Shr '
Show
'Shw '
Event
4-char ID or String
Similar
'Smlr'
SmartBlur
'SmrB'
Smooth
'Smth'
SmudgeStick
'SmdS'
Solarize
'Slrz'
Spatter
'Spt '
Spherize
'Sphr'
SplitChannels
'SplC'
Sponge
'Spng'
SprayedStrokes
'SprS'
StainedGlass
'StnG'
Stamp
'Stmp'
Stop
'Stop'
Stroke
'Strk'
Subtract
'Sbtr'
SubtractFrom
'SbtF'
Sumie
'Smie'
TakeMergedSnapshot
'TkMr'
TakeSnapshot
'TkSn'
TextureFill
'TxtF'
Texturizer
'Txtz'
Threshold
'Thrs'
Tiles
'Tls '
TornEdges
'TrnE'
TraceContour
'TrcC'
Transform
'Trnf'
Trap
'Trap'
Twirl
'Twrl'
Underpainting
'Undr'
Undo
'undo'
Ungroup
'Ungr'
Unlink
'Unlk'
UnsharpMask
'UnsM'
180
Event
4-char ID or String
Variations
'Vrtn'
Wait
'Wait'
WaterPaper
'WtrP'
Watercolor
'Wtrc'
Wave
'Wave'
Wind
'Wnd '
ZigZag
'ZgZg'
BackLight
'BacL'
FillFlash
'FilE'
ColorCast
'ColE'
181
Index
A
Action Manager
scripting objects 9
actions
executing 19
active links 78
Add Noise filter 26
adjust
contrast 30
AdjustBrightnessContrast 25
adjusting
brightness 25
color balance 25
colors 158
component channels 31
curves 25
highlights 32
layers color balance 31
levels 25, 30
shadows 32
temperature 31
Adobe Photoshop CS 2
activating 18
new features 5
version 18
alpha channels
defined 42
anchor points
path point info 114
path points 113
anchor position
types 158
annotations 63
anti alias
text 149
types 158
application
activating 18
checking if feature enabled 20
code sample 22
location 17
preferences 127
version 18
art layers, See layers
Asian text 129
Average filter 26
B
background color
application 17
galleries 78
background layer
designating 24
finding 59
Batch command
destination folder 36
batch command
destination types 158
input folder 19
beep 127
bitmap documents
converting to 38
opening 166
saving 39
bitmap images
See bitmap documents 38
BitmapConversionOptions 38
black and white images 32
blend modes 159
Blur filter 26
blur filters
Average 26
Blur 26
Blur More 26
Gaussian Blur 26
Lens Blur 27
Motion Blur 28
Radial Blur 28
Smart Blur 29
Blur More filter 26
BMP documents
opening 166
saving 39
brightness
adjusting 25
camera shots 40
equalizing 30
C
caches
histograms 128
images 128
purging 21
camera raw documents
opening 40, 166
canvases
resizing 64
rotating 63
captions
contact sheets 52
galleries 79
channels
activating 59
adding 43, 55
alpha See alpha channels
code sample 43
182
Index
adjusting 25
defining 29
Custom filter 26
D
DCS1 documents
opening 166
saving 56
DCS2 documents
opening 166
saving 57
default units 129
De-Interlace filter 26
Deprecated 20
Despeckle filter 26
dialogs
displaying 17
modes 161
DICOM format documents
opening 58
Difference Clouds filter 26
Diffuse Glow filter 26
Displace filter 26
distort filters
Diffuse Glow 26
Displace 26
Glass Effect 27
Ocean Ripple 28
Pinch 28
Polar Coordinates 28
Ripple 28
Shear 29
Spherize 29
Twirl 29
Wave 29
Zigzag 30
documents
activating 17
adding 71
closing 62
color samplers 59
colors 59
counting items 60
counting objects 62
creating 71
cropping 63
exporting 63
loading 20
managed 60
measurement scale 60
metadata 61, 68
open with Photoshop dialog 21
opening 21
printing 64
sample code 66
saving 65
size 60
specifying author 68
title 69
183
E
edit log 127
EPS documents
opening 72, 166
saving 73
equalizing, brightness values 30
event IDs
using ScriptListener to find 174
events, associating with actions 107
EXIF 68
exporting
documents 63
paths 74
to Illustrator 74
to the web 74
type of 162
F
file extensions, case of 162
file types
Macintosh 17
naming 163
Windows 18
files
extensions 130
merging 20
naming types 163
Filmstrips, opening 166
filters
See individual filter names
fonts
contact sheets 52
family 147
finding 17
gallery banners 77
gallery type 164
picture packages 123
PostScript names 147
foreground color 17
G
galleries
banners 77
constrain types 163
font type 164
image options 79
making 20
photographer 77
security options 83
security type 164
thumbnails 84
Gaussian Blur filter 26
GIF documents
opening 166
Index
saving 85
Glass Effect filter 27
GrayColor 87
grid options 128
guide options 128
H
High Pass filter 27
highlights 25, 32
histograms
caches 128
channels 42
code sample 43
documents 60
history states
activating 59
number of 128
snapshot 88
HSBColor 90
I
IDs
string to type 21
type to char 21
type to string 21
images
black and white 32
cache level 128
gallery 79
previews 128
resizing 64
indexed color model 91
J
JavaScript
executing from VBScript 19
JPEG documents
opening 166
saving 93
justification 151, 164
K
kerning
types of 158
keyboard options 128
keywords 69
L
Lab color 94
layer comps
adding 96
applying 95
using visibility in 95
layer sets
adding 100
finding layers in 98
linking 99
184
Index
making visible 98
moving 99
nesting 98
opacity 98
sample code 100
unlinking 99
layer styles 29
layers
activating 59
adding 35
adjusting 25
applying filters 2630
applying styles to 29
background 24
clipboard commands 3031
counting 97
flattening 64
grouping 24
kind 24
linking 30
locking contents 2425
making visible 25
merging 31
rasterizing 31, 64
sample code 33
types 165
left direction points 113
path point info 114
Lens Blur filter
applying 27
Lens Flare filter 28
levels
adjusting 25
adjusting automatically 30
link colors
active 78
visited 78
linking layers 30
Macintosh
compatibility in Batch command 36
file types 17
Maximum filter 28
Median Noise filter 28
memory, available 17
merging
channels 42
files 20
layer sets 99
layers 31
layers (in copy command) 135
visible layers 64
metadata 157
midtones 25
Minimum filter 28
Motion Blur filter 28
O
Ocean Ripple filter 28
Offset filter 28
opacity
channels 42
layer sets 98
layers 24
picture packages 123
open options
Camera RAW format 40
DICOM format 58
EPS format 72
PDF format 116
Photo CD format 120
raw format 132
optimizing 74, 75
other filters
Custom 26
High Pass 27
Maximum 28
Minimum 28
Offset 28
185
Q
Quick Mask mode 60
Index
R
Radial Blur filter 28
rasterizing 31
raw documents
opening 132, 166
saving 133
RecordMeasurements 64
render filters
Clouds 26
Difference Clouds 26
Lens Flare 28
RGBColor 134
right direction points
defining 113
path point info 114
Ripple filter 28
ruler units 129, 172
S
save as 65
saving
See individual document formats
Compuserve GIF documents 85
ESP documents 73
GIF documents 85
JPEG documents 93
PDF documents 117
Photoshop documents 121
PICT files 122
Pixar documents 124
PNG documents 125
PSD documents 121
raw documents 133
SGIRGB documents 141
TIFF documents 155
scripting build date 18
scripting interface, new features 5
scripting version 18
Scripts Events Manager 17
security, galleries 83
selections
clearing 135
creating paths from 136, 137
filling 135
from paths 109
inverting 136, 137
resizing 136, 137
sample code 138
selective color 32
SGIRGB documents
opening 166
saving 141, 158
shadows 25, 32
Sharpen Edges filter 29
Sharpen filter 28
sharpen filters
Sharpen 28
Sharpen Edges 29
Sharpen More 29
186
T
Targa documents
opening 166
saving 146
text
Asian 129
creating paths from 154
creating selections from 154
fonts 150
formatting 149
gallery security 83
hyphenation 151
justification 151
paragraph 171
picture packages 123
point 171
warping 154
text layers
contents 25, 149
creating 24, 165
sample code 100
Texture Fill filter 29
threshold 32
thumbnails 84
sizes 164
specifications 84
TIFF documents
opening 166
saving 155
tool tips, displaying 129
trapping 65
Twirl filter 29
Index
type units 129, 172
U
units
defaults 129
ruler 129, 172
type 129, 172
Unix, compatibility in Batch commands 37
Unsharp Mask filter 29
urgency 69
UTF8 encoding 82
V
video filters
De-Interlace 26
NTSC 28
visibility
application 18
channels 42
layer sets 98
layers 25
visited links 78
W
warp 154
Wave filter
applying 29
type 173
web snap 76
white balance 41, 173
Windows
color settings 18
compatibility in Batch commands 37
file types 18
X
xml 157
xmp metadata 157
Z
Zigzag filter 30
187