Adobe acrobat forms javascript object specification User Manual

Page of 64
Acrobat Forms - JavaScript Object Specification
25
The optional aFields parameter is the array of field names to submit or a string containing a
single field name. If this parameter is present then only the fields indicated are exported,
except those excluded by parameter bEmpty or bNoPassword. If this parameter is omitted or is
null then all fields in the form are exported (again subject to the restrictions of bEmpty).
You can include non-terminal fields in the array or the string passed as a parameter: this is a
simple shortcut for having a whole subtree exported.
Example:
/* Export the entire form (including empty fields) with flags. */
this.exportAsFDF(true, true, null, true);
/* Export the name subtree with no flags. */
this.exportAsFDF(false, true, “name”);
The example above illustrates a shortcut to exporting a whole subtree. Passing “name” as part
of the aFields parameter, exports “name.title”, “name.first”, “name.middle” and “name.last”,
etc.
The optional aFlags parameter indicates, if true, that field flags should be included in the
exported FDF. The default is false.
This method does not work in the Acrobat Reader.
getField
Parameters: cName
Returns: object
Use this function to map a field object in the PDF document to a JavaScript variable. The
cName parameter is the name of the field of interest. This function returns a Field JavaScript
object representing the form field in the PDF document.
getNthFieldName
Parameters: nIndex
Returns: cName
Use this function to obtain the nth field name in the document (see the
property).
Example:
// Enumerate through all of the fields in the document.
for (var i = 0; i < this.numFields; i++) {
console.println("Field[" + i + "] = " + this.getNthFieldName(i));
}
4.0