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