Packagecom.adobe.photoshop
Classpublic class DocumentPrintSettings
InheritanceDocumentPrintSettings Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Print settings for a document.



Public Properties
 PropertyDefined By
  activePrinter : String
Currently selected printer.
DocumentPrintSettings
  backgroundColor : SolidColor
Background color of page.
DocumentPrintSettings
  bleedWidth : String
Bleed width.
DocumentPrintSettings
  caption : Boolean
Description field from File Info.
DocumentPrintSettings
  centerCropMarks : Boolean
Print center crop marks.
DocumentPrintSettings
  colorBars : Boolean
Print color calibration bars.
DocumentPrintSettings
  colorHandling : PrintColorHandling
Color handling.
DocumentPrintSettings
  copies : Number
Number of copies.
DocumentPrintSettings
  cornerCropMarks : Boolean
Print corner crop marks.
DocumentPrintSettings
  docPosition : DocPositionStyle
[read-only] Position of image when printing.
DocumentPrintSettings
  flip : Boolean
Flip the image horizontally.
DocumentPrintSettings
  hardProof : Boolean
Print a hard proof.
DocumentPrintSettings
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  interpolate : Boolean
DocumentPrintSettings
  labels : Boolean
Prints the document title.
DocumentPrintSettings
  mapBlack : Boolean
Map blacks.
DocumentPrintSettings
  negative : Boolean
Invert the image colors.
DocumentPrintSettings
 Inheritedparent : *
[read-only]
PhotoshopHostObject
  posX : String
[read-only] X position of image on page.
DocumentPrintSettings
  posY : String
[read-only] Y position of image on page.
DocumentPrintSettings
  printBorder : String
Width of the print border.
DocumentPrintSettings
  printerName : String
name of printer
DocumentPrintSettings
  printers : Array
[read-only] List of available printers.
DocumentPrintSettings
  printSpace : String
Color space for printer.
DocumentPrintSettings
  registrationMarks : Boolean
Print registration marks.
DocumentPrintSettings
  renderIntent : Intent
Color conversion intent when print space is different from the source space.
DocumentPrintSettings
  scale : Number
[read-only] Scale of image on page.
DocumentPrintSettings
  vectorData : Boolean
Include vector data.
DocumentPrintSettings
Public Methods
 MethodDefined By
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
setPagePosition(docPosition:DocPositionStyle, posX:String = null, posY:String = null, scale:Number = 100):void
Set the position of the image on the page.
DocumentPrintSettings
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
activePrinterproperty
activePrinter:String

Currently selected printer.


Implementation
    public function get activePrinter():String
    public function set activePrinter(value:String):void
backgroundColorproperty 
backgroundColor:SolidColor

Background color of page.


Implementation
    public function get backgroundColor():SolidColor
    public function set backgroundColor(value:SolidColor):void
bleedWidthproperty 
bleedWidth:String

Bleed width.


Implementation
    public function get bleedWidth():String
    public function set bleedWidth(value:String):void
captionproperty 
caption:Boolean

Description field from File Info.


Implementation
    public function get caption():Boolean
    public function set caption(value:Boolean):void
centerCropMarksproperty 
centerCropMarks:Boolean

Print center crop marks.


Implementation
    public function get centerCropMarks():Boolean
    public function set centerCropMarks(value:Boolean):void
colorBarsproperty 
colorBars:Boolean

Print color calibration bars.


Implementation
    public function get colorBars():Boolean
    public function set colorBars(value:Boolean):void
colorHandlingproperty 
colorHandling:PrintColorHandling

Color handling.


Implementation
    public function get colorHandling():PrintColorHandling
    public function set colorHandling(value:PrintColorHandling):void
copiesproperty 
copies:Number

Number of copies.


Implementation
    public function get copies():Number
    public function set copies(value:Number):void
cornerCropMarksproperty 
cornerCropMarks:Boolean

Print corner crop marks.


Implementation
    public function get cornerCropMarks():Boolean
    public function set cornerCropMarks(value:Boolean):void
docPositionproperty 
docPosition:DocPositionStyle  [read-only]

Position of image when printing.


Implementation
    public function get docPosition():DocPositionStyle
flipproperty 
flip:Boolean

Flip the image horizontally.


Implementation
    public function get flip():Boolean
    public function set flip(value:Boolean):void
hardProofproperty 
hardProof:Boolean

Print a hard proof.


Implementation
    public function get hardProof():Boolean
    public function set hardProof(value:Boolean):void
interpolateproperty 
interpolate:Boolean


Implementation
    public function get interpolate():Boolean
    public function set interpolate(value:Boolean):void
labelsproperty 
labels:Boolean

Prints the document title.


Implementation
    public function get labels():Boolean
    public function set labels(value:Boolean):void
mapBlackproperty 
mapBlack:Boolean

Map blacks.


Implementation
    public function get mapBlack():Boolean
    public function set mapBlack(value:Boolean):void
negativeproperty 
negative:Boolean

Invert the image colors.


Implementation
    public function get negative():Boolean
    public function set negative(value:Boolean):void
posXproperty 
posX:String  [read-only]

X position of image on page.


Implementation
    public function get posX():String
posYproperty 
posY:String  [read-only]

Y position of image on page.


Implementation
    public function get posY():String
printBorderproperty 
printBorder:String

Width of the print border.


Implementation
    public function get printBorder():String
    public function set printBorder(value:String):void
printerNameproperty 
printerName:String

name of printer


Implementation
    public function get printerName():String
    public function set printerName(value:String):void
printersproperty 
printers:Array  [read-only]

List of available printers.


Implementation
    public function get printers():Array
printSpaceproperty 
printSpace:String

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).


Implementation
    public function get printSpace():String
    public function set printSpace(value:String):void
registrationMarksproperty 
registrationMarks:Boolean

Print registration marks.


Implementation
    public function get registrationMarks():Boolean
    public function set registrationMarks(value:Boolean):void
renderIntentproperty 
renderIntent:Intent

Color conversion intent when print space is different from the source space.


Implementation
    public function get renderIntent():Intent
    public function set renderIntent(value:Intent):void
scaleproperty 
scale:Number  [read-only]

Scale of image on page.


Implementation
    public function get scale():Number
vectorDataproperty 
vectorData:Boolean

Include vector data.


Implementation
    public function get vectorData():Boolean
    public function set vectorData(value:Boolean):void
Method Detail
setPagePosition()method
public function setPagePosition(docPosition:DocPositionStyle, posX:String = null, posY:String = null, scale:Number = 100):void

Set the position of the image on the page.

Parameters

docPosition:DocPositionStyle — (com.adobe.photoshop.DocPositionStyle) Position of the image on page when printing. Can be centered, scale to fit, or user defined.
 
posX:String (default = null) — (String) X position of image on page.
 
posY:String (default = null) — (String) Y position of image on page.
 
scale:Number (default = 100) — (Number) Position of the image on page when printing. Can be centered, scale to fit, or user defined. ( default: 100.0 )