Pakket | coldfusion.service.mxml |
Klasse | public class Pdf |
Overerving | Pdf BasicService InternalConfig Object |
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Eigenschap | Gedefinieerd door | ||
---|---|---|---|
action : String
Action string for the service. | BasicService | ||
addQuads : Boolean = false
Add the position or quadrants of the thumbnail
| |||
cfContextRoot : String
Context root of the ColdFusion server. | InternalConfig | ||
cfPort : int
Port where the ColdFusion server is running. | InternalConfig | ||
cfServer : String
Name or IP address of the ColdFusion server. | InternalConfig | ||
constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | Object | ||
copyFrom : String
Pathname of the PDF document from which to use the first page as a watermark. | |||
ddxString : String
Pathname of the DDX file, or a string with DDX instructions. | |||
destination : String
Specifies the destination for the remoting call. | InternalConfig | ||
encrypt : String
Encryption type for the PDF output file:
RC4_40
RC4_128
RC4_128M
AES_128
None
| |||
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).
| |||
format : String
File type of thumbnail image output:
jpg
tiff
png
| |||
honourSpaces : Boolean = false
Set this option to "true", for improved readability and spacing. | |||
image : String
Image used as a watermark. | |||
imagePrefix : String
Prefix used for each image thumbnail file generated. | |||
info : Array
Structure variable for relevant information, for example, “ #infoStruct#". | |||
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. | |||
isbase64 : Boolean
Valid only when the image attribute is specified. | |||
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.
| |||
newOwnerPassword : String
Password used to set permissions on a PDF document. | |||
newUserPassword : String
Password used to open PDF document. | |||
opacity : uint = 3
Opacity of the watermark. | |||
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. | |||
pages : String
Page or pages in the source PDF document on which to perform the action. | |||
password : String
Owner or user password of the source PDF document,
if the document is password-protected. | |||
pdfParam : Array
Provides additional information for the cfpdf tag. | |||
permissions : String
Type of permissions on the PDF document:
All
AllowAssembly
AllowCopy
AllowDegradedPrinting
AllowFillIn
AllowModifyAnnotations
AllowModifyContents
AllowPrinting
AllowScreenReaders
AllowSecure
None
| |||
position : String
Position on the page where the watermark is placed. | |||
resolution : String
Image quality used to generate thumbnail images:
high: use high resolution (uses more memory).
low: use low resolution.
| |||
rotation : String
Degree of rotation of the watermark image on the page, for example, “60”. | |||
scale : uint = 25
Size of the thumbnail relative to the source page. | |||
secureHttp : Boolean
Boolean value that specifies if secure HTTP is used:
yes: uses secure HTTP
no: does not use secure HTTP
| InternalConfig | ||
servicePassword : String
Password to access ColdFusion services. | InternalConfig | ||
serviceUserName : String
Username to access ColdFusion services. | InternalConfig | ||
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.
| |||
source : String
PDF document used as the source. | |||
stopOnError : Boolean
Valid only if the directory attribute is specified. | |||
transparent : Boolean
(format="png" only)
Specifies whether the image background is transparent or opaque:
yes: the background is transparent.
no: the background is opaque.
| |||
type : String = "string"
Type attribute indicates the text format in which the text
has to be extracted for the action extractText. | |||
useStructure : Boolean = true
Lets you extract content based on the PDF structure. |
Methode | Gedefinieerd door | ||
---|---|---|---|
Pdf()
Creates an instance of the Pdf class. | |||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | BasicService | ||
Dispatches an event into the event flow. | BasicService | ||
Sends the information to the ColdFusion service based on the action and
attributes that the user sets. | |||
Returns the RemoteObject instance used by the proxy classes to make the
remote object call. | BasicService | ||
Checks whether the EventDispatcher object has any listeners registered
for a specific type of event. | BasicService | ||
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | ||
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | ||
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | ||
Removes a listener from the EventDispatcher object. | BasicService | ||
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | ||
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | ||
Retourneert een tekenreeksrepresentatie van het opgegeven object. | Object | ||
Retourneert de primitieve waarde van het opgegeven object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its
ancestors for the specified event type. | BasicService |
Methode | Gedefinieerd door | ||
---|---|---|---|
[overschrijven]
This is the overriden function of the default implementation is BasicService. |
addQuads | eigenschap |
public var addQuads:Boolean = false
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9.0.1 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Add the position or quadrants of the thumbnail
De standaardwaarde is false
.
copyFrom | eigenschap |
public var copyFrom:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Pathname of the PDF document from which to use the first page as a watermark.
ddxString | eigenschap |
public var ddxString:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Pathname of the DDX file, or a string with DDX instructions.
encrypt | eigenschap |
public var encrypt:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Encryption type for the PDF output file:
RC4_40
RC4_128
RC4_128M
AES_128
None
De standaardwaarde is RC4_128
(Acrobat 5.0 or higher).
foreground | eigenschap |
public var foreground:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
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).
De standaardwaarde is no
.
format | eigenschap |
public var format:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
File type of thumbnail image output:
jpg
tiff
png
De standaardwaarde is jpg
.
honourSpaces | eigenschap |
public var honourSpaces:Boolean = false
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9.0.1 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Set this option to "true", for improved readability and spacing.
De standaardwaarde is false
.
image | eigenschap |
public var image:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
imagePrefix | eigenschap |
public var imagePrefix:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
info | eigenschap |
public var info:Array
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
inputFiles | eigenschap |
public var inputFiles:Array
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
isbase64 | eigenschap |
public var isbase64:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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:
yes
: the image is in Base64 format.no
: the image is not in Base64 format.
De standaardwaarde is no
.
keepBookmark | eigenschap |
public var keepBookmark:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Specifies whether bookmarks from the source PDF documents are retained in the merged document:
yes
: the bookmarks are retained.no
: the bookmarks are removed.
newOwnerPassword | eigenschap |
public var newOwnerPassword:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Password used to set permissions on a PDF document.
newUserPassword | eigenschap |
public var newUserPassword:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Password used to open PDF document.
opacity | eigenschap |
public var opacity:uint = 3
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).
outputFiles | eigenschap |
public var outputFiles:Array
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
pages | eigenschap |
public var pages:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Page or pages in the source PDF document on which to perform the action.
De standaardwaarde is all
.
password | eigenschap |
public var password:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Owner or user password of the source PDF document, if the document is password-protected.
pdfParam | eigenschap |
public var pdfParam:Array
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
permissions | eigenschap |
public var permissions:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Type of permissions on the PDF document:
All
AllowAssembly
AllowCopy
AllowDegradedPrinting
AllowFillIn
AllowModifyAnnotations
AllowModifyContents
AllowPrinting
AllowScreenReaders
AllowSecure
None
De standaardwaarde is all
.
position | eigenschap |
public var position:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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 x and y coordinates; for example “50,30”.
resolution | eigenschap |
public var resolution:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Image quality used to generate thumbnail images:
high
: use high resolution (uses more memory).low
: use low resolution.
De standaardwaarde is high
.
rotation | eigenschap |
public var rotation:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Degree of rotation of the watermark image on the page, for example, “60”.
scale | eigenschap |
public var scale:uint = 25
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.
De standaardwaarde is 25.
showOnPrint | eigenschap |
public var showOnPrint:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
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.
De standaardwaarde is no
.
source | eigenschap |
public var source:String
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
PDF document used as the source. The source can be one of the following:
- An absolute or relative pathname to a PDF document; for example, c:\work\myPDF.pdf or myPDF.pdf.
- A PDF document variable in memory that is generated by the
cfdocument
tag or thecfpdf
tag.
stopOnError | eigenschap |
public var stopOnError:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | 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.
yes
: stops the merge process if invalid PDF files exist in the specified directory.no
: continues the merge process even if invalid files exist in the specified directory.
transparent | eigenschap |
public var transparent:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
(format="png" only) Specifies whether the image background is transparent or opaque:
yes:
the background is transparent.no:
the background is opaque.
De standaardwaarde is no.
type | eigenschap |
public var type:String = "string"
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9.0.1 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Type attribute indicates the text format in which the text has to be extracted for the action extractText. The values can be string or xml.
De standaardwaarde is false
.
useStructure | eigenschap |
public var useStructure:Boolean = true
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9.0.1 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Lets you extract content based on the PDF structure. For better readability of the extracted text, use this attribute together with the attribute honourspaces.
De standaardwaarde is true
.
() | Constructor |
public function Pdf()
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Creates an instance of the Pdf
class.
convertResultInEvent | () | methode |
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 |
ColdFusionServiceResultEvent |
execute | () | methode |
public function execute():void
Taalversie: | ActionScript 3.0 |
Productversie: | ColdFusion 9 |
Runtimeversies: | Flash Player 9, AIR 1.0 |
Sends the information to the ColdFusion service based on the action and attributes that the user sets.
Wed Jun 13 2018, 11:42 AM Z