com.adobe.icc.services.formbridge

# IFormBridgeService - AS3 Asset Composer

Package | com.adobe.icc.services.formbridge
Interface | public interface IFormBridgeService extends IEventDispatcher

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Defines the FormBridge External API for use with ICC and a LiveCycle ES2-generated PDF running in the HTML wrapper. The PDF must be using FormBridge version 2.0 or greater.

If you use this API, you must include the /utilities/src/main/resources/formbridge.js JavaScript file in your HTML wrapper.

Public Properties

| Property | Defined By
--- | --- | ---
|  | available : Boolean [read-only] Determines if the FormBridge External API is available. | IFormBridgeService
|  | connected : Boolean [read-only] Bindable/Read-only. | IFormBridgeService

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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. | IEventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | getIccFormBridgeExtApiPrefix():String Determines the prefix to use for all ICC FormBridge Extension API methods when calling the PDF. | IFormBridgeService
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | pdfEmailAction():com.adobe.icc.token:IAsyncToken Executes the default email action in the PDF. | IFormBridgeService
|  | pdfExecAction(fieldSom:String):com.adobe.icc.token:IAsyncToken Executes the action (click event) of the specified field (button). | IFormBridgeService
|  | pdfGetData():com.adobe.icc.token:IAsyncToken Retrieves the PDF's data (contents of /xfa/datasets/data). | IFormBridgeService
|  | pdfGetDataInfo(somExps:Array):com.adobe.icc.token:IAsyncToken Retrieves information about the XFA Form Objects referenced via an array of SOM Expressions. | IFormBridgeService
|  | pdfGetFieldNames():com.adobe.icc.token:IAsyncToken Retrieves SOM expressions for all fields in the PDF. | IFormBridgeService
|  | pdfGetFieldValue(somExp:String):com.adobe.icc.token:IAsyncToken Retrieves the value of the specified XFA element (field or exclGroup). | IFormBridgeService
|  | pdfGetFocus():com.adobe.icc.token:IAsyncToken Retrieves the SOM expression of the XFA element that has focus. | IFormBridgeService
|  | pdfGetFormBridgeVersion():com.adobe.icc.token:IAsyncToken Determines the version of FormBridge being used by the PDF. | IFormBridgeService
|  | pdfGetFormType():com.adobe.icc.token:IAsyncToken Determines the type of the form. | IFormBridgeService
|  | pdfGetIndirectSubmitButtons():com.adobe.icc.token:IAsyncToken Retrieves SOM expressions for all indirect submit buttons in the PDF. | IFormBridgeService
|  | pdfGetLabels(fields:Array):com.adobe.icc.token:IAsyncToken Retrieves the labels for the specified fields. | IFormBridgeService
|  | pdfGetListItems(listName:String):com.adobe.icc.token:IAsyncToken Retrieves a list of item values for the specified field. | IFormBridgeService
|  | pdfGetListSelection(listName:String):com.adobe.icc.token:IAsyncToken Retrieves the value of the selected item in a list. | IFormBridgeService
|  | pdfGetObjectProperties(somExp:String, properties:Array):com.adobe.icc.token:IAsyncToken Retrieves a list of property values associated with the specified XFA element. | IFormBridgeService
|  | pdfGetSubmitButtons():com.adobe.icc.token:IAsyncToken Retrieves SOM expressions for all direct submit buttons in the PDF. | IFormBridgeService
|  | pdfGetSubmitType():com.adobe.icc.token:IAsyncToken Retrieves the format in which the PDF will be submitted. | IFormBridgeService
|  | pdfHasSubmitButton():com.adobe.icc.token:IAsyncToken Determines if there is at least one submit button in the PDF. | IFormBridgeService
|  | pdfHideFields(fields:Array):com.adobe.icc.token:IAsyncToken Makes the specified fields invisible (not actually hidden in the XFA sense of the word) in the PDF. | IFormBridgeService
|  | pdfPrintAction():com.adobe.icc.token:IAsyncToken Executes the default print action in the PDF. | IFormBridgeService
|  | pdfSaveAsAction(defaultFileName:String = null):com.adobe.icc.token:IAsyncToken Executes the default save-as action in the PDF. | IFormBridgeService
|  | pdfSetContentTargetHighlight(params:Array):com.adobe.icc.token:IAsyncToken Sets the focus and highlighting on a given target subform. | IFormBridgeService
|  | pdfSetData(data:Object):com.adobe.icc.token:IAsyncToken Sets the PDF's data (contents of /xfa/datasets/data). | IFormBridgeService
|  | pdfSetDataBuffer(data:Object):com.adobe.icc.token:IAsyncToken Sets the PDF's data (contents of /xfa/datasets/data) using a special buffer in the PDF to accumulate large amounts of data prior to finally setting the accumulated data in the PDF. | IFormBridgeService
|  | pdfSetDataFieldsList(subforms:Array, instances:Array, fields:Array, values:Array):com.adobe.icc.token:IAsyncToken Set subform instances and field values in the PDF. | IFormBridgeService
|  | pdfSetFieldHighlight(params:Array):com.adobe.icc.token:IAsyncToken Sets the focus and highlighting on a given Field. | IFormBridgeService
|  | pdfSetFieldValue(somExp:String, value:String):com.adobe.icc.token:IAsyncToken Sets the value for the specified XFA element (field or exclGroup). | IFormBridgeService
|  | pdfSetFocus(somExp:String):com.adobe.icc.token:IAsyncToken Sets focus to the specified XFA element, or removes focus completely. | IFormBridgeService
|  | pdfSetListSelection(listName:String, selection:Object):com.adobe.icc.token:IAsyncToken Sets the selection of a list. | IFormBridgeService
|  | pdfSetObjectProperties(somExp:String, properties:Object):com.adobe.icc.token:IAsyncToken Sets the specified values on the specified properties of the specified XFA element. | IFormBridgeService
|  | pdfShowFields(fields:Array):com.adobe.icc.token:IAsyncToken Makes the specified fields visible in the PDF. | IFormBridgeService
|  | pdfSubmitAction(url:String, type:String = null):com.adobe.icc.token:IAsyncToken Submits the PDF. | IFormBridgeService
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | showDebugOutput(show:Boolean = true):void Enables/disables FormBridge-specific debug output to the Flash Log (if running in a Flash Debug Player). | IFormBridgeService
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher

Property Detail

### available

property

`available:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Determines if the FormBridge External API is available. If the app is loaded in a container (e.g. browser) that doesn't support Flash Player's external interface, this property would be false.

Implementation
`public function get available():Boolean`

Related API Elements

For environments in which the external API would be available.

### connected

property

`connected:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Bindable/Read-only. Determines if the PDF is connected via FormBridge to the HTML wrapper and we can communicate with it via the FormBridge External API.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get connected():Boolean`
Method Detail

### getIccFormBridgeExtApiPrefix

()
method

`public function getIccFormBridgeExtApiPrefix():String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Determines the prefix to use for all ICC FormBridge Extension API methods when calling the PDF.

The PDF is expected to contain a script object named 'iccLib' at the root subform level and iccLib is expected to define a function with the name `{apiExtensionMessage}_FormBridge`. When calling the API, the full API message therefore becomes, for example, `xfa.form.{rootSubformName}.iccLib.MyFbExtension` which FormBridge will attempt to eval as `xfa.form.{rootSubformName}.iccLib.MyFbExtension_FormBridge(...)` in the PDF, for an extension function named `MyFbExtension`

.

Note that the prefix cannot contain any illegal JavaScript characters such as '#' and FormBridge itself will filter-out any extension method name requests that have '{', '}', '(', ')', or a space character in them. Therefore, the requests cannot simply be `xfa.form.#subform[0].iccLib.MyFbExtension` where `#subform[0]` is used in an attempt not to have to know the name of the root subform before making the call. The name of the root subform is automatically retrieved when communication between Flex and the PDF is initialized, prior to the `connected` property becoming "true".

Returns

| `String` — The prefix to apply to the name of the FormBridge Extension method when calling the extended API from Flex or null if the PDF's root subform name has not yet been determined.

Throws

| `Error` — Invalid root subform name; cannot call ICC FormBridge Extension API methods.

### pdfEmailAction

()
method

`public function pdfEmailAction():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Executes the default email action in the PDF.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfExecAction

()
method

`public function pdfExecAction(fieldSom:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Executes the action (click event) of the specified field (button).

Parameters

| `fieldSom:String` — SOM expression (String) of a field (button) whose click event is to be executed. The SOM expression is evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfGetData

()
method

`public function pdfGetData():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the PDF's data (contents of `/xfa/datasets/data`).

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: String containing the data. Fault: FormBridgeError.

### pdfGetDataInfo

()
method

`public function pdfGetDataInfo(somExps:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves information about the XFA Form Objects referenced via an array of SOM Expressions.

Parameters

| `somExps:Array` — Array of SOM expressions for XFA Form Objects whose data information is to be retrieved. SOM expressions are evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: `Map` where keys are the requested Form Object SOM expressions and values are objects with the following dynamic properties:

- dataSom (`String`): The related Data SOM for the Form Object, or null if the Form Object is not bound to data.
- value (`String`): The related current value for the Form Object, or null if the Form Object does not have a value. Note that if the API call is made prior to setting the PDF's data, this value will indicate the Form Object's default value.

Fault: FormBridgeError.

### pdfGetFieldNames

()
method

`public function pdfGetFieldNames():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves SOM expressions for all fields in the PDF.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array of SOM expressions (Strings) for all fields in the PDF. Fault: FormBridgeError.

### pdfGetFieldValue

()
method

`public function pdfGetFieldValue(somExp:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the value of the specified XFA element (field or exclGroup).

Parameters

| `somExp:String` — SOM expression of the XFA element whose value is to be retrieved. The SOM expression is evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: String representing the element's raw value. Fault: FormBridgeError.

### pdfGetFocus

()
method

`public function pdfGetFocus():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the SOM expression of the XFA element that has focus. This command assumes that an element has focus and will fail otherwise.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: SOM expression (String) of the XFA element that has input focus or 'unsupported' if the version of Acrobat/Reader which is hosting the PDF doesn't support getting the element with focus. Fault: FormBridgeError.

### pdfGetFormBridgeVersion

()
method

`public function pdfGetFormBridgeVersion():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Determines the version of FormBridge being used by the PDF.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: String identifying the FormBridge version. Fault: FormBridgeError.

### pdfGetFormType

()
method

`public function pdfGetFormType():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Determines the type of the form.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: String with the value 'acroform', 'xmlform', or 'noninteractive'. Fault: FormBridgeError.

### pdfGetIndirectSubmitButtons

()
method

`public function pdfGetIndirectSubmitButtons():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves SOM expressions for all indirect submit buttons in the PDF. Each button has `/field/event@activity="/script` which contains code that appears to submit the PDF (i.e. the button has some event that has code that looks like it submits the PDF).

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array of SOM expressions (Strings) representing the PDF's indirect submit buttons. Fault: FormBridgeError.

### pdfGetLabels

()
method

`public function pdfGetLabels(fields:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the labels for the specified fields.

Parameters

| `fields:Array` — Array of field SOM expressions.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array of labels (Strings) (i.e. field captions) in the order specified in the original fields array. Fault: FormBridgeError.

### pdfGetListItems

()
method

`public function pdfGetListItems(listName:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves a list of item values for the specified field.

Parameters

| `listName:String` — Name of the list (listbox or drop down list) field whose items are sought.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array, in document order, of item values (Strings) for the specified list. The strings returned represent the /text item values found in the first /items node found within the field's definition in the Form DOM. Normally, this should represent the labels if the list has text and value items (/items@save="1") but there is no guarantee. The field used is the first-found field with the specified name in depth-first document order.

Fault: FormBridgeError.

### pdfGetListSelection

()
method

`public function pdfGetListSelection(listName:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the value of the selected item in a list.

Parameters

| `listName:String` — Name of the list (listbox or drop down list) field whose selected item(s) are sought.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array of selected item values. If the list is single-selection, there will always be either 0 or 1 element in the array. Fault: FormBridgeError.

### pdfGetObjectProperties

()
method

`public function pdfGetObjectProperties(somExp:String, properties:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves a list of property values associated with the specified XFA element.

Parameters

| `somExp:String` — SOM expression of the XFA element whose properties are sought. The SOM expression is evaluated from `xfa.form`.
| `properties:Array` — Array of Strings containing names of attributes whose values are to be retrieved on the XFA element specified by `somExp`. This array may also contain Strings from the OBJECTPROPconstants to retrieve special property values.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: An object map of Strings with the following structure: "{property}={value}" where {property} is the name of the requested property and {value} is the value that was retrieved for that property from the XFA element. The first element will always be "som={somExp}" containing the requested SOM expression. If the SOM expression was invalid, the array will only contain the "som={somExp}" element. For `OBJECTPROP_LOCKED`, `somExp` is expected to represent a field or subform and the string "locked" will be returned as the value if the field is locked whereas "open" will be returned as the value if the field can be edited.

Fault: FormBridgeError.

### pdfGetSubmitButtons

()
method

`public function pdfGetSubmitButtons():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves SOM expressions for all direct submit buttons in the PDF. Each button has `/field/event@activity="click"/submit`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Array of SOM expressions (Strings) representing the PDF's direct submit buttons. Fault: FormBridgeError.

### pdfGetSubmitType

()
method

`public function pdfGetSubmitType():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Retrieves the format in which the PDF will be submitted.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: A string representing one of the SUBMITTYPEconstant values. If the type could not be determined, `SUBMITTYPE_UNKNOWN` is returned. Fault: FormBridgeError.

### pdfHasSubmitButton

()
method

`public function pdfHasSubmitButton():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Determines if there is at least one submit button in the PDF.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Boolean 'true' if there is at least one submit button in the PDF; Boolean 'false' otherwise. Fault: FormBridgeError.

### pdfHideFields

()
method

`public function pdfHideFields(fields:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Makes the specified fields invisible (not actually hidden in the XFA sense of the word) in the PDF.

Parameters

| `fields:Array` — Array of SOM expressions (Strings) for fields to hide. SOM expressions are evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfPrintAction

()
method

`public function pdfPrintAction():com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Executes the default print action in the PDF.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSaveAsAction

()
method

`public function pdfSaveAsAction(defaultFileName:String = null):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Executes the default save-as action in the PDF.

Parameters

| `defaultFileName:String` (default = `null`)`` — Default file name, including extension, to suggest in the save-as dialog that appears, if the PDF is rights-enabled to allow local save or is running in Acrobat.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetContentTargetHighlight

()
method

`public function pdfSetContentTargetHighlight(params:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the focus and highlighting on a given target subform.

Parameters

| `params:Array` — The array of parameters to be passed for highlighting. 'params' is supposed to be in order: targetSOM = params[0]; index = params[1]; isImage = params[2]; highlight = params[3]; targetHighlightType = params[4]; targetColor = params[5]; contentHighlightType = params[6]; contentColor = params[7];

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetData

()
method

`public function pdfSetData(data:Object):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the PDF's data (contents of `/xfa/datasets/data`).

The data is expected to be the entire data starting at the root data element, inclusively, to be merged into `xfa.datasets.data`.

Warning: There is a limit to the length of the data that can be sent over FormBridge. If you are sending large amounts of data (typical when embedded images are involved), you should consider using the `pdfSetDataBuffer()` ICC FormBridge Extension method instead, or use the `pdfSetFieldValue()` method to set each field's value individually (though this may still not avert the issue for a very large embedded image, for example).

Parameters

| `data:Object` — Either a String representing XML or an XML object. If XML, it will be convered to an XML string so be careful about whitespace considerations. If whitespace is important, you are best to provide a properly-convered String instead.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

Related API Elements

pdfSetDataBuffer()
pdfSetFieldValue()

### pdfSetDataBuffer

()
method

`public function pdfSetDataBuffer(data:Object):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the PDF's data (contents of `/xfa/datasets/data`) using a special buffer in the PDF to accumulate large amounts of data prior to finally setting the accumulated data in the PDF. This is essential to avert the string length limit of approx. 28,000 UTF-8 characters when sending data over FormBridge and is critical when the data includes embedded images since these can translate into large amounts of base64-encoded data.

The data is expected to be the entire data starting at the root data element, inclusively, to be merged into `xfa.datasets.data`.

Parameters

| `data:Object` — Either a String representing XML or an XML object. If XML, it will be convered to an XML string so be careful about whitespace considerations. If whitespace is important, you are best to provide a properly-convered String instead.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetDataFieldsList

()
method

`public function pdfSetDataFieldsList(subforms:Array, instances:Array, fields:Array, values:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Set subform instances and field values in the PDF.

Parameters

| `subforms:Array` — SOM expressions (Strings) for subforms whose instances are to be set (consuming any data from the data DOM as per their bindings). SOM expressions are evaluated from `xfa.form`.
| `instances:Array` — For each subform specified in the `subforms` parameter, specifies the number (int) of instances that should be created. Take care not to go beyond the subform's allowed occurrences.
| `fields:Array` — SOM expressions (Strings) for fields whose values are to be set. SOM expressions are evaluated from `xfa.form`.
| `values:Array` — For each field specified in the `fields` parameter, specifies the value to set.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetFieldHighlight

()
method

`public function pdfSetFieldHighlight(params:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the focus and highlighting on a given Field.

Parameters

| `params:Array` — The array of parameters to be passed for highlighting. 'params' is supposed to be in order: fieldSOM = params[0]; highlight = params[1]; fieldHighlightType = params[2]; fieldColor = params[3];

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetFieldValue

()
method

`public function pdfSetFieldValue(somExp:String, value:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the value for the specified XFA element (field or exclGroup).

Warning: There is a limit to the length of the data that can be sent over FormBridge. If you are sending large amounts of data (typical when embedded images are involved), you should consider using the `pdfSetDataBuffer()` ICC FormBridge Extension method instead.

Parameters

| `somExp:String` — SOM expression for the XFA element whose value is to be set. The SOM expression is evaluated from `xfa.form`.
| `value:String` — New value for the element. If the field is a "rich text field", this value can be the new rich text where both `/exData/body/...` and, simply, `/body/...` formats are supported. Note, however, that only a field that was configured to hold "rich text" at design-time in the Template DOM can actually hold "rich text" at runtime in the Form DOM.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

Related API Elements

pdfSetDataBuffer()

### pdfSetFocus

()
method

`public function pdfSetFocus(somExp:String):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets focus to the specified XFA element, or removes focus completely.

Parameters

| `somExp:String` — SOM expression for the XFA element which should get focus or null to remove focus. The SOM expression is evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetListSelection

()
method

`public function pdfSetListSelection(listName:String, selection:Object):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the selection of a list.

Parameters

| `listName:String` — Name of the list (listbox or drop down list) field whose selection is to be set.
| `selection:Object` — String representing the value of the item to select in the list; Array of item values to set for a multi-selection list (or a single element for a single-selection list); null to remove the selection.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSetObjectProperties

()
method

`public function pdfSetObjectProperties(somExp:String, properties:Object):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the specified values on the specified properties of the specified XFA element.

Parameters

| `somExp:String` — SOM expression of the XFA element whose properties are to be set. The SOM expression is evaluated from `xfa.form`.
| `properties:Object` — Object map of Strings with the following structure: "{property}={value}". The property name can be any valid attribute name on the specified XFA element (via `somExp`) as well as any of the OBJECTPROPconstants with the exception of `OBJECTPROP_LOCKED`. The associated value is expected to be valid for the property specified. If setting the `OBJECTPROP_XML` property, the value specified is expected to the XML and will be loaded into the XFA element specified. If setting the `OBJECTPROP_OBJECT` property, the XFA element will be assigned the specified value.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Boolean 'true'. Fault: FormBridgeError.

### pdfShowFields

()
method

`public function pdfShowFields(fields:Array):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Makes the specified fields visible in the PDF.

Parameters

| `fields:Array` — Array of SOM expressions (Strings) for fields to hide. SOM expressions are evaluated from `xfa.form`.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### pdfSubmitAction

()
method

`public function pdfSubmitAction(url:String, type:String = null):com.adobe.icc.token:IAsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Submits the PDF.

Parameters

| `url:String` — Destination for the submission. If the FormBridge has been injected with a submit URL, this parameter is ignored. If this parameter is set to null or empty string and the FormBridge does not have an injected submit URL, the PDF will not be submitted (this command will be a no-op).
| `type:String` (default = `null`)`` — One of the `SUBMITTYPE_XML`, `SUBMITTYPE_XDP`, or `SUBMITTYPE_PDF` constant values. Leave null to submit using the default submit format as prescribed by FormBridge.

Returns

| `com.adobe.icc.token:IAsyncToken` — Result: Unused. Fault: FormBridgeError.

### showDebugOutput

()
method

`public function showDebugOutput(show:Boolean = true):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Enables/disables FormBridge-specific debug output to the Flash Log (if running in a Flash Debug Player).

Parameters

| `show:Boolean` (default = `true`)`` — True to display the debug output; false to disable it.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00