A standard constructor.

For internal use only. Do not invoke this method.

A constructor that enables you to set all options. For internal use only.

Creates a copy of this object.

Gets the PDF version that the Forms service creates.

Gets the character set used to encode the output byte stream. The Forms service supports character encoding values defined by the java.nio.charset package for HTML transformations.

See also

Returns a string value that specifies the client frame to use for HTML transformations. This value is not applicable for PDF forms.

See also

Returns the digSigCSSURI value. This value specifies a custom stylesheet for a digital signature user interface in HTML forms.

Gets the format of the data that the Forms service exports to a client application. The following values are supported:

• XDP - returns the data with xdp packaging.
• XDP.toXFAData - returns the data with xdp packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).
• XDP.DataOnly - xdp format but without embedded PDF or XFA template packet.
• XMLData - returns the data without XDP or xfa:datasets packaging.
• Auto - automatically determines the format based on the submitted data.

Specifies the URI location of the font mapping file. Font mapping defines which fonts are used in a form if a specified font is not available. That is, you can specify which font to substitute for an unavailable font. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Gets the location to where the form is processed. The following values are supported:

• auto
• servercode
• client
• both

See also

Gets the value of the guideCbUrl option, which specifies a custom override implementation of a callback servlet.

Returns the name of the specific guide within a guided forms definition.

Returns the name of the style sheet used by guided forms. The style sheet is also embedded in the application. The application container may contain the style sheet or the style sheet can be referenced.

For internal use only.

Returns the URL that receives image requests from the target device. This URL is inserted into the transformed output to facilitate retrieval of embedded images (for example, images embedded within an XDP form). This is only required in cases where authentication is required to retrieve the images. If not an absolute value, the sApplicationWebRoot value is combined with this value to construct an absolute URL.

See also

Returns a Boolean value that specifies whether the injectFormBridge option is set. This option specifies whether the Forms service inserts special javascript code into a PDF form that performs operations on a PDF form when rendering guided forms.

See also

For internal use only. Do not use.

Parameters

For internal use only. Do not use.

Gets a locale value that is used by the Forms service to send validation messsages to client devices, such as web browsers, as part of HTML transformations.

See also

For internal use only. Do not use.

Returns a string representation of the options that are set.

For internal use only. Do not use.

Returns the value of the specified option.

Parameters

Returns the output type value that specifies how a form that is rendered as HTML is displayed. The following values are valid:

• 0 - The form is rendered within full HTML tags (a complete HTML page).
• 1 - The form is rendered within body tags (not a complete HTML page).

See also

The page number value specifies the initial page number to render in a multipage HTML form. This option is not applicable to PDF forms.

See also

Gets the PDF version value that represents the PDF version to output. Acrobat 6.0 supports PDF version 1.5, Acrobat 7.0 or later supports PDF version 1.6, and Acrobat 8.0 or later supports PDF version 1.7. The following values are valid:

• 1.5
• 1.6
• 1.7

For internal use only. Do not use.

Returns the alias value of the credential that grants usage rights. In order to set Reader Extensions usage rights, you must specify the alias of a Reader Entensions credential.

See also

Returns the credential password value that grants usage rights. In order to set Reader Extensions usage rights, you must specify a valid credential password value.

See also

Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later. Client-side rendering improves the performance of the Forms service and only applies to PDFForm, or PDFMerge transformations. The following renderAtClient values are valid:

• auto - Instructs the Forms service to observe the form design's dynamicRender configuration value.
• true - Client-side rendering occurs within Acrobat 7.0 or later.
• false - Client-side rendering is not enabled.

See also

Return a string value that represents the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

See also

For internal use only.

Gets the seed PDF document value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery. The seed PDF document specifies a customized PDF document (contains only fonts) that is appended with a form design and data. The form is rendered by Acrobat 7.0 or later and applies to PDFForm transformations.

See also

For internal use only.

Used for HTML Toolbar Menu

Returns the validation border size in pixels when using frames.

Returns the position within the frame where validation reporting is displayed if the ValidationUI option is 0 (list). The following values are supported:

• 0 - FrameLeft
• 1 - FrameRight
• 2 - FrameTop
• 3 - FrameBottom
• 4 - NoFrameLeft
• 5 - NoFrameRight
• 6 - NoFrameTop
• 7 - NoFrameBottom
• 8 - None
• 9 - NoUI
• 10-NoUIWithForm

See also

Returns the value of the ValidationUI option, which specifies how errors are displayed. These values are valid:

• 0 - list
• 1 - message box

Returns the XCI run-time options that represent entries in the XCI configuration file or options that are programmatically set.

See also

Gets the URI location of the XCI file used for rendering. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Returns the URI location of an alternative XDC file that is used for rendering. The option can be set to a valid URI, an absolute URI with protocols, or a file location.

See also

Specifies whether the Forms service caches a PDF form to boost performance. Each form is cached after it is generated for the first time. On a subsequent render, if the cached form is newer than the form design's timestamp, the form is retrieved from the cache. The value true means that the form is cached.

See also

Returns the value of the Cb option, which specifies the generation of HTML-template initiating content, or guided forms content. The following values are valid:

• 0 - false
• 1 - true

Specifies whether the form is cached on the client.

See also

Specifies whether the debugEnabled option is enabled.

Returns the value of the guideAccessible option, which specifies whether guided forms compilation is accessible. The following values are valid:

• 0 - false
• 1 - true

See also

Returns the value of the guidePDF option, which specifies that the Forms service data output is rendered in both Flash and PDF. The following values are valid:

• 0 - false
• 1 - true

See also

Returns the value of the guideRSL option that specifies to use run-time shared libraries when compiling guided forms. The following values are valid:

• 0 - false
• 1 - true

Gets the value of the GuideSubmitAll option, which specifies whether guided forms submit all data including hidden panels.

See also

Determines whether the Forms service produces a linearized PDF form (optimized for web applications). A linearized PDF document is organized to enable incremental access in a network environment. For example, a linearized PDF document can be displayed in a web browser before the entire PDF document is downloaded. For more information about a linearized PDF document, see the PDF Reference guide.

Returns the setPDF2XDP value. This value instructs the Forms service to produce XDP output from submitted PDF content. By default, the Forms service returns the PDF that is submited. The XDP will contain a PDF packet (base64-encoded). A datasets packet contains form data if the PDF is XFA-based. An XFDF packet stores annotations (annots). The XFDF packet contains (fields) elements if the PDF is an Acrobat form.

See also

Returns a Boolean value that specifies whether the re2DBarcode option is set.

See also

Returns a Boolean value that specifies whether the reCommenting option is set.

See also

Returns a Boolean value that specifies whether the reCreatePages option is set.

See also

Returns a Boolean value that specifies whether the reDigSig option is set.

See also

Returns a Boolean value that specifies whether the reEmbeddedAttachments option is set.

See also

Returns a Boolean value that specifies whether the reExpImp option is set.

See also

Returns a Boolean value that specifies whether the reFillIn option is set.

See also

Returns a Boolean value that specifies whether the reFormFieldMod option is set.

See also

Returns a Boolean value that specifies whether the reOnlineCommenting option is set.

See also

Returns a Boolean value that specifies whether the reOnlineForms option is set.

See also

Returns a Boolean value that specifies whether the reStandaloneSubmit option is set.

See also

Specifies if the standAlone option is set to true, which results in a form being rendered without state information. State information is used to render an interactive form to an end user who then enters information into the form and submits the form back to the Form service. The Form service then performs a calculation operation and renders the form back to the user with the results displayed in the form.

In an HTML transformation, javascript is embedded instead of linked content so that it can be used while disconnected from the Form service. Set this option to true if you are using the Form service for rendering purposes and are running scripts that are located within the form while disconnected from the Form service.

See also

Retrieves the value of the taggedPDF option, which specifies the use of tagged PDF files to output forms to make them accessible with the help of screen readers. Tagged PDF files are not supported in PDF versions prior to version 1.4. The following values are valid:

• 0 - false
• 1 - true

See also

Returns a Boolean value that represents the xmlData option that specifies whether the Form service produces the form's XML data based on its current processing state.

See also

Sets the appropriate PDF version required for a client.

Parameters

Instructs the Forms service to cache a form in order to improve performance. Each form is cached after it is generated for the first time. On a subsequent render, if the cached form is newer than the form design's timestamp, the form is retrieved from the cache. This option only works in conjunction with the form design's caching property. For information, see LiveCycle Designer Help.

Parameters

Sets the value of the Cb option, which specifies the generation of HTML-template initiating content, or guided forms content. The following values are valid:

• 0 - false
• 1 - true

Parameters

Sets the character set used to encode the output byte stream. The Forms service supports character encoding values defined by the java.nio.charset package for HTML transformations.

Parameters

Sets whether the form is cached in the client web browser cache. Only forms that are rendered as interactive forms can be stored in the client web browser cache.

When subsequent requests for the PDF form are made, a time stamp located in the cached PDF form is compared with the time stamp of the PDF form that is generated by the Forms service and stored in the server cache. If they are the same, the PDF form is retrieved from the client cache. This results in reduced bandwidth usage and improves performance because the Forms service does not have to redeliver the same content to the client web browser.

Parameters

Sets the client frame to use for HTML transformations. This value is not applicable for PDF forms.

Parameters

Sets the debugEnabled option. Pass the value true to enable debug logging, which provides more information in the J2EE application server's log file.

Parameters

Sets the digSigCSSURI value. This value specifies a custom stylesheet for a digital signature user interface in HTML forms.

Parameters

Sets the data format value that controls the format of data that the Forms service exports to a client application. This method sets the data format value to one of the following values:

• XDP - returns the data with xdp packaging.
• XDP.toXFAData - returns the data with xdp packaging and data in the xfa:datasets packet (xfdf is converted to xfa data).
• XDP.DataOnly - xdp format but without embedded PDF or XFA template packet.
• XMLData - returns the data without XDP or xfa:datasets packaging.
• Auto - automatically determines the format based on the submitted data.

If XDP is submitted, then XDP.toXFAData is returned. If XMLData is submitted, then XMLData is returned. If URL encoded data is submitted, then XMLData is returned.

Parameters

Sets the URI location of the font mapping file. Font mapping defines which fonts are used in a form if a specified font is not available. That is, you can specify which font to substitute for an unavailable font.

Parameters

Sets the location to where the form is processed. If this value is set to client, the form is passed to the client device without processing. The following values are supported:

• auto
• servercode
• client
• both

Parameters

Sets the value of the guideAccessible option, which specifies whether guided forms compilation is accessible. The following values are valid:

• 0 - false
• 1 - true

Parameters

Sets the value of the guideCBURL option, which specifies a custom override implementation of a callback servlet.

Parameters

Sets the name of the specific guide within a guided forms definition.

Parameters

Sets the value of the guidePDF option, which specifies that the output is rendered in both Flash and PDF format. The following values are valid:

• 0 - false
• 1 - true

Parameters

Sets the value of the guideRSL option that specifies to use run-time shared libraries when compiling guided forms. The following values are valid:

• 0 - false
• 1 - true

Parameters

Sets the name of the style sheet used by a guided form. The style sheet is also embedded in the application. The application container may contain the style sheet or the style sheet can be referenced.

Parameters

Sets the value of the GuideSubmitAll option, which specifies whether guided forms submit all data including hidden panels. The followiing values are valid:

• 0 - false
• 1 - true

Parameters

For internal use only.

Parameters

Sets the URL that receives image requests from the target device. This URL is inserted into the transformed output to facilitate retrieval of embedded images (for example, images embedded within an XDP form). This is only required in cases where authentication is required to retrieve the images. If not an absolute value, the sApplicationWebRoot value is combined with this value to construct an absolute URL.

Parameters

Sets the injectFormBridge option that specifies whether the Forms service inserts special javascript code into a PDF form. The javascript performs operations on a PDF form when rendering guided forms. This value is set to true when you set the guidePDF option to true. For information about rendering guided forms, see Rendering Forms.

Parameters

See also

For internal use only. Do not use.

Parameters

Sets the linearizedPDF property that results in the Forms service producing a linearized PDF form. A linearized PDF document is organized to enable incremental access in a network environment. For example, a linearized PDF document can be displayed in a web browser before the entire PDF document is downloaded. For more information about a linearized PDF document, see the PDF Reference guide.

Parameters

Sets the locale value that the Forms service uses to send validation messsages to client devices, such as web browsers, when a HTML form is rendered.

Parameters

Sets the output type value that is used by the Forms service to render a form as HTML. An output type value specifies how a form that is rendered as HTML is displayed. The following values are valid:

• 0 - The form is rendered within full HTML tags (a complete HTML page).
• 1 - The form is rendered within body tags (not a complete HTML page).

Parameters

The page number value specifies the initial page number to render in a multipage HTML form. This option is not applicable to PDF forms.

Parameters

Sets the setPDF2XDP value. Setting this value to true instructs the Forms service to produce XDP output from submitted PDF content. By default, the Forms service returns the PDF that is submited. The XDP will contain a PDF packet (base64-encoded). A datasets packet contains form data if the PDF is XFA-based. An XFDF packet stores annotations (annots). The XFDF packet contains (fields) elements if the PDF is an Acrobat form.

Parameters

Sets the PDF version value that represents the PDF version to output. Acrobat 6.0 supports PDF version 1.5, Acrobat 7.0 or later supports PDF version 1.6, and Acrobat 8.0 or later supports PDF version 1.7. The following values are valid:

• 1.5
• 1.6
• 1.7

Parameters

Sets the re2DBarcode option that enables the Forms service to render forms that contain 2D barcodes and enables a user to fill in the form using Adobe Reader. When a user fills in an interactive form that contains a barcoded, the barcode is updated automatically to encode the user-supplied data. For information, see Working With the Barcoded Forms Service.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reCommenting option that enables the Forms service to render forms that allow users to add comments to the PDF form using Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reCreatePages option that enables the Forms service to render forms that allow users to dynamically add pages within Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the alias value of the credential that grants usage rights. In order to set Reader Extensions usage rights, you must specify the alias of a Reader Entensions credential. For information, see Applying Usage Rights.

Parameters

Sets the credential password value that grants usage rights. In order to set Reader Extensions usage rights, you must specify a valid credential password value.

Parameters

Sets the reDigSig option that enables the Forms service to render PDF forms that allow users to digitally sign the form using Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reEmbeddedAttachments option that enables the Forms service to render PDF forms that allow users to add attachments to the form using Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reExpImp option that enables the Forms service to render PDF forms that allow users to import and export form data using Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reFillIn option that enables the Forms service to render PDF forms that allow users to fill in form fields and save the PDF form from within Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reFormFieldMod option that enables the Forms service to render PDF forms that allow users to modify form fields and save the PDF form from within Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Enables the delivery of PDF content by using the the client-side rendering capability of Acrobat 7.0 or later. Client-side rendering improves the performance of the Forms service and only applies to PDFForm, or PDFMerge transformations. When set to auto and AcrobatVersion is set to acrobat7.0.5 (or later), then a form is rendered to a client once, which improves the performance of the Form service. The rendered form behaves as a non-interactive form. The following renderAtClient values are valid:

• auto - Instructs the Forms service to observe the form design's dynamicRender configuration value.
• true - Client-side rendering occurs within Acrobat 7.0 or later.
• false - Client-side rendering is not enabled.

Parameters

Sets the reOnlineCommenting option that enables the Forms service to render PDF forms that allow users to add comments within Adobe Reader while online.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the reOnlineForms option that enables the Forms service to render PDF forms that allow users to interact with a form while online from within Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

Sets the message that is displayed within Adobe Reader to inform users that the form contains usage rights.

Parameters

Sets the reStandaloneSubmit option that enables the Forms service to render PDF forms that allows users to submit information from within Adobe Reader.

In order to set this option, you must have the Reader Extensions service and invoke both the setReCredentialAlias and setReCredentialPassword methods.

Parameters

See also

For internal use only.

Parameters

Sets the seed PDF value that specifies an initial PDF document that is used in a PDF transformation to optimize delivery. The seed PDF document specifies a customized PDF document (contains only fonts) that is appended with a form design and data. The form is rendered by Acrobat 7.0 or later and applies to PDFForm transformations.

Parameters

For internal use only.

Parameters

Sets the standAlone option. If set to true, a form is rendered without state information. State information is used to render an interactive form to an end user who then enters information into the form and submits the form back to the Form service. The Form service then performs a calculation operation and renders the form back to the user with the results displayed in the form.

In an HTML transformation, javascript is embedded instead of linked content so that it can be used while disconnected from the Form service. Set this option to true if you are using the Form service for rendering purposes and are running scripts that are located within the form while disconnected from the Form service.

Parameters

Sets the taggedPDF option that results in the Forms service creating a tagged PDF form. A tagged PDF form defines a set of standard structure types and attributes that allow page content (text, graphics, and images) to be extracted and reused for other purposes. It is intended for use by tools that perform the following types of operations:

• Simple extraction of text and graphics for pasting into other applications.
• Automatic reflow of text and associated graphics to fit a page of a different size than was assumed for the original layout.
• Processing text for such purposes as searching, indexing, and spell-checking.
• Conversion to other common file formats (such as HTML, XML, and RTF) with document structure and basic styling information preserved.
• Making content accessible to users with visual impairments (accessible with the help of screen readers).

Tagged PDF files are not supported in PDF versions prior to version 1.4. For more information about tagged PDF documents, see the PDF Reference guide.

Parameters

Used for HTML Toolbar Menu

Parameters

Sets the validation border size in pixels when using frames.

Parameters

Sets the position within the frame where validation reporting is displayed if the ValidationUI option is 0 (list). By setting this value, you specify whether the list appears within a frame, and the location of the list relative to the form. This option is valid for forms that are rendered as HTML. The following values are valid:

• 0 - FrameLeft
• 1 - FrameRight
• 2 - FrameTop
• 3 - FrameBottom
• 4 - NoFrameLeft
• 5 - NoFrameRight
• 6 - NoFrameTop
• 7 - NoFrameBottom
• 8 - None
• 9 - NoUI
• 10-NoUIWithForm

Parameters

Sets the value of the ValidationUI option, which specifies how errors are displayed. These values are valid:

• 0 - list
• 1 - message box

Parameters

Sets XCI run-time options that are executed when processFormSubmission() or one of the form rendering methods are invoked. By setting XCI run-time options, you can change configuration values that are located within the XCI configuration file that the Forms service uses. The ability to set XCI run-time options is optional. You define XCI run-time options by passing the following string value to this method:

XCI=[path-expression]=[value];[path-expression]=[value];...[path-expression]=[value];

[path-expression] is an XPath expression that is relative to the configuration root element representing the element to update, and [value] is the value to assign to the path expression. If the value is omitted, the element is cleared. Only simple XPath expressions that contain "/" and "@" characters are supported.

The following example changes the default typeface to MyriadPro:

XCI=present/pdf/fontInfo/defaultTypeface=MyriadPro

Setting XCI options can affect the resulting PDF form. For example, consider the following XCI options:

XCI=present/pdf/fontInfo/embed=1&PDFVersion=1.6 XCI=present/pdf/fontInfo/embed=1

The size of the resulting files is different. When you set the PDF version to 1.6, the Forms service embeds the fonts as a subset. When you do not set the PDF version, the Forms service fully embeds the font. The one that contains the fully embedded font is at least twice as large as the file that has the fonts embedded as subset. Specify the PDF version to embed the font as a subset.

Parameters

 <order>
 <number>1</number>
 <shipto>
 <customer>c001</customer>
 </shipto>
 <item>
 <book>
 <ISBN>15536455</ISBN>
 <title>Introduction to XML</title>
 <quantity>1</quantity>
 <unitprice>55.00</unitprice>
 </book>
 </item>
 <item>
 <book>
 <ISBN>15536456</ISBN>
 <title>Advanced XML</title>
 <quantity>1</quantity>
 <unitprice>75.00</unitprice>
 </book>
 </item>
 </order>
 

 <order>
 <number>1</number>
 <shipto>
 <customer>c001</customer>
 </shipto>
 <item>
 <book>
 <ISBN>15536455</ISBN>
 <title>Introduction to XML</title>
 <quantity>1</quantity>
 <unitprice>55.00</unitprice>
 </book>
 </item>
 <item>
 <book>
 <ISBN>15536456</ISBN>
 <title>Advanced XML</title>
 <quantity>1</quantity>
 <unitprice>75.00</unitprice>
 </book>
 </item>
 </order>
 

Sets the URI location of the XCI file used for rendering. If the root is not specified, the file is assumed to reside in the LiveCycle.ear file.

Parameters

Sets the URI location of an alternative XDC file that is used for rendering. The option can be set to a valid URI, an absolute URI with protocols, or a file location. An alternative XDC file is used in situations where the Forms service cannot locate an XDC file (for example, there may be a network issue).

Parameters

Sets the xmlData option that instructs the Form service to produce the form's XML data based on its current processing state.

Parameters

For internal use only. Do not use.

Creates a string represenation of this class.

For internal purposes only. Do not invoke this method.

Parameters

For internal purposes only. Do not invoke this method.

Parameters