Properties are either simple (represented by a 32 bit integer) or complex (represented by a handle). More...

#define	propNumberOfChannels 'nuch'
	Number of channels in the document; (Simple, read-only).
#define	propChannelName 'nmch'
	Name of the channel; (Complex, read-only).
#define	propUnicodeChannelName 'unch'
	Unicode characters for the name of the channel; (Complex, read-only).
#define	propTargetLayerLock 'tllk'
	Lock bits for the target layer; (Simple, read-only).
#define	propImageMode 'mode'
	Mode of the image, returned using the Image Modes constants; (Simple, read-only).
#define	propNumberOfPaths 'nupa'
	Number of paths in the document; (Simple, read-only).
#define	propPathName 'nmpa'
	Name of the indexed path; (Complex, read-only).
#define	propUnicodePathName 'unmp'
	Unicode name of the indexed path; (Complex, read-only).
#define	propPathContents 'path'
	Returns the contents of the indexed path (zero-based). (Complex):
#define	propPathContentsAI 'paAI'
	Contents of the path as Illustrator data; (Complex, read-only).
#define	propWorkPathIndex 'wkpa'
	Index of the work path; (Simple, read-only).
#define	propClippingPathIndex 'clpa'
	Index of the clipping path; (Simple, read-only).
#define	propTargetPathIndex 'tgpa'
	Index of the target path; (Simple, read-only).
#define	propCaption 'capt'
	File caption information in a IPTC-NAA record; (Complex, modifiable).
#define	propXMP 'xmpd'
	File XMP meta information in a IPTC-NAA record; (Complex, modifiable).
#define	propBigNudgeH 'bndH'
	Horizontal component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
#define	propBigNudgeV 'bndV'
	Vertical component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
#define	propInterpolationMethod 'intp'
	Current interpolation method; (Simple, read-only).
#define	propRulerUnits 'rulr'
	Current ruler units; (Simple, read-only).
#define	propRulerOriginH 'rorH'
	Horizontal component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
#define	propRulerOriginV 'rorV'
	Vertical component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
#define	propGridMajor 'grmj'
	Current major grid rules, in inches, unless `propRulerUnits` is pixels, and then pixels; (Simple, modifiable).
#define	propGridMinor 'grmn'
	The current number of grid subdivisions per major rule; (Simple, modifiable).
#define	propSerialString 'sstr'
	The serial number string shown to the user; (Complex, read-only).
#define	propSerialString2 'sstR'
	The serial number string shown to the user; (Complex, read-only).
#define	propHardwareGammaTable 'hgam'
	Hardware gamma table.
#define	propInterfaceColor 'iclr'
	The interface color scheme; (Complex, read-only).
#define	propWatchSuspension 'wtch'
	The watch suspension level; (Simple, modifiable).
#define	propCopyright 'cpyr'
	Whether the current image is considered under copywrite; (Simple, modifiable).
#define	propCopyright2 'cpyR'
	Whether the current image is considered under copywrite; (Simple, modifiable).
#define	propWatermark 'watr'
	Indicates whether a digital signature or watermark is present; (Simple, modifiable).
#define	propURL 'URL '
	The URL for the current image; (Complex, modifiable).
#define	propTitle 'titl'
	The title of the current document; (Complex, read-only).
#define	propDocumentWidth 'docW'
	The width of the current document in pixels; (Simple, read-only).
#define	propDocumentHeight 'docH'
	The height of the current document in pixels; (Simple, read-only).
#define	propSlices 'slcs'
	The slices for the document; (Complex, modifiable).
#define	propSelectedSliceID 'slid'
	The currently selected slice ID; (Simple, modifiable).
#define	propSelectedSliceIDList 'slis'
	The currently selected slice ID list; (Complex, modifiable).
#define	propSelectedSliceIndex 'slin'
	The currently selected slice index; (Simple, read-only).
#define	propShowSliceNumbers 'slsh'
	Indicate whether the user has set slice numbers to show; (Simple, read-only).
#define	propSliceLineColor 'sllc'
	The color of the slice lines; (Complex, read-only).
#define	propToolTips 'tltp'
	Tool tip display; (Simple, read-only).
#define	propPaintCursorKind 'PCrK'
	Type of paint cursor being used; (Simple, read-only).
#define	propPaintCursorShape 'PCrS'
	Cursor options being used; (Simple, read-only).
#define	propPaintCursorCrosshair 'PCrC'
	Cursor crosshair visibility; (Simple, read-only).
#define	propZoomWithScrollWheel 'zScW'
	Fetch Preference setting: Zoom with Scroll Wheel; (Simple, read-only).
#define	propEXIFData 'EXIF'
	EXIF camera and device data; (Complex, modifiable).
#define	propVersion 'vers'
	Current version of Photoshop.
#define	propPlayInProgress 'plip'
	Action play information, for actions palette or automation plug in; (Simple, read-only).
#define	propRecordInProgress 'rcip'
	Action recording information, for actions palette; (Simple, read-only).
#define	propUnicodeName 'unnm'
	Unicode name of the document; (Complex, read-only).
#define	propUniStr255Name 'u25n'
	Unicode name of the document; (Complex, read-only).
#define	propUnicodeNameWithoutExtension 'neun'
	Unicode name of the document without extension; (Complex, read-only).
#define	propDontShowAgainCount 'DSAC'
	Global "Don't show again" counter for dialog boxes; (Simple, read-only).
#define	propNumberOfLayers 'nuly'
	Number of layers in the document; (Simple, read-only).
#define	propTargetLayerIndex 'tgly'
	Index of the target layer; (Simple, read-only).
#define	propLayerName 'lynm'
	Layer name of the layer with a given index; (Complex, read-only).
#define	propUnicodeLayerName 'lynu'
	Layer name as a unicode string of the layer with a given index; (Complex, read-only).
#define	propPixelScaleFactor 'pxsf'
	Pixel aspect ratio for the document; (Simple, read-only).
#define	propDoingPlace 'DPlc'
	Current operation is part of a place command; (Simple, read-only).
#define	propRasterizingSmartObject 'RsSO'
	Current operation is part of rasertizing a smart object; (Simple, read-only).
#define	propAppIsModal 'aism'
	Use this property to tell if Photoshop is in a modal dialog or a modal tool.
#define	propUseMultiUndo 'umuu'
	This property can be used to query about the current Undo setting of the host.
#define	propPixelLength 'MSpl'
	measurement scale pixel length (Simple)
#define	propLogicalLength 'MSll'
	measurement scale logical length(Simple)
#define	propMUnits 'MSun'
	measurement scale units in unicode string (Complex)
#define	propTileSize 'TSiz'
	tile size in bytes (Simple, read-only)
#define	propDroverIsInitialized 'drov'
	Drover library has initialized correctly (Simple, read-only)
#define	propScratchVolumeList 'svls'
	Photoshop scratch disk volumes (Complex, read-only) A list of 4-byte volume index that users have picked as preferred scratch volumes.
#define	propNumberOfScratchVolumes 'nusv'
	Number of scratch volumes; (Simple, read-only).
#define	propScratchVolumePath 'svlp'
	Photoshop scratch disk volume path at the given index in unicode string (Complex, read-only)
#define	propUXPrimaryColor 'Uxpc'
	The primary updated UX color.
#define	propUXSecondaryColor 'Uxsc'
	The secondary updated UX color.
#define	propUXUseUpdatedUX 'Uxuu'
	Flag for whether or not to use updated UX.
#define	propGuideColor 'Grdc'
	The color of a guide line, RGBColor.
#define	propGuideCount 'GrdL'
	The number of guide lines in the document.
#define	propGuideDirIsHoriz 'GrdH'
	Is the guide with the given index horizontal.
#define	propGuideCoordinate 'GClr'
	The horizontal or vertical coordinate (as a double) of the guide by index.
#define	propGPUFlags 'GPUF'
	GPUFlags (Simple, read-only) bits are 00ns,anbp,egc0,00mm n=Native GPU is enabled s=Native GPU support is available a=Advanced mode could be selected by the user -- it is allowed n=Normal mode could be selected by the user -- it is allowed b=Basic mode could be selected by the user -- it is allowed e=GPU is enabled g=use OpenGL for computation c=use OpenCL for computation mm=drawing mode, 0..2.
#define	kGPUFlagsModeMask 0x0003
#define	kGPUFlagsModeShift 0
#define	kGPUFlagsBasic 0
#define	kGPUFlagsNormal 1
#define	kGPUFlagsAdvanced 2
#define	GPUFlagsGetMode(FLAGS) (((FLAGS) & kGPUFlagsModeMask) >> kGPUFlagsModeShift)
#define	GPUFlagsSetMode(MODE) (((MODE) << kGPUFlagsModeShift) & kGPUFlagsModeMask)
#define	kGPUFlagsCLCompute 0x0020
#define	kGPUFlagsGLCompute 0x0040
#define	kGPUFlagsGPUEnabled 0x0080
#define	kGPUFlagsGPUPossible 0x0100
#define	kGPUFlagsBasicPossible 0x0200
#define	kGPUFlagsNormalPossible 0x0400
#define	kGPUFlagsAdvancedPossible 0x0800
#define	kGPUFlagsNativeGPUPossible 0x1000
#define	kGPUFlagsNativeGPUEnabled 0x2000
#define	propVRAM_MB 'VRAM'
	The the available VRAM in units of 1024*1024 bytes.
#define	propLayerBounds 'lbnd'
	Use this property to get current layer bounds.
#define	propLayerIsSmart 'liss'
	Use this property to tell if the current layer is a smart object layer.
#define	propHDPIAware 'HDPI'
	Use this property to tell if the host application is Hi-DPI aware.
#define	propUIBrightness 'UIBR'
	Use this property to tell the current UI brightness.
#define	propHighlightColor 'HLCR'
	Use this property to tell the current highlight color.
#define	propLargeTabs 'LGTB'
	Use this property to tell if the host application has large tabs on.
#define	propScaleUIToFontZoom 'SUFZ'
	Use this property to tell if the host application is scaling UI to font.
#define	propCheckerboardColor1 'cHK1'
	The color of checkerboard 1, RGBColor.
#define	propCheckerboardColor2 'cHK2'
	The color of checkerboard 2, RGBColor.
#define	propCheckerboardSize 'cHKz'
	The size of the checkerboard, 0 = no size, 4 = small, 8 = medium, 16 = large.
#define	propUseCheckerboard 'UcHK'
	Use checkerboard or default white.
#define	propIsCloudDocument 'icld'
	Use this to determine if document is a cloud document.

Detailed Description

Properties are either simple (represented by a 32 bit integer) or complex (represented by a handle).

Some properties can be modified by calling SetPropertyProc, others are read-only, and can only be used with GetPropertyProc.

Define Documentation

#define propNumberOfChannels 'nuch'

Number of channels in the document; (Simple, read-only).

#define propImageMode 'mode'

Mode of the image, returned using the Image Modes constants; (Simple, read-only).

#define propRulerOriginH 'rorH'

Horizontal component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).

#define propChannelName 'nmch'

Name of the channel; (Complex, read-only).

The channels are indexed from 0 and consist of the composite channels, the transparency mask, the layer mask, and the alpha channels.

#define propUnicodeChannelName 'unch'

Unicode characters for the name of the channel; (Complex, read-only).

#define propTargetLayerLock 'tllk'

Lock bits for the target layer; (Simple, read-only).

See target layer lock bits.

#define propNumberOfPaths 'nupa'

Number of paths in the document; (Simple, read-only).

#define propPathName 'nmpa'

Name of the indexed path; (Complex, read-only).

The paths are indexed starting with zero. A complex, read-only property.

#define propUnicodePathName 'unmp'

Unicode name of the indexed path; (Complex, read-only).

#define propPathContents 'path'

Returns the contents of the indexed path (zero-based). (Complex):

Contents of the indexed path in the format described in the path resources documentation; (Complex, read-only). The paths are indexed starting with zero. The data is stored in big endian form. Refer to chapter 10 for more information on path data.

#define propPathContentsAI 'paAI'

Contents of the path as Illustrator data; (Complex, read-only).

The paths are indexed starting with zero.

#define propWorkPathIndex 'wkpa'

Index of the work path; (Simple, read-only).

The value of the property is -1 if no work path.

#define propClippingPathIndex 'clpa'

Index of the clipping path; (Simple, read-only).

The value of the property is -1 if no clipping path.

#define propTargetPathIndex 'tgpa'

Index of the target path; (Simple, read-only).

The value of the property is -1 if no target path.

#define propCaption 'capt'

File caption information in a IPTC-NAA record; (Complex, modifiable).

For more information, see Photoshop File Formats.pdf.

#define propXMP 'xmpd'

File XMP meta information in a IPTC-NAA record; (Complex, modifiable).

#define propBigNudgeH 'bndH'

Horizontal component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).

This is the value used when moving around using the shift key. The default value is ten pixels.

#define propBigNudgeV 'bndV'

Vertical component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).

This is the value used when moving around using the shift key. The default value is ten pixels.

#define propInterpolationMethod 'intp'

Current interpolation method; (Simple, read-only).

1=nearest neighbor, 2=bilinear, 3=bicubic, 4=bicubic smoother, 5=bicubic sharper, 6=bicubic automatic 32 bit documents will be nearest neighbor or bilinear only

#define propRulerUnits 'rulr'

Current ruler units; (Simple, read-only).

For values, see RulerUnits.

#define propRulerOriginV 'rorV'

Vertical component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).

#define propGridMajor 'grmj'

Current major grid rules, in inches, unless propRulerUnits is pixels, and then pixels; (Simple, modifiable).

Represented as 16.16 value.

#define propGridMinor 'grmn'

The current number of grid subdivisions per major rule; (Simple, modifiable).

#define propSerialString 'sstr'

The serial number string shown to the user; (Complex, read-only).

Deprecated:

Use propSerialString2 below

#define propSerialString2 'sstR'

The serial number string shown to the user; (Complex, read-only).

#define propHardwareGammaTable 'hgam'

Hardware gamma table.

Only valid for Windows; (Complex, read-only).

#define propInterfaceColor 'iclr'

The interface color scheme; (Complex, read-only).

Allows a plug-in interface to mimic system colors. The handle returned from getPropertyProc can be cast as a PIInterfaceColor structure.

Note:: Currently, user-selected system colors are supported on Windows; when they are available on MAC OS, they will likely be supported in future versions of Photoshop through this same mechanism.

The color scheme is indexed, see Interface Color Indexes for index values to pass into getPropertyProc. These interface color values map onto Photoshop system colors according to the following diagram:

Constants are remapped to create the system look. Use the indexed color scheme to draw PICTs.

Deprecated:

Use propUIBrightness, propCheckerboardColor1, propCheckerboardColor2, propCheckerboardSize, propUseCheckerboard below.

#define propWatchSuspension 'wtch'

The watch suspension level; (Simple, modifiable).

When non-zero, a plug-in can make callbacks to the host without fear that the watch will start spinning. It is reset to zero at the beginning of each call from the host to the plug-in.

#define propCopyright 'cpyr'

Whether the current image is considered under copywrite; (Simple, modifiable).

This property key can only be used to set the flag.

#define propCopyright2 'cpyR'

Whether the current image is considered under copywrite; (Simple, modifiable).

#define propWatermark 'watr'

Indicates whether a digital signature or watermark is present; (Simple, modifiable).

The (c) copyright symbol will appear if this is set, or if the user has checked the copyrightproperty in the File Info dialog. Do not turn the copyright flag off, ever. Use to indicate if you have found your digital signature.

#define propURL 'URL '

The URL for the current image; (Complex, modifiable).

#define propTitle 'titl'

The title of the current document; (Complex, read-only).

#define propDocumentWidth 'docW'

The width of the current document in pixels; (Simple, read-only).

#define propDocumentHeight 'docH'

The height of the current document in pixels; (Simple, read-only).

#define propSlices 'slcs'

The slices for the document; (Complex, modifiable).

See the Slices resource format documented in Photoshop File Formats.pdf.

#define propSelectedSliceID 'slid'

The currently selected slice ID; (Simple, modifiable).

#define propSelectedSliceIDList 'slis'

The currently selected slice ID list; (Complex, modifiable).

#define propSelectedSliceIndex 'slin'

The currently selected slice index; (Simple, read-only).

#define propShowSliceNumbers 'slsh'

Indicate whether the user has set slice numbers to show; (Simple, read-only).

#define propSliceLineColor 'sllc'

The color of the slice lines; (Complex, read-only).

#define propToolTips 'tltp'

Tool tip display; (Simple, read-only).

The value is 0 if off, 1 if on.

#define propPaintCursorKind 'PCrK'

Type of paint cursor being used; (Simple, read-only).

1 = standard; 2 = precise; 3 = brush size.

#define propPaintCursorShape 'PCrS'

Cursor options being used; (Simple, read-only).

1 = normal; 2 = full sized.

#define propPaintCursorCrosshair 'PCrC'

Cursor crosshair visibility; (Simple, read-only).

0 = not visible; 1 = visible.

#define propZoomWithScrollWheel 'zScW'

Fetch Preference setting: Zoom with Scroll Wheel; (Simple, read-only).

0 = off (use alt key to zoom), 1 = on (mouse scroll wheel does zoom)

#define propEXIFData 'EXIF'

EXIF camera and device data; (Complex, modifiable).

The EXIF property is controlled by The Japan Electronic Industry Development Association (JEIDA) and Electronic Industries Association of Japan (EIAJ) which merged in November of 2000. The EXIF specification can be downloaded from their web site at the following location: http://it.jeita.or.jp/jhistory/document/standard/exif_eng/jeida49eng.htm

#define propVersion 'vers'

Current version of Photoshop.

Major.Minor.Fix

#define propPlayInProgress 'plip'

Action play information, for actions palette or automation plug in; (Simple, read-only).

#define propRecordInProgress 'rcip'

Action recording information, for actions palette; (Simple, read-only).

#define propUnicodeName 'unnm'

Unicode name of the document; (Complex, read-only).

#define propUniStr255Name 'u25n'

Unicode name of the document; (Complex, read-only).

#define propUnicodeNameWithoutExtension 'neun'

Unicode name of the document without extension; (Complex, read-only).

#define propDontShowAgainCount 'DSAC'

Global "Don't show again" counter for dialog boxes; (Simple, read-only).

The property value is incremented every time these dialogs are reset. Each dialog that supports this feature should maintain its own unsigned32 counter in the preferences file. It should be initialized to zero. Before showing the dialog, the local counter should be compared to the global counter. If equal, don't show the dialog. When the user checks the "Don't show again" check box, the local counter should be set to the master counter.

#define propNumberOfLayers 'nuly'

Number of layers in the document; (Simple, read-only).

#define propTargetLayerIndex 'tgly'

Index of the target layer; (Simple, read-only).

#define propLayerName 'lynm'

Layer name of the layer with a given index; (Complex, read-only).

#define propUnicodeLayerName 'lynu'

Layer name as a unicode string of the layer with a given index; (Complex, read-only).

#define propPixelScaleFactor 'pxsf'

Pixel aspect ratio for the document; (Simple, read-only).

#define propDoingPlace 'DPlc'

Current operation is part of a place command; (Simple, read-only).

Provided for file formats that need to record descriptors differently when placing.

#define propRasterizingSmartObject 'RsSO'

Current operation is part of rasertizing a smart object; (Simple, read-only).

Provided for file formats that need to read/obey descriptors differently when rasterizing.

#define propAppIsModal 'aism'

Use this property to tell if Photoshop is in a modal dialog or a modal tool.

(Simple)

#define propUseMultiUndo 'umuu'

This property can be used to query about the current Undo setting of the host.

(Simple, read-only). The returned boolean is true if new (multi) Undo is enabled. If the property returns false, then legacy Undo has been enabled by the user. This setting corresponds to the following UI location: Keyboard Shortcuts and Menus > Use Legacy Undo Shortcuts (Simple)

#define propPixelLength 'MSpl'

measurement scale pixel length (Simple)

#define propLogicalLength 'MSll'

measurement scale logical length(Simple)

#define propMUnits 'MSun'

measurement scale units in unicode string (Complex)

#define propTileSize 'TSiz'

tile size in bytes (Simple, read-only)

#define propDroverIsInitialized 'drov'

Drover library has initialized correctly (Simple, read-only)

#define propScratchVolumeList 'svls'

Photoshop scratch disk volumes (Complex, read-only) A list of 4-byte volume index that users have picked as preferred scratch volumes.

On windows, this index is 1 based, started from "A:", so "C:" drive will be 3, "G:" will be 7, etc.

Deprecated:

Use propScratchVolumePath below

#define propNumberOfScratchVolumes 'nusv'

Number of scratch volumes; (Simple, read-only).

#define propScratchVolumePath 'svlp'

Photoshop scratch disk volume path at the given index in unicode string (Complex, read-only)

#define propUXPrimaryColor 'Uxpc'

The primary updated UX color.

0,0,0 if updated UX is off. (Complex, read-only)

#define propUXSecondaryColor 'Uxsc'

The secondary updated UX color.

0,0,0 if updated UX is off. (Complex, read-only)

#define propUXUseUpdatedUX 'Uxuu'

Flag for whether or not to use updated UX.

(Simple, read-only)

#define propGuideColor 'Grdc'

The color of a guide line, RGBColor.

All guides have the same color. (Complex, read-only)

#define propGuideCount 'GrdL'

The number of guide lines in the document.

(Simple, read-only)

#define propGuideDirIsHoriz 'GrdH'

Is the guide with the given index horizontal.

(Simple, read-only)

#define propGuideCoordinate 'GClr'

The horizontal or vertical coordinate (as a double) of the guide by index.

See property above for determining if guide is horizontal. (Simple, read-only)

#define propGPUFlags 'GPUF'

GPUFlags (Simple, read-only) bits are 00ns,anbp,egc0,00mm n=Native GPU is enabled s=Native GPU support is available a=Advanced mode *could* be selected by the user -- it is allowed n=Normal mode *could* be selected by the user -- it is allowed b=Basic mode *could* be selected by the user -- it is allowed e=GPU is enabled g=use OpenGL for computation c=use OpenCL for computation mm=drawing mode, 0..2.

#define kGPUFlagsModeMask 0x0003

#define kGPUFlagsModeShift 0

#define kGPUFlagsBasic 0

#define kGPUFlagsNormal 1

#define kGPUFlagsAdvanced 2

#define GPUFlagsGetMode ( FLAGS ) (((FLAGS) & kGPUFlagsModeMask) >> kGPUFlagsModeShift)