Packagecoldfusion.service.mxml
Classpublic class Pdf
InheritancePdf Inheritance BasicService

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

The proxy class for pdf services exposed by ColdFusion.



Public Properties
 PropertyDefined By
  copyFrom : String
Pathname of the PDF document from which to use the first page as a watermark.
Pdf
  ddxString : String
Pathname of the DDX file, or a string with DDX instructions.
Pdf
  encrypt : String
Encryption type for the PDF output file: RC4_40 RC4_128 RC4_128M AES_128 None
Pdf
  foreground : Boolean
Placement of the watermark on the page: yes: the watermark appears in the foreground (over the page content). no: the watermark appears in the background (behind the page content).
Pdf
  format : String
File type of thumbnail image output: jpg tiff png
Pdf
  image : String
Image used as a watermark.
Pdf
  imagePrefix : String
Prefix used for each image thumbnail file generated.
Pdf
  info : Array
Structure variable for relevant information, for example, “ #infoStruct#".
Pdf
  inputFiles : Array
Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.
Pdf
  isbase64 : Boolean
Valid only when the image attribute is specified.
Pdf
  keepBookmark : Boolean
Specifies whether bookmarks from the source PDF documents are retained in the merged document: yes: the bookmarks are retained. no: the bookmarks are removed.
Pdf
  newOwnerPassword : String
Password used to set permissions on a PDF document.
Pdf
  newUserPassword : String
Password used to open PDF document.
Pdf
  opacity : uint = 3
Opacity of the watermark.
Pdf
  outputFiles : Array
Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.
Pdf
  pages : String
Page or pages in the source PDF document on which to perform the action.
Pdf
  password : String
Owner or user password of the source PDF document, if the document is password-protected.
Pdf
  pdfParam : Array
Provides additional information for the cfpdf tag.
Pdf
  permissions : String
Type of permissions on the PDF document: All AllowAssembly AllowCopy AllowDegradedPrinting AllowFillIn AllowModifyAnnotations AllowModifyContents AllowPrinting AllowScreenReaders AllowSecure None
Pdf
  position : String
Position on the page where the watermark is placed.
Pdf
  resolution : String
Image quality used to generate thumbnail images: high: use high resolution (uses more memory). low: use low resolution.
Pdf
  rotation : String
Degree of rotation of the watermark image on the page, for example, “60�.
Pdf
  scale : uint = 25
Size of the thumbnail relative to the source page.
Pdf
  showOnPrint : Boolean
Specify whether to print the watermark with the PDF document: yes: the watermark is printed with the PDF document. no: the watermark is display-only.
Pdf
  source : String
PDF document used as the source.
Pdf
  stopOnError : Boolean
Valid only if the directory attribute is specified.
Pdf
  transparent : Boolean
(format="png" only) Specifies whether the image background is transparent or opaque: yes: the background is transparent. no: the background is opaque.
Pdf
Public Methods
 MethodDefined By
  
Pdf()
Creates an instance of the Pdf class.
Pdf
  
Sends the information to the ColdFusion service based on the action and attributes that the user sets.
Pdf
Protected Methods
 MethodDefined By
  
[override] This is the overriden function of the default implementation is BasicService.
Pdf
Property Detail
copyFromproperty
public var copyFrom:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Pathname of the PDF document from which to use the first page as a watermark.

ddxStringproperty 
public var ddxString:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Pathname of the DDX file, or a string with DDX instructions.

encryptproperty 
public var encrypt:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Encryption type for the PDF output file:

The default value is RC4_128 (Acrobat 5.0 or higher).

foregroundproperty 
public var foreground:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Placement of the watermark on the page:

The default value is no.

formatproperty 
public var format:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

File type of thumbnail image output:

The default value is jpg.

imageproperty 
public var image:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Image used as a watermark. You can specify a pathname, a variable that contains an image file, or a ColdFusion image variable.

imagePrefixproperty 
public var imagePrefix:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.

infoproperty 
public var info:Array

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Structure variable for relevant information, for example, “ #infoStruct#". You can specify the Author, Subject, Title, and Keywords for the PDF output file.

inputFilesproperty 
public var inputFiles:Array

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.

isbase64property 
public var isbase64:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format:

The default value is no.

keepBookmarkproperty 
public var keepBookmark:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Specifies whether bookmarks from the source PDF documents are retained in the merged document:

newOwnerPasswordproperty 
public var newOwnerPassword:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Password used to set permissions on a PDF document.

newUserPasswordproperty 
public var newUserPassword:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Password used to open PDF document.

opacityproperty 
public var opacity:uint = 3

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).

outputFilesproperty 
public var outputFiles:Array

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.

pagesproperty 
public var pages:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Page or pages in the source PDF document on which to perform the action.

The default value is all.

passwordproperty 
public var password:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Owner or user password of the source PDF document, if the document is password-protected.

pdfParamproperty 
public var pdfParam:Array

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Provides additional information for the cfpdf tag. The cfpdfparam tag applies only to the merge action of the cfpdf tag and is always a child tag of the cfpdf tag.

permissionsproperty 
public var permissions:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Type of permissions on the PDF document:

The default value is all.

positionproperty 
public var position:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Position on the page where the watermark is placed. The position represents the top-left corner of the watermark. Specify the xand y coordinates; for example “50,30�.

resolutionproperty 
public var resolution:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Image quality used to generate thumbnail images:

The default value is high.

rotationproperty 
public var rotation:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Degree of rotation of the watermark image on the page, for example, “60�.

scaleproperty 
public var scale:uint = 25

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.

The default value is 25.

showOnPrintproperty 
public var showOnPrint:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Specify whether to print the watermark with the PDF document:

The default value is no.

sourceproperty 
public var source:String

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

PDF document used as the source. The source can be one of the following:

stopOnErrorproperty 
public var stopOnError:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Valid only if the directory attribute is specified. If the specified directory contains files other then ColdFusion-readable PDF files, ColdFusion either stops merge process or continues.

transparentproperty 
public var transparent:Boolean

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

(format="png" only) Specifies whether the image background is transparent or opaque:

The default value is no.

Constructor Detail
Pdf()Constructor
public function Pdf()

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates an instance of the Pdf class.

Method Detail
convertResultInEvent()method
override protected function convertResultInEvent(event:ResultEvent):ColdFusionServiceResultEvent

This is the overriden function of the default implementation is BasicService. This function checks if the result returned is an array of specific object instances. If it is, it converts it into an array of objects and creates an instance of ColdFusionResultEvent and returns the event

Parameters

event:ResultEvent

Returns
ColdFusionServiceResultEvent
execute()method 
public function execute():void

Language Version: ActionScript 3.0
Product Version: CF 9
Runtime Versions: Flash Player 9, AIR 1.0

Sends the information to the ColdFusion service based on the action and attributes that the user sets.