XFA

Inheritance: java.lang.Object, com.aspose.pdf.XFA

public final class XFA extends Object

Represents XML form regarding XML Forms Architecture (XFA).

Methods

MethodDescription
appendToTemplateAppend XML value to the template’s node that matches the XPath expression
beginCachedUpdatesStart cached updates mode. All changes made to XFA will be cached and saved into document structure at EndCachedUpdates call. This allows to improve preformacne by avoiding redudant operations on saving XML packets into document when a lot of changes to XFA are made.
endCachedUpdatesEnds cahced updates and saves all data into document structure.
flattenXfaFieldFlatten field of XFA form.
get_ItemGets data node value according {@code path}.
getConfigXFA Config component of an XFA form.
getDatasetsXFA Datasets component of an XFA form.
getFieldNamesList of field names in the form template.
getFieldsWithTextValuesMap

Returns map with short field name and it’s string value for all fields.

getFieldTemplateReturns XML node of XFA field tempalte.
getFieldTemplatesReturns list of all field templates on XFA form.
getFormGets XFA Form Component of an XFA form.
getNamespaceManager_Gets the namespace for the XFA form. The following namepsaces are defined: “data” for form data and “tpl” for form template.
getNamespaceManagerReturns namespace manager with namespaces used for template and data.
getTemplateXFA Template component of an XFA form.
getXDPXML Data Package (all XFA form components within a surrounding XML container).
getXfaField
set_ItemGets data node value according {@code path}.
setFieldImageSets image for XFA field.
setFieldImageInternal
tryGetTemplateStringTries to export calculation script from XFA form. Otherwise returns the empty string;

appendToTemplate

Append XML value to the template’s node that matches the XPath expression

beginCachedUpdates

public void beginCachedUpdates()

Start cached updates mode. All changes made to XFA will be cached and saved into document structure at EndCachedUpdates call. This allows to improve preformacne by avoiding redudant operations on saving XML packets into document when a lot of changes to XFA are made.

endCachedUpdates

public void endCachedUpdates()

Ends cahced updates and saves all data into document structure.

flattenXfaField

Flatten field of XFA form.

get_Item

Gets data node value according {@code path}.

getConfig

public com.aspose.ms.System.Xml.XmlNode getConfig()

XFA Config component of an XFA form.

Returns: XmlNode object

getDatasets

public com.aspose.ms.System.Xml.XmlNode getDatasets()

XFA Datasets component of an XFA form.

Returns: XmlNode object

getFieldNames

public String [] getFieldNames()

List of field names in the form template.

Returns: array of String values

getFieldsWithTextValuesMap

public HashMap < String , String > getFieldsWithTextValuesMap()

Returns map with short field name and it's string value for all fields.

Returns: {@code HashMap<String, String>} object

getFieldTemplate

Returns XML node of XFA field tempalte.

getFieldTemplates

public com.aspose.ms.System.Xml.XmlNodeList getFieldTemplates()

Returns list of all field templates on XFA form.

Returns: List of field templates.

getForm

public com.aspose.ms.System.Xml.XmlNode getForm()

Gets XFA Form Component of an XFA form.

Returns: XmlNode object

getNamespaceManager_

public com.aspose.ms.System.Xml.XmlNamespaceManager getNamespaceManager_()

Gets the namespace for the XFA form. The following namepsaces are defined: “data” for form data and “tpl” for form template.

Returns: XmlNamespaceManager object

getNamespaceManager

public com.aspose.ms.System.Xml.XmlNamespaceManager getNamespaceManager()

Returns namespace manager with namespaces used for template and data.

Returns: XmlNamespaceManager object

getTemplate

public com.aspose.ms.System.Xml.XmlNode getTemplate()

XFA Template component of an XFA form.

Returns: XmlNode object

getXDP

public com.aspose.ms.System.Xml.XmlDocument getXDP()

XML Data Package (all XFA form components within a surrounding XML container).

Returns: XmlDocument object

getXfaField

set_Item

Gets data node value according {@code path}.

setFieldImage

Sets image for XFA field.

setFieldImageInternal

tryGetTemplateString

Tries to export calculation script from XFA form. Otherwise returns the empty string;