Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
coldfusion.service.mxml 

Document  - AS3 CF

Пакетcoldfusion.service.mxml
Классpublic class Document
НаследованиеDocument Inheritance BasicService Inheritance InternalConfig Inheritance Object

Язык версии: ActionScript 3.0
Версия продукта: ColdFusion 9
Версии среды выполнения: Flash Player 9, AIR 1.0

The proxy class for document services exposed by ColdFusion.



Общедоступные свойства
 СвойствоОпределено
 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
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
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
Общедоступные методы
 МетодОпределено
  
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
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
 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
События
 Событие Сводка Определено
 InheritedDispatched when a ColdFusion service call fails.BasicService
 InheritedDispatched when a ColdFusion service call returns successfully.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

свойство 
public var content:String

Язык версии: ActionScript 3.0
Версия продукта: ColdFusion 9
Версии среды выполнения: Flash Player 9, AIR 1.0

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:

  • header
  • footer
  • pagebreak

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-bit
  • 40-bit
  • none

Значением по умолчанию является 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:

  • PDF
  • FlashPaper

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/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.

Значением по умолчанию является text/html.

orientation

свойство 
public var orientation:String

Язык версии: ActionScript 3.0
Версия продукта: ColdFusion 9
Версии среды выполнения: Flash Player 9, AIR 1.0

Page orientation:

  • portrait
  • landscape

Значением по умолчанию является 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 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.

Значением по умолчанию является 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:

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

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: inches
  • cm: 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.





[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.