ILetterRenderService - Adobe ActionScript® 3（AS3 Asset Composer）API リファレンス

パッケージ	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

Defines a service for rendering Letters to PDFs.

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	IEventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	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
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	IEventDispatcher
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 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
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この 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.

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.

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

パラメーター

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

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.

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.

戻り値

例外

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

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.

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.

法律上の注意 | プライバシーポリシー

ILetterRenderService - AS3 Asset Composer

クラス x

getRenderedFileUrl

renderInteractiveLetter

renderInteractiveLetterFromObject

renderLetter

renderLetterFromObject

renderLetterObjectToFile

renderLetterToFile