| 包 | coldfusion.service.mxml |
| 类 | public class Document |
| 继承 | Document  BasicService InternalConfig Object |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | action : 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 | ||
| 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
对类对象或给定对象实例的构造函数的引用。 | Object | |
| content : String | Document | ||
| destination : 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 | ||
| 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 | |
| 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 | ||
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
Document()
Creates an instance of the document class. | Document | ||
| 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. | Document | ||
|
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 | |
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
Removes a listener from the EventDispatcher object. | BasicService | |
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its
ancestors for the specified event type. | BasicService | |
authPassword | 属性 |
public var authPassword:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Password sent to the target URL for Basic Authentication.
authUser | 属性 |
public var authUser:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
User name sent to the target URL for Basic Authentication.
backgroundVisible | 属性 |
public var backgroundVisible:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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.
默认值为 no。
bookmark | 属性 |
public var bookmark:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Specifies whether bookmarks are created in the document:
yes: Creates bookmarks.no: Does not create bookmarks.
默认值为 no。
content | 属性 |
documentItem | 属性 |
public var documentItem:Array| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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:
headerfooterpagebreak
documentSection | 属性 |
public var documentSection:Array| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var encryption:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Specifies whether the output is encrypted:
128-bit40-bitnone
默认值为 none。
fontEmbed | 属性 |
public var fontEmbed:Boolean = true| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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.
默认值为 yes。
format | 属性 |
public var format:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Report format:
PDFFlashPaper
marginBottom | 属性 |
public var marginBottom:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var marginLeft:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var marginRight:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var marginTop:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var mimeType:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
MIME type of the source document. Supported MIME types are:
text/htmltext/plainapplication/xmlimage/bmpimage/jpegimage/pngimage/gif
默认值为 text/html。
orientation | 属性 |
public var orientation:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Page orientation:
portraitlandscape
默认值为 portrait。
ownerPassword | 属性 |
public var ownerPassword:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Specifies the owner password; format="PDF" only.
pageHeight | 属性 |
public var pageHeight:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var pageType:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 inchesA4: 8.27 inches x 11.69 inchesA5: 5.81 inches x 8.25 inchesB4: 9.88 inches x 13.88 inchesB5: 7 inches x 9.88 inchesB4-JIS: 10.13 inches x 14.31 inchesB5-JIS: 7.19 inches x 10.13 inchescustom: 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.
默认值为 letter。
pageWidth | 属性 |
public var pageWidth:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var permissions:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Format="PDF" only; sets one or more of the following permissions:
AllowPrintingAllowModifyContentsAllowCopyAllowModifyAnnotationsAllowFillInAllowScreenReadersAllowAssemblyAllowDegradedPrinting
proxyHost | 属性 |
public var proxyHost:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Host name or IP address of a proxy server to which to send the request.
proxyPassword | 属性 |
public var proxyPassword:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Password required by the proxy server.
proxyPort | 属性 |
public var proxyPort:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
The port to connect to on the proxy server.
默认值为 80。
proxyUser | 属性 |
public var proxyUser:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
User name to provide to the proxy server.
scale | 属性 |
public var scale:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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.
默认值为 Calculated by ColdFusion。
src | 属性 |
public var src:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var srcFile:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | 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 | 属性 |
public var unit:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Default unit for the pageHeight, pageWidth,
and margin attributes:
in: inchescm: centimeters
默认值为 in。
userAgent | 属性 |
public var userAgent:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
默认值为 ColdFusion。
userPassword | 属性 |
public var userPassword:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Specifies a user password; format="PDF" only.
Document | () | 构造函数 |
public function Document()| 语言版本: | ActionScript 3.0 |
| 产品版本: | ColdFusion 9 |
| 运行时版本: | Flash Player 9, AIR 1.0 |
Creates an instance of the document class.
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.
Tue Jun 12 2018, 11:04 AM Z