Photoshop Scripting Reference

h1+p {font-weight:bold; font-size:0.8em; margin-top:1px;} h2 {margin-top:0;} #content {padding-right:8px;} #content ul li {margin-bottom:1em;} #content ul li ul li {margin-bottom:0;} #sidebar h2 {font-size:1em;} #sidebar ul {padding-left:0; margin-left:1.2em;} #sidebar li {font-size:0.8em; white-space:nowrap;} #sidebar .box {padding-left:8px; border-left:dashed 1px black;} li {list-style-type:none;} a {color:#000; text-decoration:none;}

Adobe Photoshop CS.app terminology

/Applications/Adobe Photoshop CS/Adobe Photoshop CS.app

AdobeScriptAutomation

Adobe Photoshop script execution menu

Commands

  • application.Scripts(...) -- Photoshop scripting support plug-in
    • [AEType('#ImR')]
    • javascript_file=Text -- The JavaScript file to execute
    • javascript_text=Text -- The JavaScript text to execute
    • debugging=Boolean -- should the javascript be executed in debug mode?
    • Result: None

Core Suite

Suite that applies to all applications

Commands

  • reference.count(...) -- Return the number of elements of a particular class within an object
    • each=Type -- the class of the elements to be counted.
    • Result: SInt32 -- the number of elements
  • reference.delete() -- Remove an element from an object
    • Result: None
  • reference.duplicate(...) -- Duplicate one or more object(s)
    • [to=InsertionLoc] -- the new location for the object(s)
    • [with_properties=AERecord] -- new values for the properties of the duplicated element
    • Result: ObjectSpecifier -- to the duplicated object(s)
  • reference.exists() -- Verify if an object exists
    • Result: Boolean -- true if it exists, false if not
  • application.make(...) -- Make a new element
    • new=Type -- the class of the new element.
    • at=InsertionLoc -- the location at which to insert the element
    • [with_data=Anything] -- the initial data for the element
    • [with_properties=AERecord] -- the initial values for the properties of the element
    • Result: ObjectSpecifier -- to the new object(s)
  • reference.move(...) -- Move object(s) to a new location
    • to=InsertionLoc -- the new location for the object(s)
    • Result: ObjectSpecifier -- to the object(s) after they have been moved
  • application.close(...) -- close the document
    • k.document -- the document object or objects to be operated upon
    • [saving=k.ask | k.no | k.yes] -- specifies whether changes should be saved before closing ( default: ask )
    • Result: None
  • application.open(...) -- open the specified document file(s)
    • Anything -- the file(s) to be opened
    • [as=k.Acrobat_TouchUp_Image | k.Alias_PIX | k.BMP | k.CompuServe_GIF | k.Electric_Image | k.EPS | k.EPS_PICT_preview | k.EPS_TIFF_Preview | k.Filmstrip | k.JPEG | k.PCX | k.PDF | k.Photo_CD | k.Photoshop_DCS_10x2E0 | k.Photoshop_DCS_20x2E0 | k.Photoshop_EPS | k.Photoshop_format | k.Photoshop_PDF | k.PICT_file | k.PICT_resource | k.Pixar | k.PNG | k.Portable_Bitmap | k.raw | k.Scitex_CT | k.SGI_RGB | k.SoftImage | k.Targa | k.TIFF | k.Wavefront_RLA | k.Wireless_Bitmap] -- open document as the specified type
    • [with_options=k.open_options] -- options for the file type specified
    • [showing_dialogs=k.always | k.error_dialogs | k.never] -- should a dialog be displayed when a file is opened
    • Result: None
  • application.print_(...) -- print the specified object(s)
    • Anything -- the file(s) or document(s) to be printed
    • [postscript_encoding=k.ASCII | k.binary | k.JPEG] -- encoding type ( default: binary )
    • [source_space=k.document_space | k.proof_space] -- color space for source ( default: document space )
    • [print_space=UnicodeText] -- color space for printer. Can be nothing (meaning same as source); 'Working RGB', 'Working CMYK', 'Working Gray', 'Lab Color' (meaning one of the working spaces or Lab color); or a string specifying a specific colorspace (default is same as source)
    • [intent=k.absolute_colorimetric | k.perceptual | k.relative_colorimetric | k.saturation_intent] -- if the print space is different from the source space, this argument will be used as the color conversion intent ( default: relative colorimetric )
    • [blackpoint_compensation=Boolean] -- if the print space is different from the source space, this argument indicates if the color conversion should use black point compensation ( default: true )
    • Result: None
  • application.quit() -- quit the application
    • Result: None
  • application.save(...) -- save the specified document
    • k.document -- the document object or objects to be operated upon
    • [in_=FSS] -- the file to save the document in
    • [as=k.Alias_PIX | k.BMP | k.CompuServe_GIF | k.Electric_Image | k.JPEG | k.PCX | k.Photoshop_DCS_10x2E0 | k.Photoshop_DCS_20x2E0 | k.Photoshop_EPS | k.Photoshop_format | k.Photoshop_PDF | k.PICT_file | k.PICT_resource | k.Pixar | k.PNG | k.Portable_Bitmap | k.raw | k.Scitex_CT | k.SGI_RGB | k.SoftImage | k.Targa | k.TIFF | k.Wavefront_RLA | k.Wireless_Bitmap] -- the file type to save the document as
    • [copying=Boolean] -- save as copy leaving original open. Unsaved files cannot be saved as copy
    • [appending=k.lowercase_extension | k.no_extension | k.uppercase_extension] -- append an extension to the document name
    • [with_options=k.save_options] -- options for the file type specified
    • Result: k.document -- save the specified document

Classes

  • application -- The Adobe Photoshop application
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • properties AERecord -- all of this object's properties returned in a single record
      • background_color k.color_value
      • color_settings Anything -- name of selected color settings' set
      • current_document k.document -- the frontmost document
      • display_dialogs k.always | k.error_dialogs | k.never -- controls whether or not Photoshop displays dialogs
      • foreground_color k.color_value
      • free_memory (r/o) LongFloat -- the amount of unused memory available to Adobe Photoshop
      • frontmost (r/o) Boolean -- is Photoshop the frontmost application?
      • name (r/o) UnicodeText -- the application's name
      • scripting_version (r/o) UnicodeText -- the version of the Scripting interface
      • settings (r/o) k.settings_object -- preference settings
      • version (r/o) UnicodeText -- the version of Adobe Photoshop application
    • Elements:
      • documents -- name | index | range | relative | test
      • fonts -- name | index | range | relative | test
  • document -- A document
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • background_layer (r/o) k.art_layer -- background layer for the document. Only valid for documents that have a background layer
      • bits_per_channel k.eight | k.one | k.sixteen -- number of bits per channel
      • color_profile_kind k.custom | k.none | k.working -- type of color profile management for document
      • color_profile_name UnicodeText -- name of color profile for document. Only valid for documents that have been assigned a color profile
      • component_channels (r/o) list of k.channel -- all color component channels for this document
      • current_channels list of k.channel -- selected channels for document
      • current_history_brush_source k.history_state -- the current history state to use with the history brush for this document
      • current_history_state k.history_state -- the current history state for this document
      • current_layer k.layer -- selected layer for document
      • file_path (r/o) Alias -- full path name of document
      • height (r/o) LongFloat -- height of document (unit value)
      • histogram (r/o) list of SInt32 -- a histogram of values for the composite document (only for RGB, CMYK and 'Indexed colors' documents)
      • info (r/o) k.info_object -- document information
      • initial_fill (r/o) k.transparent | k.use_background_color | k.white -- initial fill of the document. Only valid when used as an option with the 'make new document' command
      • managed (r/o) Boolean -- is the document a workgroup document?
      • mode (r/o) k.bitmap | k.CMYK | k.duotone | k.grayscale | k.indexed_color | k.Lab | k.multichannel | k.RGB -- document mode
      • modified (r/o) Boolean -- has the document been modified since last save?
      • name (r/o) UnicodeText -- the document's name
      • pixel_aspect_ratio LongFloat -- the pixel aspect ration of the document
      • quick_mask_mode Boolean -- is the document in the quick mask mode?
      • resolution (r/o) LongFloat -- the resolution of the document (in pixels per inch)
      • selection (r/o) k.selection_object -- the document's selection
      • width (r/o) LongFloat -- width of document (unit value)
      • XMP_metadata (r/o) k.XMP_metadata
    • Elements:
      • art_layers -- name | index | range | relative | test
      • channels -- name | index | range | relative | test
      • history_states -- name | index | range | relative | test
      • layer_comps -- name | index | range | relative | test
      • layers -- name | index | range | relative | test
      • layer_sets -- name | index | range | relative | test
      • path_items -- name | index | range | relative | test

Photoshop Suite

Scripting commands and classes for Adobe Photoshop

Commands

  • application.apply(...) -- apply the layer comp to the document
    • k.layer_comp -- the layer comp object or objects to be operated upon
    • Result: None
  • application.apply_layer_style(...)
    • k.art_layer -- the art layer object or objects to be operated upon
    • using=UnicodeText -- name of the layer style to apply
    • Result: None
  • application.change_mode(...) -- change the mode of the document
    • k.document -- the document object or objects to be operated upon
    • to=k.bitmap | k.CMYK | k.grayscale | k.indexed_color | k.Lab | k.multichannel | k.RGB -- name of mode to change to
    • [with_options=k.change_mode_options] -- options for changing the mode
    • Result: None
  • application.contract(...) -- contracts the selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • by=LongFloat -- distance to contract the selection by (unit value)
    • Result: None
  • application.convert(...) -- convert the document from using one color profile to using an other
    • k.document -- the document object or objects to be operated upon
    • to_profile=UnicodeText -- name of color profile to convert to. Either a string specifying a specific color profile or 'Working RGB', 'Working CMYK', 'Working Gray', 'Lab Color' meaning one of the working color spaces or Lab color
    • intent=k.absolute_colorimetric | k.perceptual | k.relative_colorimetric | k.saturation_intent -- conversion intent
    • [blackpoint_compensation=Boolean] -- use black point compensation?
    • [dithering=Boolean] -- use dither? ( default: true )
    • Result: None
  • application.convert_to_shape(...) -- converts the text item and its containing layer to a fill layer with the text changed to a clipping path
    • k.text_object -- the text-object object or objects to be operated upon
    • Result: None
  • application.create_PDF_presentation(...) -- create a PDF presentation file
    • from_files=list of Alias -- list of input files to include in the output
    • to_file=FSS -- location of the output file
    • [with_options=k.presentation_options] -- options for the PDF presentation
    • Result: UnicodeText -- create a PDF presentation file
  • application.create_photo_gallery(...) -- create a web photo gallery
    • from_folder=Alias -- folder of files to process
    • to_folder=Alias -- location for output files
    • [with_options=k.gallery_options] -- options for the web photo gallery
    • Result: UnicodeText -- create a web photo gallery
  • application.create_work_path(...) -- creates a work path based on the text object
    • k.text_object -- the text-object object or objects to be operated upon
    • Result: None
  • application.crop(...) -- crop the document
    • k.document -- the document object or objects to be operated upon
    • bounds=AEList -- area to crop (unit value)
    • [angle=LongFloat] -- angle of cropping bounds ( default: 0.0 )
    • [width=LongFloat] -- width of resulting document (unit value)
    • [height=LongFloat] -- height of resulting document (unit value)
    • Result: None
  • application.deselect(...)
    • k.document -- the document object or objects to be operated upon
    • Result: None
  • application.expand(...) -- expand selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • by=LongFloat -- distance to expand the selection by (unit value)
    • Result: None
  • application.export(...)
    • k.document -- the document object or objects to be operated upon
    • in_=FSS -- the file to export to
    • [as=k.Illustrator_paths] -- the type of export ( default: Illustrator paths )
    • [with_options=k.Illustrator_paths_export_options] -- options for the export type specified
    • Result: None
  • application.feather(...) -- feather edges of selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • by=LongFloat -- amount to feather the edge by (unit value)
    • Result: None
  • application.fill(...) -- fills the selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • with_contents=Anything -- a color or a history state
    • [blend_mode=k.behind_mode | k.clear_mode | k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light] -- ( default: normal )
    • [opacity=SInt32] -- ( default: 100 )
    • [preserving_transparency=Boolean]
    • Result: None
  • application.flatten(...) -- flatten all layers in the document
    • k.document -- the document object or objects to be operated upon
    • Result: None
  • application.flip_canvas(...) -- flip the canvas horizontally or vertically
    • k.document -- the document object or objects to be operated upon
    • direction=k.horizontal | k.vertical -- which way to flip the canvas
    • Result: None
  • application.grow(...) -- grow selection to include all adjacent pixels falling within the specified tolerance range
    • k.selection_object -- the selection-object object or objects to be operated upon
    • tolerance=SInt32 -- ( 0 - 255 )
    • antialiasing=Boolean
    • Result: None
  • application.import_annotations(...) -- import annotations into the document
    • k.document -- the document object or objects to be operated upon
    • from_=Alias -- document to import annotations from
    • Result: None
  • application.invert(...) -- invert the selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • Result: None
  • application.link(...) -- link the layer with another layer
    • k.layer -- the layer object or objects to be operated upon
    • with=k.layer -- layer to link to
    • Result: None
  • application.load(...) -- load the selection from a channel
    • k.selection_object -- the selection-object object or objects to be operated upon
    • from_=k.channel -- the channel to load the selection from
    • [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to combine the channel contents with the existing selection ( default: replaced )
    • [inverting=Boolean] -- select the inverse of the channel contents? ( default: false )
    • Result: None
  • application.make_work_path(...) -- make this selection item the work path for this document
    • k.selection_object -- the selection-object object or objects to be operated upon
    • [tolerance=LongFloat] -- tolerance in pixels
    • Result: None
  • application.merge(...) -- merge an art layer, layer set or a spot channel. Merging a layer returns a reference to the resulting layer. Merging a channel does not return any value
    • k.channel -- the channel object or objects to be operated upon
    • Result: None
  • application.merge_visible_layers(...) -- flatten all visible layers in the document
    • k.document -- the document object or objects to be operated upon
    • Result: None
  • application.purge(...) -- purges one or more caches
    • k.all_caches | k.clipboard_cache | k.history_caches | k.undo_caches -- what to purge
    • Result: None
  • application.rasterize(...)
    • k.art_layer -- the art layer object or objects to be operated upon
    • affecting=k.all_linked_layers | k.entire_layer | k.fill_content | k.layer_clipping_path | k.shape | k.text_contents -- what to rasterize
    • Result: None
  • application.recapture(...) -- recapture the current layer state(s) for this layer comp
    • k.layer_comp -- the layer comp object or objects to be operated upon
    • Result: None
  • application.reset_from_comp(...) -- reset the layer comp state to the document state
    • k.layer_comp -- the layer comp object or objects to be operated upon
    • Result: None
  • application.resize_canvas(...) -- change the size of the canvas
    • k.document -- the document object or objects to be operated upon
    • [width=LongFloat] -- desired width of canvas (unit value)
    • [height=LongFloat] -- desired height of canvas (unit value)
    • [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- anchor to resize around ( default: middle center )
    • Result: None
  • application.resize_image(...) -- change the size of the image
    • k.document -- the document object or objects to be operated upon
    • [width=LongFloat] -- desired width of image (unit value)
    • [height=LongFloat] -- desired height of image (unit value)
    • [resolution=LongFloat] -- (in pixels per inch)
    • [resample_method=k.bicubic | k.bicubic_sharper | k.bicubic_smoother | k.bilinear | k.closest_neighbor | k.none] -- what method should be used for resampling pixels ( default: bicubic )
    • Result: None
  • application.reveal_all(...) -- expand document to show clipped sections
    • k.document -- the document object or objects to be operated upon
    • Result: None
  • application.rotate(...)
    • k.layer -- the layer object or objects to be operated upon
    • angle=LongFloat
    • [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center )
    • Result: None
  • application.rotate_boundary(...) -- rotates the boundary of selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • angle=LongFloat
    • [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center )
    • Result: None
  • application.rotate_canvas(...) -- rotate canvas of document
    • k.document -- the document object or objects to be operated upon
    • angle=LongFloat -- number of degrees to rotate. A positive angle will rotate the canvas clockwise; a negative value will rotate the canvas counter-clockwise
    • Result: None
  • application.scale(...)
    • k.layer -- the layer object or objects to be operated upon
    • [horizontal_scale=LongFloat] -- percentage ( default: 100.0 )
    • [vertical_scale=LongFloat] -- percentage ( default: 100.0 )
    • [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to rotate about ( default: middle center )
    • Result: None
  • application.scale_boundary(...) -- scale the boundary of selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • [horizontal_scale=LongFloat] -- percentage ( default: 100.0 )
    • [vertical_scale=LongFloat] -- percentage ( default: 100.0 )
    • [anchor_position=k.bottom_center | k.bottom_left | k.bottom_right | k.middle_center | k.middle_left | k.middle_right | k.top_center | k.top_left | k.top_right] -- point to scale about ( default: middle center )
    • Result: None
  • application.select(...) -- change the selection
    • k.document -- the document object or objects to be operated upon
    • region=list of Anything -- list of corners of the selection (in pixels)
    • [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to combine the new selection with the existing selection ( default: replaced )
    • [feather_amount=LongFloat] -- feather amount ( default: 0.0 )
    • [antialiasing=Boolean] -- whether to use antialiasing ( default: true )
    • Result: None
  • application.select_all(...) -- select the entire image
    • k.document -- the document object or objects to be operated upon
    • Result: None
  • application.select_border(...) -- select the border of the selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • width=LongFloat -- width of border selection (unit value)
    • Result: None
  • application.similar(...) -- grow selection to include pixels throughout the image falling within the tolerance range
    • k.selection_object -- the selection-object object or objects to be operated upon
    • tolerance=SInt32
    • antialiasing=Boolean
    • Result: None
  • application.smooth(...)
    • k.selection_object -- the selection-object object or objects to be operated upon
    • radius=SInt32 -- sample radius in pixels ( 0 - 100 )
    • Result: None
  • application.split_channels(...) -- split channels of the document
    • k.document -- the document object or objects to be operated upon
    • Result: list of k.document -- split channels of the document
  • application.store(...) -- save the selection as a channel
    • k.selection_object -- the selection-object object or objects to be operated upon
    • into=k.channel -- the channel to save the selection to
    • [combination_type=k.diminished | k.extended | k.intersected | k.replaced] -- how to add the selection to the existing contents of the channel ( default: replaced )
    • Result: None
  • application.stroke(...) -- strokes the selection
    • k.selection_object -- the selection-object object or objects to be operated upon
    • using_color=Anything -- color to stroke selection with
    • width=SInt32 -- width of stroke (in pixels)
    • [location=k.center | k.inside | k.outside] -- ( default: center )
    • [blend_mode=k.behind_mode | k.clear_mode | k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light] -- ( default: normal )
    • [opacity=SInt32] -- ( default: 100 )
    • [preserving_transparency=Boolean]
    • Result: None
  • application.translate(...) -- moves the position relative to its current position
    • k.layer -- the layer object or objects to be operated upon
    • [delta_x=LongFloat] -- horizontal transformation (unit value)
    • [delta_y=LongFloat] -- vertical transformation (unit value)
    • Result: None
  • application.translate_boundary(...) -- moves the boundary of selection relative to its current position
    • k.selection_object -- the selection-object object or objects to be operated upon
    • [delta_x=LongFloat] -- horizontal transformation (unit value)
    • [delta_y=LongFloat] -- vertical transformation (unit value)
    • Result: None
  • application.trap(...) -- apply trap to a CMYK document
    • k.document -- the document object or objects to be operated upon
    • width=SInt32 -- trap width in pixels
    • Result: None
  • application.trim(...)
    • k.document -- the document object or objects to be operated upon
    • [basing_trim_on=k.bottom_right_pixel | k.top_left_pixel | k.transparent_pixels] -- color or type of pixels to base trim on ( default: top left pixel )
    • [top_trim=Boolean] -- trim away top of document ( default: true )
    • [left_trim=Boolean] -- trim away left of document ( default: true )
    • [bottom_trim=Boolean] -- trim away bottom of document ( default: true )
    • [right_trim=Boolean] -- trim away right of document ( default: true )
    • Result: None
  • application.unlink(...) -- unlink the layer
    • k.layer -- the layer object or objects to be operated upon
    • Result: None

Classes

  • art_layer -- any layer that can contain data
    • Parent:
    • Properties:
      • properties AERecord -- all of this object's properties returned in a single record
      • background_layer Boolean -- is the layer a background layer?
      • fill_opacity LongFloat -- the interior opacity of the layer (between 0.0 and 100.0)
      • grouped Boolean -- is the layer grouped with the layer below?. Photoshop CS changed the menu name to Create/Release Clipping Mask
      • kind k.brightness_contrast_layer | k.channel_mixer_layer | k.color_balance_layer | k.curves_layer | k.gradient_fill_layer | k.gradient_map_layer | k.hue_saturation_layer | k.inversion_layer | k.levels_layer | k.normal | k.pattern_fill_layer | k.posterize_layer | k.selective_color_layer | k.solid_fill_layer | k.text_layer | k.threshold_layer -- to create a text layer set this property to 'text layer' on an empty art layer of type 'normal'
      • pixels_locked Boolean
      • position_locked Boolean
      • text_object (r/o) k.text_object -- the text item that is associated with the art layer. Only valid for art layers whose 'has text' is true
      • transparent_pixels_locked Boolean
  • Bitmap_mode_options -- Settings related to changing the document mode to Bitmap
    • Parent:
    • Properties:
      • angle LongFloat -- only valid for 'halftone screen' conversions
      • conversion_method k.custom_pattern | k.diffusion_dither | k.halftone_screen_conversion | k.middle_threshold | k.pattern_dither -- ( default: diffusion dither )
      • frequency LongFloat -- only valid for 'halftone screen' conversions
      • pattern_name UnicodeText -- only valid for 'custom pattern' conversions
      • resolution LongFloat -- output resolution (in pixels per inch)
      • screen_shape k.halftone_cross | k.halftone_diamond | k.halftone_ellipse | k.halftone_line | k.halftone_round | k.halftone_square -- only valid for 'halftone screen' conversions
  • change_mode_options -- used with options on the 'change mode' command
  • channel -- A channel in a document. Can be either a component channel representing a color of the document color model or an alpha channel
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • channel_color k.color_value -- color of the channel (not valid for component channels)
      • container (r/o) ObjectSpecifier -- the object's container
      • histogram (r/o) list of SInt32 -- a histogram of values for the channel
      • kind k.component_channel | k.masked_area_channel | k.selected_area_channel | k.spot_color_channel -- type of the channel
      • name UnicodeText -- the channel's name
      • opacity LongFloat -- opacity of alpha channels (called solidity for spot channels)
      • visible Boolean
  • font -- An installed font
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • family (r/o) UnicodeText -- the font's family
      • name (r/o) UnicodeText -- The font's text face name
      • PostScript_name (r/o) UnicodeText -- the font's PostScript name
      • style (r/o) UnicodeText -- the font's style name
  • gallery_banner_options -- options for the web photo gallery banner options
    • Properties:
      • contact_info UnicodeText -- web photo gallery contact info ( default: )
      • date UnicodeText -- web photo gallery date ( default: )
      • font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- the font setting for the banner text ( default: Arial )
      • font_size SInt32 -- the size of the font for the banner text ( 1 - 7; default: 3 )
      • photographer UnicodeText -- web photo gallery photographer ( default: )
      • site_name UnicodeText -- web photo gallery site name ( default: Adobe Web Photo Gallery )
  • gallery_color_options -- options for the web photo gallery colors
  • gallery_images_options -- options for the web photo gallery images
    • Properties:
      • border SInt32 -- the amount of border pixels you want between your images ( 0 - 99; default: 0 )
      • caption Boolean -- generate a caption for the images ( default: false )
      • dimension SInt32 -- resized image dimensions in pixels ( default: 350 )
      • font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- font for the gallery images text ( default: Arial )
      • font_size SInt32 -- font size for the gallery images text ( 1 - 7; default: 3 )
      • image_quality SInt32 -- the quality setting for the JPEG image ( 0 - 12; default: 5 )
      • include_copyright Boolean -- include the copyright in the text for the gallery images ( default: false )
      • include_credits Boolean -- include the credits in the text for the gallery images ( default: false )
      • include_file_name Boolean -- include the file name in the text for the gallery images ( default: true )
      • include_title Boolean -- include the title in the text for the gallery images ( default: false )
      • numeric_links Boolean -- add numeric links ( default: true )
      • resize_constraint k.constrain_both | k.constrain_height | k.constrain_width -- how should the image be constrained ( default: constrain both )
      • resize_images Boolean -- resize images data ( default: true )
  • gallery_options -- options for the web photo gallery command
    • Properties:
      • banner_options k.gallery_banner_options -- options related to banner settings
      • custom_color_options k.gallery_color_options -- options related to custom color settings
      • email_address UnicodeText -- the email address to show on the web page ( default: )
      • images_options k.gallery_images_options -- options related to images settings
      • layout_style UnicodeText -- the style to use for laying out the web page ( default: Centered Frame 1 - Basic )
      • preserve_all_metadata Boolean -- save all of the metadata in the JPEG files ( default: false )
      • security_options k.gallery_security_options -- options related to security settings
      • short_extension Boolean -- short web page extension .htm or long web page extension .html ( default: true )
      • size_attributes Boolean -- add width and height attributes for images ( default: true )
      • sub_folders Boolean -- include all files found in sub folders of the input folder ( default: true )
      • thumbnail_options k.gallery_thumbnail_options -- options related to thumbnail settings
      • UTF8_encoding Boolean -- web page should use UTF-8 encoding ( default: false )
  • gallery_security_options -- options for the web photo gallery security
    • Properties:
      • content k.gallery_caption | k.gallery_copyright | k.gallery_credit | k.gallery_custom_text | k.gallery_filename | k.gallery_none | k.gallery_title -- web photo gallery security content ( default: gallery none )
      • custom_text UnicodeText -- web photo gallery security custom text ( default: )
      • font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- web photo gallery security font ( default: Arial )
      • font_size SInt32 -- web photo gallery security font size ( minimum 1; default: 36 )
      • opacity SInt32 -- web page security opacity as a percent ( default: 100 )
      • text_color k.RGB_color -- web page security text color
      • text_position k.gallery_centered | k.gallery_lower_left | k.gallery_lower_right | k.gallery_upper_left | k.gallery_upper_right -- web photo gallery security text position ( default: gallery centered )
      • text_rotate k.clock_wise_45 | k.clock_wise_90 | k.counter_clock_wise_45 | k.counter_clock_wise_90 | k.zero -- web photo gallery security text rotate ( default: zero )
  • gallery_thumbnail_options -- options for the web photo gallery thumbnail creation
    • Properties:
      • border SInt32 -- the amount of border pixels you want around your thumbnail images ( 0 - 99; default: 0 )
      • caption Boolean -- with caption ( default: false )
      • column_count SInt32 -- web photo gallery thumbnail columns ( default: 5 )
      • dimension SInt32 -- web photo gallery thumbnail dimension in pixels ( default: 75 )
      • font k.Arial | k.Courier_New | k.Helvetica | k.Times_New_Roman -- web photo gallery font ( default: Arial )
      • font_size SInt32 -- the size of the font for the thumbnail images text ( 1 - 7; default: 3 )
      • include_copyright Boolean -- include copyright for thumbnail ( default: false )
      • include_credits Boolean -- include credits for thumbnail ( default: false )
      • include_file_name Boolean -- include file name for thumbnail ( default: false )
      • include_title Boolean -- include title for thumbnail ( default: false )
      • row_count SInt32 -- web photo gallery thumbnail rows ( default: 3 )
      • size k.gallery_custom | k.gallery_large | k.gallery_medium | k.gallery_small -- the size of the thumbnail images ( default: gallery medium )
  • history_state -- A history state for the document
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • container (r/o) ObjectSpecifier -- the object's container
      • name (r/o) UnicodeText -- the history state's name
      • snapshot (r/o) Boolean -- is the history state a snapshot?
  • Illustrator_paths_export_options -- Settings related to exporting Illustrator paths
    • Properties:
      • path_name UnicodeText -- name of path to export. Only valid if you are exporting a named path
      • target_path k.all_paths | k.document_bounds | k.named_path -- which path to export ( default: document bounds )
  • indexed_mode_options -- Settings related to changing the document mode to Indexed
    • Parent:
    • Properties:
      • colors_in_palette SInt32 -- number of colors in palette (only settable for some palette types)
      • dither k.diffusion | k.noise | k.none | k.pattern -- type of dither
      • dither_amount SInt32 -- amount of dither. Only valid for diffusion ( 1 - 100 )
      • forced_colors k.black_and_white | k.none | k.primaries | k.web
      • matte k.background_color_matte | k.black_matte | k.foreground_color_matte | k.Netscape_gray | k.none | k.semi_gray | k.white_matte
      • palette k.exact | k.local_adaptive | k.local_perceptual | k.local_selective | k.Mac_OS_system | k.master_adaptive | k.master_perceptual | k.master_selective | k.previous_ | k.uniform | k.web | k.Windows_system -- Type of palette ( default: exact )
      • preserve_exact_colors Boolean
      • transparency Boolean
  • info_object -- Document information
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • properties AERecord -- all of this object's properties returned in a single record
      • author UnicodeText
      • author_position UnicodeText
      • caption UnicodeText
      • caption_writer UnicodeText
      • category UnicodeText
      • city UnicodeText
      • container (r/o) ObjectSpecifier -- the object's container
      • copyright_notice UnicodeText
      • copyrighted k.copyrighted_work | k.public_domain | k.unmarked
      • country UnicodeText
      • creation_date UnicodeText
      • credit UnicodeText
      • EXIF (r/o) list of Anything
      • headline UnicodeText
      • instructions UnicodeText
      • job_name UnicodeText
      • keywords list of UnicodeText -- list of keywords
      • owner_url UnicodeText
      • province_or_state UnicodeText
      • source UnicodeText
      • supplemental_categories list of UnicodeText
      • title UnicodeText
      • transmission_reference UnicodeText
      • urgency k.four | k.high | k.low | k.none | k.normal | k.seven | k.six | k.three | k.two
  • layer -- A layer object
    • Children:
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • all_locked Boolean
      • blend_mode k.color_blend | k.color_burn | k.color_dodge | k.darken | k.difference | k.dissolve | k.exclusion | k.hard_light | k.hue_blend | k.lighten | k.linear_burn | k.linear_dodge | k.linear_light | k.luminosity | k.multiply | k.normal | k.overlay | k.pass_through | k.pin_light | k.saturation_blend | k.screen | k.soft_light | k.vivid_light
      • bounds (r/o) AEList -- Bounding rectangle of the Layer
      • container (r/o) ObjectSpecifier -- the object's container
      • linked_layers (r/o) list of k.layer
      • name UnicodeText -- the name of the layer
      • opacity LongFloat -- master opacity of layer ( 0.0 - 100.0 )
      • visible Boolean
  • layer_comp -- A layer composition in a document
    • Properties:
      • best_type (r/o) Type -- the best type for the object's value
      • class_ (r/o) Type -- the object's class
      • default_type (r/o) Type -- the default type for the object's value
      • index (r/o) SInt32 -- the index of this instance of the object
      • properties AERecord -- all of this object's properties returned in a single record
      • appearance Boolean -- use layer appearance
      • comment Anything -- the description of the layer comp
      • container (r/o) ObjectSpecifier -- the object's container
      • name UnicodeText -- the name of the layer comp
      • position Boolean -- use layer position
      • selected (r/o) Boolean -- the layer comp is currently selected
      • visibility Boolean -- use layer visibility
  • layer_set -- Layer set
    • Parent:
    • Properties:
      • properties AERecord -- all of this object's properties returned in a single record
      • enabled_channels list of k.channel -- channels that are enabled for the layer set. Must be a list of component channels
    • Elements:
      • art_layers -- name | index | range | relative | test
      • layers -- name | index | range | relative | test
      • layer_sets -- name | index | range | relative | test
  • presentation_options -- options for the PDF presentation command
    • Properties:
      • auto_advance Boolean -- auto advance when viewing ( default: true )
      • downgrade_color_profile Boolean -- should the embedded color profile be downgraded to version 2 ( default: false )
      • embed_fonts Boolean -- embed fonts? Only valid if a text layer is included ( default: false )
      • encoding k.JPEG | k.ZIP -- ( default: ZIP )
      • image_interpolation Boolean -- use image interpolation? ( default: false )
      • interval SInt32 -- time in seconds before auto advancing the view ( default: 5 )
      • JPEG_quality SInt32 -- quality of produced image. Only valid for JPEG encoded PDF documents ( 0 - 12; default: 10 )
      • loop Boolean