The data items that FormsResult variables
contain.
action
A short value
that indicates the processing state of the operation when it provided
the result. The state indicates whether interaction between the
Forms service and the client application, such as a web browser,
is complete. These values are valid:
- 0:
- Interaction is complete and validated XML data is ready to
be processed.
- 1:
- The data contains calculation results that must be returned
to the web browser so that the user can view the results.
- 2:
- Calculations and validations must be written to the web browser.
- 3:
- (HTML transformations) The current page has changed with
results that must be written to the web browser.
- 4:
- (HTML transformations) The current page has changed with
results that must be written to the web browser.
attachments
A list of document values
that represent (PDF) file attachments that were part of the rendered
form. For information about retrieving data items from a list value,
see Accessing data in data collections.
clickedBtn
A string value
that represents an XML architecture Scripting Object Model (SOM)
expression that identifies the last button that was clicked a form.
A SOM expression references objects, properties, and methods within
a Document Object Model (DOM). The following example code is a SOM
expression:
Untitled[0].main[0].ButtonHello[0]
The
items Untitled and main represent
branches in the form's DOM hierarchy. The name of the button on
the form is ButtonHello. For information about
the XML architecture, see Adobe XML Forms Architecture.
contentType
A string value
that represents the MIME content type of the data that the Forms
service generated. These string values are valid:
If the MIME
content type is text/html, the character set encoding
that was used is appended to the value, such as text/html; charset="ISO-8859-1".
formQuery
A string value
that represents the filename of the form that was rendered.
options
A string value
that represents an ampersand-delimited list of options that were
used for the operation.
outputContent
A document value
that holds the data that the Forms service generated. Depending
on the value of the action data item, the content is sent back to
the client application for further processing.
outputString
A string value
that represents the data that the Forms service generated. If the data
is binary, this value is an empty string.
outputType
An int value
that indicates the output type of a form that is rendered as HTML. These
values are valid:
- 0:
- The form is rendered within HTML elements
(a complete HTML page).
- 1:
- The form is rendered within body elements
(not a complete HTML page).
outputXML
A document value
that holds XML or HTML data modified by client application. It is
possible to enhance HTML forms by adding elements not supported
by the Forms service. For example, the client application can change
an input element to be a password type, which is not a supported
element.
pageCount
A long value
that holds the total number of pages within the generated output.
pageNumber
A long value
that holds the current page number in an HTML form. The page number
of the first page is zero. This data item is not relevant form guides
or PDF forms.
transformationID
A string value
that represents the actual transformation performed. These string
values represent what was render operation occurred:
- PDFForm:
- The Forms service rendered a PDF form, which also includes
a PDF form with merged data.
- FormGuide:
- The Forms service rendered a form guide.
- AHTML/HTML4/MSDHTML/NoScriptXHTML/StaticHTML/AccessibleXHTML/NoScriptAccessibleXHTML:
- The Forms rendered an HTML form. The format of the HTML depends
on the value of the Transform To property. See the TransformTo data
type for more information about each format.
validationErrorsList
A document value
that contains validation errors as UTF8-encoded XML. This information
is useful to client applications that want to access errors directly
after the operation executes, but before any content is returned.
The following XML shows the valid format:
<validationerrors>
<!-- page level errors -->
<pages />
<!-- field level errors -->
<fields>
<field>
<name>rootsubform[1].FFField1[1]</name>
<message>Mandatory Field</message>
</field>
</fields>
</validationerrors>
XMLData
A document value
that holds UTF8-encoded XML data from the Forms service when the
Populate XML Data property is set to True. The Populate XML Data property
is enabled using the Render Options properties of processFormSubmission operation operation.
The XML data is based on the current processing state of the form
and the result of any calculations. The result of a calculation
is indicated when the value of the FSAction data item is Calculate.
The result of a calculation is not always the same result as the
XML data returned after a form is submitted. A form is submitted
when the FSAction data item is a value of Submit.
