HTMLRenderSpec

A complex data type that contains information for configuring the HTML Render Options property of the renderHTMLForm operation (deprecated) operation that the Forms service provides.

For information about data that can be accessed using Xpath Expressions, see Data items.

For information about configuring default properties, see Datatype specific settings.

    Data items

    The data items that HTMLRenderSpec variables contain.

    cacheEnabled

    A boolean value that specifies whether the Forms service caches a form 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. A value of true indicates the form is cached, and false indicates the form is always generated anew.

    charset

    A string value that represents the character set used to encode the output byte stream. For a complete list of these values, go to http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

    customCSSURI

    A string value that represents the location of a cascading style sheet (CSS) to use instead of the internal CSS that is created during the HTML transformation.

    You can use the FormsIVS tool to create a custom CSS. (See the Forms section in LiveCycle ES3 Services.)

    debugEnabled

    A boolean value that determines whether debug-level logging is performed. Debug-level logging provides more information in the J2EE application server's log file that is useful for debugging. A value of true indicates that debug-level logging is performed, and false indicates that the default level of logging is performed. The default level for logging is set on the server.

    digSigCCSURI

    A string value that represents the URI for a custom style sheet to use for digital signature user interfaces in HTML forms. LiveCycle Server must have access to the location of the URI.

    fontMapURI

    A string value that represents the URI for font mappings.

    formModel

    A FormModel value that represents where the form rendering is performed.

    generateTabIndex

    A boolean value that specifies whether to generate a tab index for fields in the HTML form. A value of true specifies that tab indexes are created for each field in the rendered HTML form. A value of false specifies that tab indexes are not created for each field in the rendered HTML form.

    HTMLToolbar

    A HTMLToolbar value that represents the type of toolbar that is rendered for HTML forms.

    locale

    A string value that represents the locale that the Forms service uses to send validation messages to client applications, such as web browsers. When no value is provided, the default Locale setting from LiveCycle Server is used. The Locale setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help .)

    For a complete list of Locale IDs you can use, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html.

    outputType

    A string value that represents how a form that is rendered as HTML is displayed. When no value is provided, the default Output Type setting from LiveCycle Server is used. The Output Type setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help.) These values are valid:

    BodyTags:
    The rendered page is wrapped with <BODY> tags.

    FullHTMLTags:
    The rendered page is wrapped with <HTML> tags.

    pageNumber

    An int value that represents the initial page number to display in a multipage HTML form.

    standAlone

    A boolean value that specifies whether the form is rendered without state information. This value is useful when rendering of an interactive form occurs on the server and the form contains JavaScript code that must be executed.

    A value of true indicates that the JavaScript code in the form design runs on the client. No interaction is required with LiveCycle Server. JavaScript code is embedded in the rendered HTML form. A value of false indicates the form is rendered without state information and without embedded JavaScript that runs on the client web browser. The Forms service renders the form after server-side calculations are performed and the results are displayed in the rendered form. Because of the required interaction with the Forms service, the form cannot be used when offline. A value of true indicates that the form is rendered with state information and with embedded JavaScript. The JavaScript code runs on the only on the client and no interaction is required with LiveCycle Server. In addition, the form can be used offline.

    styleGenerationLevel

    A StyleGenerationLevel value that represents the styling to output for the rendered HTML form. Internal styles are used for spacing and positional CSS styles. Inline styles are used for appearance styles, such as color, font, and background color.

    toolbarURI

    A string value that represents the URI of custom collateral that is required for a custom toolbar on the form. Custom collateral includes XML, JS, and CSS files. If you are using the default toolbar, then you do not need to supply custom collateral.

    XCIURI

    A string value that represents the URI of the XCI file used for rendering.

    XMLData

    A boolean value that indicates whether the Forms service produces the form’s XML data based on the service’s current processing state. A value of true indicates the XML data is based on the current processing state.

    Datatype specific settings

    Properties for specifying the default form and rendering options for the HTML form.

    HTML Output Type

    Sets whether to wrap the rendered page with Full HTML Tags or Body Tags. The default value is <Use Server Default>. Select one of these values:

    <Use Server Default>:
    Use the default Output type setting configured on LiveCycle Server. The Output type setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help.)

    Full HTML tags:
    The rendered page is wrapped with <HTML> tags.

    Body Tags:
    The rendered page is wrapped with <BODY> tags.

    Character Set

    Sets the character set used to encode the output byte stream. The default value is <Use Server Default>. Select the character set to use or one of these values.

    <Use Server Default>:
    Use the Character Set setting configured on LiveCycle Server. The Character Set setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help.)

    <Use Custom Value>:
    Use a character set not available in the list. After selecting this value, in the text box beside the list, type the canonical name (Java.nio API) of the encoding set to use. For a complete list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

    Start Page Number

    Sets the first page number to start to render in a multi-page HTML form. Page numbering is zero-based, which means that the first page is zero. The default value is 0.

    Character Set

    Sets the character set used to encode the output byte stream. The default value is <Use Server Default>. Select either a character set from the list or one of these values.

    <Use Server Default>:
    Use the Character Set setting configured on LiveCycle Server. The Character Set setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help.)

    <Use Custom Value>:
    Use a character set not available in the list. After select this value, in the text box beside the list, type the canonical name (Java.nio API) of the encoding set to use. For a complete list of character sets, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

    Locale

    Sets the language used to send validation messages to client devices, such as web browsers, when an HTML form is rendered. The default value is <Use Server Default>. Select either a language from the list or one of these values.

    <Use Server Default>:
    Use the Locale setting configured on LiveCycle Server. The Locale setting is configured in Administration Console. (See Adobe LiveCycle ES3 Administration Help.)

    <Use Custom Value>:
    Use a locale setting that is not available in the list. After selecting this value, in the text box beside the list, type the Locale ID of the locale code to use. For a complete list of supported locale codes, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html.

    Cache Form On Server

    Sets whether the rendered form is cached on the server to improve performance. Caching forms on the server improves performance for forms that are rendered on the server. Processing instructions embedded in the form design and the Form Rendering Cache Enabled option determines how caching is performed. For information about configuring the Rendering Cache Enabled option in Administration Console, see Configuring Forms.The default value is False. Select one of these values:

    False:
    The form is not cached on the server.

    True:
    The form is cached on the server.

    Populate XML Data

    Sets whether the XML data is produced from the form based on the form’s current processing state. The default value is False. Select one of these values:

    True:
    Produces XML data based on the current state of the form.

    False:
    Does not produce XML data based on the state of the form.

    Stand Alone Rendition

    Sets whether the form can be rendered without state information. State information is used for rendered forms that require user interaction with the server for submissions. The default is False. Select one of these values:

    False:
    The form is rendered without state information and without embedded JavaScript that runs on the client web browser. The Forms service renders the form after server-side calculations are performed and the results are displayed in the rendered form. Because of the required interaction with the Forms service, the form cannot be used offline.

    True:
    The form is rendered with state information and with embedded JavaScript. The JavaScript code runs on the only on the client and no interaction is required with LiveCycle Server. In addition, the form can be used offline.

    Form Model

    Sets the location where scripts embedded in the form are executed. The default value is <Use Form Template Default>. Select one of these values:

    <Use Form Template Default>:
    The Forms service checks the form design to determine whether to render on the client or server.

    <Client Side>:
    The form is rendered on the client. Do not use scripts that run on the server. When this value is selected, scripts that run on the server generate a warning on LiveCycle Server.

    <Server Side>:
    The form is rendered on the server.

    <Both Server and Client side>:
    The form is rendered on both the server and the client.

    XCI URI

    Sets the URI location of the XCI file to use for rendering. If the root is not specified, the file is assumed to reside in the location where the LiveCycle EAR files are deployed. For example, in a JBoss turnkey installation, you can see default XCI files in the [Install folder]/jboss/server/lc_turnkey/svcdata/XMLFormService folder. [Install folder] is the location where LiveCycle is installed. For information about creating XCI files, see Adobe LiveCycle ES3 - Designer 10 Help.

    Digital Signature CSS URI

    Sets the URI, such as C:\\customds.css, for a custom style sheet to use for digital signature user interfaces in HTML forms. LiveCycle Server must have access to the location of the URI.

    Note: To create a custom CSS file, use Forms-IVS tool to generate a custom CSS based for your form design and output type you provide.

    Custom CSS URI

    Sets the URI, such as C:\customcss.css, for a custom cascading style sheet to use instead of the internal one emitted as part of the HTML form. Review the changes to the custom CSS file when changes are made to the form design.

    • A new type of form object is added to the form design, such as button, text, text field, or check box.

    • A form object is removed from the form design.

    • Moving a form object, such as label or field, from a child subform to its parent or another subform.

    LiveCycle Server must have access to the location of the URI.

    Note: To create a custom CSS file, use Forms-IVS tool to generate a custom CSS based for your form design and output type you provide.

    HTML Toolbar

    Sets the type of toolbar that is rendered for HTML forms. The default value is Disabled. Select one of these values:

    Disabled:
    The HTML toolbar is disabled.

    Vertical:
    The HTML toolbar appears in a vertical position.

    Horizontal:
    The HTML toolbar appears in a horizontal position.

    HTML Toolbar URI

    Sets the URI location of the HTML toolbar resources to include in the rendered HTML transformation.

    Generate Tab Index

    Sets whether to create a tab index for each field in the rendered HTML form. When an HTML form with tab indexes is embedded into another HTML page that does not have tab indexes, tabbing inconsistencies can occur. The default value is True. Select one of these values:

    True:
    Tab indexes are created for each field in the rendered HTML form.

    False:
    Tab indexes are not created for each field in the rendered HTML form. Use this option when you embed the HTML form in another HTML form that does not have tab indexes.

    Style Generation Level

    Sets the styling to output for the rendered HTML form. Internal styles are used for spacing and positional CSS styles. Inline styles are used for appearance styles, such as color, font, and background color. The default is Inline And Internal Styles. Select one of these values:

    Inline And Internal Styles:
    Use both inline and internal CSS styles. Internal styles use spacing and positional CSS styles. Inline styles use appearance styles, such as color, font, and background color.

    Only Inline Styles:
    Use only inline CSS styles from the custom CSS file.

    No Styles:
    Use any CSS an inline or internal styling.

    // Ethnio survey code removed