Guida di riferimento di ActionScript® 3.0 per la piattaforma Adobe® Flash®
Home  |  Nascondi elenco pacchetti e classi |  Pacchetti  |  Classi  |  Novità  |  Indice  |  Appendici  |  Perché in inglese?
Filtri: Recupero dati dal server...
Recupero dati dal server...
com.adobe.icc.services.render 

ILetterRenderService  - AS3 Asset Composer

Pacchettocom.adobe.icc.services.render
Interfacciapublic interface ILetterRenderService extends IEventDispatcher

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Defines a service for rendering Letters to PDFs.



Metodi pubblici
 MetodoDefinito da
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento.
IEventDispatcher
 Inherited
Invia un evento nel flusso di eventi.
IEventDispatcher
  
Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client.
ILetterRenderService
 Inherited
Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Rimuove un listener dall'oggetto EventDispatcher.
IEventDispatcher
  
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer.
ILetterRenderService
  
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer.
ILetterRenderService
  
renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
ILetterRenderService
  
renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
ILetterRenderService
  
renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
ILetterRenderService
  
renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
ILetterRenderService
 Inherited
Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato.
IEventDispatcher
Descrizione dei metodi

getRenderedFileUrl

()metodo
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client.

Parametri

response:com.adobe.icc.vo.render:PDFResponseType — The response returned from a call to render a letter (via renderLetter(), for example).

Restituisce
com.adobe.icc.token:IAsyncToken — A string containing the URL to the rendered file.

Genera
Error — Invalid render response.
 
Error — Render response indicates a failure to render the letter.

Elementi API correlati

renderInteractiveLetter

()metodo 
public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. The PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter.

Parametri

letterId:String — ID (GUID) of the letter to render.
 
initialXmlData:String (default = null) — Initial XML Data (IXD) to use in order to author appropriate target area data bindings based on the IXD's root element name. If not specified, target area data bindings will use the name of the root subform found in the Letter's Layout template.

Restituisce
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

Genera
Error — Letter ID is invalid.

Elementi API correlati

renderInteractiveLetterFromObject

()metodo 
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. The PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter.

Parametri

letter:Letter — Fully populated Letter object with layout and assignments.
 
initialXmlData:String (default = null) — Initial XML Data (IXD) to use in order to author appropriate target area data bindings based on the IXD's root element name. If not specified, target area data bindings will use the name of the root subform found in the Letter's Layout template.

Restituisce
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

Genera
Error — Letter ID is invalid.

Elementi API correlati

renderLetter

()metodo 
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

Parametri

letterId:String — ID (GUID) of the letter to render.
 
mergeData:Boolean (default = false) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.
 
initialXmlData:String (default = null) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Can be null if mergeData is false or useTestData is true.

If specified, this data takes precedence over any existing test data, even if useTestData is true.

 
useTestData:Boolean (default = false) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Ignored if initialXmlData is not null.

 
interactive:Boolean (default = true) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

Restituisce
com.adobe.icc.token:IAsyncToken — If mergeData is false, a PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file. If mergeData is true, the PDFResponseType object only contains information about the rendered file but not the file itself. To always get access the rendered PDF on the server, use the renderLetterToFile() method.

Genera
Error — Letter ID is invalid.
 
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
 
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
 
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

Elementi API correlati

renderLetterFromObject

()metodo 
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

Parametri

letter:Letter — Fully populated Letter object with layout and assignments.
 
mergeData:Boolean (default = false) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.
 
initialXmlData:String (default = null) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Can be null if mergeData is false or useTestData is true.

If specified, this data takes precedence over any existing test data, even if useTestData is true.

 
useTestData:Boolean (default = false) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Ignored if initialXmlData is not null.

 
interactive:Boolean (default = true) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

Restituisce
com.adobe.icc.token:IAsyncToken — If mergeData is false, a PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file. If mergeData is true, the PDFResponseType object only contains information about the rendered file but not the file itself. To always get access the rendered PDF on the server, use the renderLetterObjectToFile() method.

Genera
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
 
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
 
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

Elementi API correlati

renderLetterObjectToFile

()metodo 
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

Parametri

letter:Letter — Fully populated Letter object with layout and assignments.
 
mergeData:Boolean (default = false) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.
 
initialXmlData:String (default = null) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Can be null if mergeData is false or useTestData is true.

If specified, this data takes precedence over any existing test data, even if useTestData is true.

 
useTestData:Boolean (default = false) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Ignored if initialXmlData is not null.

 
interactive:Boolean (default = true) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

Restituisce
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

Genera
Error — Letter ID is invalid.
 
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
 
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
 
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

Elementi API correlati

renderLetterToFile

()metodo 
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Asset Composer 9.5
Versioni runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

Parametri

letterId:String — ID (GUID) of the letter to render.
 
mergeData:Boolean (default = false) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.
 
initialXmlData:String (default = null) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Can be null if mergeData is false or useTestData is true.

If specified, this data takes precedence over any existing test data, even if useTestData is true.

 
useTestData:Boolean (default = false) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed).

Ignored if initialXmlData is not null.

 
interactive:Boolean (default = true) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

Restituisce
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

Genera
Error — Letter ID is invalid.
 
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
 
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
 
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

Elementi API correlati





[ X ]Perché in inglese?
Il contenuto della Guida di riferimento di ActionScript 3.0 appare in inglese

Non tutte le parti della Guida di riferimento di ActionScript 3.0 sono tradotte in tutte le lingue. Quando un elemento del linguaggio non è tradotto, viene riportato in inglese. Ad esempio, la classe ga.controls.HelpBox non è tradotta in nessuna lingua. Pertanto, nella versione italiana della guida di riferimento, la descrizione della classe ga.controls.HelpBox è riportata in inglese.