Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
coldfusion.service.mxml 

Document  - AS3 CF

Packagecoldfusion.service.mxml
Classepublic class Document
HéritageDocument Inheritance BasicService Inheritance InternalConfig Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

The proxy class for document services exposed by ColdFusion.



Propriétés publiques
 PropriétéDéfini par
 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
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
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
Méthodes publiques
 MéthodeDéfini par
  
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
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BasicService
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BasicService
Evénements
 Evénement Synthèse Défini par
 InheritedDispatched when a ColdFusion service call fails.BasicService
 InheritedDispatched when a ColdFusion service call returns successfully.BasicService
Détails de la propriété

authPassword

propriété
public var authPassword:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Password sent to the target URL for Basic Authentication.

authUser

propriété 
public var authUser:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

User name sent to the target URL for Basic Authentication.

backgroundVisible

propriété 
public var backgroundVisible:Boolean

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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.

La valeur par défaut est no.

bookmark

propriété 
public var bookmark:Boolean

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Specifies whether bookmarks are created in the document:

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

La valeur par défaut est no.

content

propriété 
public var content:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

documentItem

propriété 
public var documentItem:Array

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var documentSection:Array

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var encryption:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Specifies whether the output is encrypted:

  • 128-bit
  • 40-bit
  • none

La valeur par défaut est none.

fontEmbed

propriété 
public var fontEmbed:Boolean = true

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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.

La valeur par défaut est yes.

format

propriété 
public var format:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Report format:

  • PDF
  • FlashPaper

marginBottom

propriété 
public var marginBottom:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var marginLeft:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var marginRight:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var marginTop:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var mimeType:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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.

La valeur par défaut est text/html.

orientation

propriété 
public var orientation:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Page orientation:

  • portrait
  • landscape

La valeur par défaut est portrait.

ownerPassword

propriété 
public var ownerPassword:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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

pageHeight

propriété 
public var pageHeight:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var pageType:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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.

La valeur par défaut est letter.

pageWidth

propriété 
public var pageWidth:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var permissions:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var proxyHost:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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

proxyPassword

propriété 
public var proxyPassword:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Password required by the proxy server.

proxyPort

propriété 
public var proxyPort:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

The port to connect to on the proxy server.

La valeur par défaut est 80.

proxyUser

propriété 
public var proxyUser:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

User name to provide to the proxy server.

scale

propriété 
public var scale:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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.

La valeur par défaut est Calculated by ColdFusion.

src

propriété 
public var src:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var srcFile:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: 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

propriété 
public var unit:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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

  • in: inches
  • cm: centimeters

La valeur par défaut est in.

userAgent

propriété 
public var userAgent:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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

La valeur par défaut est ColdFusion.

userPassword

propriété 
public var userPassword:String

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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

Détails du constructeur

Document

()Constructeur
public function Document()

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

Creates an instance of the document class.

Détails de la méthode

execute

()méthode
public function execute():void

Version du langage: ActionScript 3.0
Version du produit: ColdFusion 9
Versions du moteur d’exécution: Flash Player 9, AIR 1.0

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





[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.