套件 | com.adobe.icc.services.render |
介面 | public interface ILetterRenderService extends IEventDispatcher |
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
方法 | 定義自 | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。 | IEventDispatcher | ||
會將事件傳送到事件流程。 | IEventDispatcher | ||
getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken
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 | ||
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | IEventDispatcher | ||
會從 EventDispatcher 物件移除偵聽程式。 | IEventDispatcher | ||
renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. | ILetterRenderService | ||
renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
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 | ||
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | IEventDispatcher |
getRenderedFileUrl | () | 方法 |
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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.
參數
response:com.adobe.icc.vo.render:PDFResponseType — The response returned from a call to render a letter (via renderLetter() , for example).
|
com.adobe.icc.token:IAsyncToken — A string containing the URL to the rendered file.
|
擲回值
Error — Invalid render response.
| |
Error — Render response indicates a failure to render the letter.
|
相關 API 元素
renderInteractiveLetter | () | 方法 |
public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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.
參數
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.
|
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.
|
擲回值
Error — Letter ID is invalid.
|
相關 API 元素
renderInteractiveLetterFromObject | () | 方法 |
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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.
參數
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.
|
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.
|
擲回值
Error — Letter ID is invalid.
|
相關 API 元素
renderLetter | () | 方法 |
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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).
參數
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.
|
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.
|
擲回值
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.
|
相關 API 元素
renderLetterFromObject | () | 方法 |
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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).
參數
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.
|
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.
|
擲回值
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.
|
相關 API 元素
renderLetterObjectToFile | () | 方法 |
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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).
參數
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.
|
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.
|
擲回值
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.
|
相關 API 元素
renderLetterToFile | () | 方法 |
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
語言版本: | ActionScript 3.0 |
產品版本: | Asset Composer Building Block 9.5 |
執行階段版本: | 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).
參數
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.
|
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.
|
擲回值
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.
|
相關 API 元素
Tue Jun 12 2018, 03:47 PM Z