用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: 正在从服务器检索数据...
正在从服务器检索数据...
coldfusion.service.mxml 

Pdf  - AS3 CF

coldfusion.service.mxml
public class Pdf
继承Pdf Inheritance BasicService Inheritance InternalConfig Inheritance Object

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

The proxy class for pdf services exposed by ColdFusion.



公共属性
 属性由以下参数定义
 Inheritedaction : String
Action string for the service.
BasicService
  addQuads : Boolean = false
Add the position or quadrants of the thumbnail
Pdf
 InheritedcfContextRoot : String
Context root of the ColdFusion server.
InternalConfig
 InheritedcfPort : int
Port where the ColdFusion server is running.
InternalConfig
 InheritedcfServer : String
Name or IP address of the ColdFusion server.
InternalConfig
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  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
 Inheriteddestination : 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
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
  honourSpaces : Boolean = false
Set this option to "true", for improved readability and spacing.
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
 InheritedsecureHttp : Boolean
Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP
InternalConfig
 InheritedservicePassword : String
Password to access ColdFusion services.
InternalConfig
 InheritedserviceUserName : 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.
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
  type : String = "string"
Type attribute indicates the text format in which the text has to be extracted for the action extractText.
Pdf
  useStructure : Boolean = true
Lets you extract content based on the PDF structure.
Pdf
公共方法
 方法由以下参数定义
  
Pdf()
Creates an instance of the Pdf class.
Pdf
 Inherited
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
 Inherited
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.
Pdf
 Inherited
Returns the RemoteObject instance used by the proxy classes to make the remote object call.
BasicService
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BasicService
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BasicService
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BasicService
受保护的方法
 方法由以下参数定义
  
[覆盖] This is the overriden function of the default implementation is BasicService.
Pdf
事件
 事件 摘要 由以下参数定义
 InheritedDispatched when a ColdFusion service call fails.BasicService
 InheritedDispatched when a ColdFusion service call returns successfully.BasicService
属性详细信息

addQuads

属性
public var addQuads:Boolean = false

语言版本: ActionScript 3.0
产品版本: ColdFusion 9.0.1
运行时版本: Flash Player 9, AIR 1.0

Add the position or quadrants of the thumbnail

默认值为 false

copyFrom

属性 
public var copyFrom:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

ddxString

属性 
public var ddxString:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

encrypt

属性 
public var encrypt:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Encryption type for the PDF output file:

  • RC4_40
  • RC4_128
  • RC4_128M
  • AES_128
  • None

默认值为 RC4_128 (Acrobat 5.0 or higher)。

foreground

属性 
public var foreground:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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).

默认值为 no

format

属性 
public var format:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

File type of thumbnail image output:

  • jpg
  • tiff
  • png

默认值为 jpg

honourSpaces

属性 
public var honourSpaces:Boolean = false

语言版本: ActionScript 3.0
产品版本: ColdFusion 9.0.1
运行时版本: Flash Player 9, AIR 1.0

Set this option to "true", for improved readability and spacing.

默认值为 false

image

属性 
public var image:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var imagePrefix:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var info:Array

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var inputFiles:Array

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var isbase64:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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.

默认值为 no

keepBookmark

属性 
public var keepBookmark:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var newOwnerPassword:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Password used to set permissions on a PDF document.

newUserPassword

属性 
public var newUserPassword:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Password used to open PDF document.

opacity

属性 
public var opacity:uint = 3

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

outputFiles

属性 
public var outputFiles:Array

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var pages:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

默认值为 all

password

属性 
public var password:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

pdfParam

属性 
public var pdfParam:Array

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var permissions:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Type of permissions on the PDF document:

  • All
  • AllowAssembly
  • AllowCopy
  • AllowDegradedPrinting
  • AllowFillIn
  • AllowModifyAnnotations
  • AllowModifyContents
  • AllowPrinting
  • AllowScreenReaders
  • AllowSecure
  • None

默认值为 all

position

属性 
public var position:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var resolution:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Image quality used to generate thumbnail images:

  • high: use high resolution (uses more memory).
  • low: use low resolution.

默认值为 high

rotation

属性 
public var rotation:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

scale

属性 
public var scale:uint = 25

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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

默认值为 25。

showOnPrint

属性 
public var showOnPrint:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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.

默认值为 no

source

属性 
public var source:String

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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 the cfpdf tag.

stopOnError

属性 
public var stopOnError:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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

属性 
public var transparent:Boolean

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: 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.

默认值为 no。

type

属性 
public var type:String = "string"

语言版本: ActionScript 3.0
产品版本: ColdFusion 9.0.1
运行时版本: 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.

默认值为 false

useStructure

属性 
public var useStructure:Boolean = true

语言版本: ActionScript 3.0
产品版本: ColdFusion 9.0.1
运行时版本: 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.

默认值为 true

构造函数详细信息

Pdf

()构造函数
public function Pdf()

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

Creates an instance of the Pdf class.

方法详细信息

convertResultInEvent

()方法
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

参数

event:ResultEvent

返回
ColdFusionServiceResultEvent

execute

()方法 
public function execute():void

语言版本: ActionScript 3.0
产品版本: ColdFusion 9
运行时版本: Flash Player 9, AIR 1.0

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





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。