ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
coldfusion.service.mxml 

Document  - AS3 CF
Packagecoldfusion.service.mxml
Classpublic class Document
InheritanceDocument Inheritance BasicService Inheritance InternalConfig Inheritance Object

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

The proxy class for document services exposed by ColdFusion.


Public Properties
 PropertyDefined By
 Inheritedaction : String
Action string for the service.
BasicService
  authPassword : String
Password sent to the target URL for Basic Authentication.
Document
  authUser : String
User name sent to the target URL for Basic Authentication.
Document
  backgroundVisible : Boolean
Specifies whether the background prints when the user prints the document: yes: Includes the background when printing. no: Does not includes the background when printing.
Document
  bookmark : Boolean
Specifies whether bookmarks are created in the document: yes: Creates bookmarks. no: Does not create bookmarks.
Document
 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
A reference to the class object or constructor function for a given object instance.
Object
  content : String
Document
 Inheriteddestination : String
Specifies the destination for the remoting call.
InternalConfig
  documentItem : Array
Specifies action items for a PDF or FlashPaper document created by the cfdocument tag.
Document
  documentSection : Array
Divides a PDF or FlashPaper document into sections.
Document
  encryption : String
Specifies whether the output is encrypted: 128-bit 40-bit none
Document
  fontEmbed : Boolean = true
Specifies whether ColdFusion embeds fonts in the output: yes: Embeds fonts. no: Does not embed fonts. selective: Embeds all fonts except Java fonts and core fonts.
Document
  format : String
Report format: PDF FlashPaper
Document
  marginBottom : String
Bottom margin in inches (default) or centimeters.
Document
  marginLeft : String
Left margin in inches (default) or centimeters.
Document
  marginRight : String
Right margin in inches (default) or centimeters.
Document
  marginTop : String
Top margin in inches (default) or centimeters.
Document
  mimeType : String
MIME type of the source document.
Document
  orientation : String
Page orientation: portrait landscape
Document
  ownerPassword : String
Specifies the owner password; format="PDF" only.
Document
  pageHeight : String
Page height in inches (default) or centimeters.
Document
  pageType : String
Page type into which ColdFusion generates the report: legal: 8.5 inches x 14 inches. letter: 8.5 inches x 11 inches A4: 8.27 inches x 11.69 inches A5: 5.81 inches x 8.25 inches B4: 9.88 inches x 13.88 inches B5: 7 inches x 9.88 inches B4-JIS: 10.13 inches x 14.31 inches B5-JIS: 7.19 inches x 10.13 inches custom: custom height and width.
Document
  pageWidth : String
Page width in inches (default) or centimeters.
Document
  permissions : String
Format="PDF" only; sets one or more of the following permissions: AllowPrinting AllowModifyContents AllowCopy AllowModifyAnnotations AllowFillIn AllowScreenReaders AllowAssembly AllowDegradedPrinting Separate multiple permissions with commas.
Document
  proxyHost : String
Host name or IP address of a proxy server to which to send the request.
Document
  proxyPassword : String
Password required by the proxy server.
Document
  proxyPort : String
The port to connect to on the proxy server.
Document
  proxyUser : String
User name to provide to the proxy server.
Document
  scale : String
Scale factor as a percentage.
Document
 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
  src : String
URL or the relative path to the web root.
Document
  srcFile : String
Absolute path of a file that is on the server.
Document
  unit : String
Default unit for the pageHeight, pageWidth, and margin attributes: in: inches cm: centimeters
Document
  userAgent : String
Text to put in the HTTP User-Agent request header field.
Document
  userPassword : String
Specifies a user password; format="PDF" only.
Document
Public Methods
 MethodDefined By
  
Document()
Creates an instance of the document class.
Document
 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
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
BasicService
  
execute():void
Sends the information to the ColdFusion service based on the action and attributes that the user sets.
Document
 Inherited
getRemoteObject():RemoteObject
Returns the RemoteObject instance used by the proxy classes to make the remote object call.
BasicService
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BasicService
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BasicService
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BasicService
Events
Click for more information on events
 Event Summary Defined By
 Inherited
fault
Dispatched when a ColdFusion service call fails.BasicService
 Inherited
result
Dispatched when a ColdFusion service call returns successfully.BasicService
Property Detail

authPassword

property
public var authPassword:String

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

Password sent to the target URL for Basic Authentication.

authUser

property 
public var authUser:String

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

User name sent to the target URL for Basic Authentication.

backgroundVisible

property 
public var backgroundVisible:Boolean

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

Specifies whether the background prints when the user prints the document:

  • yes: Includes the background when printing.
  • no: Does not includes the background when printing.

The default value is no.

bookmark

property 
public var bookmark:Boolean

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

Specifies whether bookmarks are created in the document:

  • yes: Creates bookmarks.
  • no: Does not create bookmarks.

The default value is no.

content

property 
public var content:String

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

documentItem

property 
public var documentItem:Array

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

Specifies action items for a PDF or FlashPaper document created by the cfdocument tag. Action items include the following:

  • header
  • footer
  • pagebreak

documentSection

property 
public var documentSection:Array

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

Divides a PDF or FlashPaper document into sections. By using the documentSection tag in conjunction with a cfdocumentitem tag, each section can have unique headers, footers, and page numbers.

encryption

property 
public var encryption:String

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

Specifies whether the output is encrypted:

  • 128-bit
  • 40-bit
  • none

The default value is none.

fontEmbed

property 
public var fontEmbed:Boolean = true

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

Specifies whether ColdFusion embeds fonts in the output:

  • yes: Embeds fonts.
  • no: Does not embed fonts.
  • selective: Embeds all fonts except Java fonts and core fonts.

The default value is yes.

format

property 
public var format:String

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

Report format:

  • PDF
  • FlashPaper

marginBottom

property 
public var marginBottom:String

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

Bottom margin in inches (default) or centimeters. To specify the bottom margin in centimeters, include the unit=cm attribute.

marginLeft

property 
public var marginLeft:String

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

Left margin in inches (default) or centimeters. To specify the left margin in centimeters, include the unit=cm attribute.

marginRight

property 
public var marginRight:String

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

Right margin in inches (default) or centimeters. To specify the right margin in centimeters, include the unit=cm attribute.

marginTop

property 
public var marginTop:String

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

Top margin in inches (default) or centimeters. To specify the top margin in centimeters, include the unit=cm attribute.

mimeType

property 
public var mimeType:String

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

MIME type of the source document. Supported MIME types are:

  • text/html
  • text/plain
  • application/xml
  • image/bmp
  • image/jpeg
  • image/png
  • image/gif
If you do not specify this attribute explicitly, ColdFusion uses the filename to determine the MIME type.

The default value is text/html.

orientation

property 
public var orientation:String

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

Page orientation:

  • portrait
  • landscape

The default value is portrait.

ownerPassword

property 
public var ownerPassword:String

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

Specifies the owner password; format="PDF" only.

pageHeight

property 
public var pageHeight:String

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

Page height in inches (default) or centimeters. This attribute is only valid if pagetype=custom. To specify page height in centimeters, include the unit=cm attribute.

pageType

property 
public var pageType:String

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

Page type into which ColdFusion generates the report:

  • legal: 8.5 inches x 14 inches.
  • letter: 8.5 inches x 11 inches
  • A4: 8.27 inches x 11.69 inches
  • A5: 5.81 inches x 8.25 inches
  • B4: 9.88 inches x 13.88 inches
  • B5: 7 inches x 9.88 inches
  • B4-JIS: 10.13 inches x 14.31 inches
  • B5-JIS: 7.19 inches x 10.13 inches
  • custom: custom height and width. If you specify custom, you must also specify the pageHeight and pageWidth attributes. You can optionally specify margin attributes and whether the units are inches or centimeters.

The default value is letter.

pageWidth

property 
public var pageWidth:String

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

Page width in inches (default) or centimeters. This attribute is only valid if pagetype=custom. To specify page width in centimeters, include the unit=cm attribute.

permissions

property 
public var permissions:String

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

Format="PDF" only; sets one or more of the following permissions:

  • AllowPrinting
  • AllowModifyContents
  • AllowCopy
  • AllowModifyAnnotations
  • AllowFillIn
  • AllowScreenReaders
  • AllowAssembly
  • AllowDegradedPrinting
Separate multiple permissions with commas.

proxyHost

property 
public var proxyHost:String

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

Host name or IP address of a proxy server to which to send the request.

proxyPassword

property 
public var proxyPassword:String

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

Password required by the proxy server.

proxyPort

property 
public var proxyPort:String

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

The port to connect to on the proxy server.

The default value is 80.

proxyUser

property 
public var proxyUser:String

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

User name to provide to the proxy server.

scale

property 
public var scale:String

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

Scale factor as a percentage. Use this option to reduce the size of the HTML output so that it fits on that paper. Specify a number less than 100.

The default value is Calculated by ColdFusion.

src

property 
public var src:String

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

URL or the relative path to the web root. You cannot specify both the src and srcfile attributes. The file must be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.

srcFile

property 
public var srcFile:String

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

Absolute path of a file that is on the server. You cannot specify both the src and srcfile attributes. The file must be a PPT file, a Word file, or be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.

unit

property 
public var unit:String

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

Default unit for the pageHeight, pageWidth, and margin attributes:

  • in: inches
  • cm: centimeters

The default value is in.

userAgent

property 
public var userAgent:String

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

Text to put in the HTTP User-Agent request header field. Used to identify the request client software.

The default value is ColdFusion.

userPassword

property 
public var userPassword:String

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

Specifies a user password; format="PDF" only.

Constructor Detail

Document

()Constructor
public function Document()

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

Creates an instance of the document class.

Method Detail

execute

()method
public function execute():void

Language Version: ActionScript 3.0
Product Version: ColdFusion 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.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy