|
This section lists only those scripting objects that are
available for HTML forms and (deprecated) Guides, along with any
scripting properties and methods that each object supports for those
output formats. For a complete, alphabetic list of scripting properties
and methods, and their availability in HTML forms and Guides, see Scripting Properties and Scripting Methods.
Note: Scripting properties and methods listed as Not
applicable do not have any logical meaning within the specified
output format. For example, Guides do not contain a concept of pages,
so properties or methods related to information about form pages
do not apply. These properties and methods will fail gracefully
and will not generate errors or return exceptions.
xfaThe xfa object corresponds to the following Designer scripting
syntax:
xfa.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
className
|
no
|
yes
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
resolveNode
|
yes
|
yes
|
resolveNodes
|
yes
|
yes
|
dataThe data object corresponds to the following Designer scripting
syntax:
xfa.data.*
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
resolveNode
|
no
|
yes
|
resolveNodes
|
no
|
yes
|
saveXML
|
no
|
yes
To save the
root level data, use the following syntax:
var originalData = xfa.data.saveXML();
|
datasetsThe data object corresponds to the following Designer scripting
syntax:
xfa.data.datasets.*
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
loadXML
|
no
|
yes
The optional parameters on this
method are not supported in Guides.
This
method is supported only at the root level. You cannot load data
at a subform level.
To save the root level data, use the
following syntax:
var originalData
= xfa.data.saveXML();
To later reload the data, use the following
syntax:
xfa.datasets.loadXML(originalData);
|
resolveNode
|
no
|
yes
|
resolveNodes
|
no
|
yes
|
eventpseudomodelThe eventpseudomodel object corresponds to the following
Designer scripting syntax:
xfa.event.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
change
|
no
|
yes
|
className
|
no
|
yes
|
name
|
no
|
yes
|
newText
|
no
|
yes
|
hostpseudomodelThe hostpseudomodel object corresponds to the following
Designer scripting syntax:
xfa.host.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
calculationsEnabled
|
yes
|
yes
|
className
|
no
|
yes
|
currentPage
|
yes
|
Not applicable
|
name
|
yes
|
yes
|
numPages
|
yes
|
Not applicable
|
validationsEnabled
|
yes
|
yes
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
gotoURL
|
yes
|
no
|
messageBox
|
yes
|
yes
|
pageDown
|
yes
|
no
|
pageUp
|
yes
|
no
|
print
|
no
|
no
|
resetData
|
yes
|
yes
|
setFocus
|
yes
|
no
|
formThe form object corresponds to the following Designer scripting
syntax:
xfa.form.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
className
|
no
|
yes
|
nodes
|
no
|
yes
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
execCalculate
|
yes
|
yes
|
execInitialize
|
yes
|
yes
|
execValidate
|
yes
|
yes
|
recalculate
|
no
|
yes
|
remerge
|
no
|
yes
|
resolveNode
|
yes
|
yes
|
resolveNodes
|
yes
|
yes
|
fieldThe field object corresponds to the following Designer
scripting syntax:
field_name.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
access
|
yes
|
yes
|
all
|
no
|
yes
|
borderColor
|
yes
|
Not applicable
|
borderWidth
|
yes
|
Not applicable
|
classAll
|
no
|
yes
|
className
|
no
|
yes
|
errorText
|
yes
|
no
Note: Guides support
XFA 2.8.
|
fillColor
|
yes
|
Not applicable
|
fontColor
|
yes
|
Not applicable
|
formattedValue
|
yes
|
yes
|
h
|
yes
|
Not applicable
|
index
|
yes
|
yes
|
isContainer
|
no
|
yes
|
mandatory
|
yes
|
yes
|
mandatoryMessage
|
yes
|
yes
|
name
|
yes
|
yes
|
nodes
|
no
|
yes
|
parent
|
yes
|
yes
|
parentSubform
|
no
|
yes
|
presence
|
yes
|
yes
|
somExpression
|
no
|
yes
|
validationMessage
|
yes
|
yes
|
w
|
yes
|
Not applicable
|
x
|
yes
|
Not applicable
|
y
|
yes
|
Not applicable
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
addItem
|
yes
|
Drop-down lists and
|
boundItem
|
no
|
Drop-down lists only
|
clearItems
|
yes
|
Drop-down lists only
|
deleteItem
|
no
|
Drop-down lists only
|
execCalculate
|
yes
|
yes
|
execEvent
|
yes
|
yes
|
execInitialize
|
yes
|
yes
|
execValidate
|
yes
|
yes
|
getDisplayItem
|
no
|
Drop-down lists only
|
getItemState
|
no
|
Drop-down lists only
|
getSaveItem
|
no
|
Drop-down lists only
|
resolveNode
|
yes
|
yes
|
resolveNodes
|
yes
|
yes
|
setItemState
|
no
|
Drop-down lists only
|
subformThe subform object corresponds to the following Designer
scripting syntax:
subform_name.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
all
|
no
|
yes
|
borderColor
|
yes
|
Not applicable
|
borderWidth
|
yes
|
Not applicable
|
classAll
|
no
|
yes
|
className
|
no
|
yes
|
fillColor
|
yes
|
Not applicable
|
index
|
no
|
yes
|
instanceIndex
|
no
|
yes
|
isContainer
|
no
|
yes
|
name
|
yes
|
yes
|
nodes
|
no
|
yes
|
parent
|
yes
|
yes
|
presence
|
yes
|
yes
|
somExpression
|
no
|
yes
|
validationMessage
|
yes
|
yes
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
execCalculate
|
yes
|
yes
|
execEvent
|
yes
|
yes
|
execInitialize
|
yes
|
yes
|
execValidate
|
yes
|
yes
|
getInvalidObjects
|
yes
|
no
Note: Guides support
XFA 2.8.
|
resolveNode
|
yes
|
yes
|
resolveNodes
|
yes
|
yes
|
instanceManagerThe instanceManager object corresponds to the following
Designer scripting syntax:
subform_name.instanceManager.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
className
|
no
|
yes
|
count
|
yes
|
yes
|
isContainer
|
no
|
yes
|
max
|
yes
|
yes
|
min
|
yes
|
yes
|
name
|
yes
|
yes
|
somExpression
|
no
|
yes
|
Methods
Scripting method
|
Supported in HTML
|
Supported in Guides
|
|---|
addInstance
|
yes
|
yes
|
insertInstance
|
yes
|
yes
|
instanceCount
|
yes
|
yes
|
moveInstance
|
yes
|
yes
|
removeInstance
|
yes
|
yes
|
setInstances
|
yes
|
yes
|
occurThe occur object corresponds to the following Designer
scripting syntax:
subform_name.occur.*
Properties
Scripting property
|
Supported in HTML
|
Supported in Guides
|
|---|
initial
|
no
|
yes
|
max
|
yes
|
yes
|
min
|
yes
|
yes
|
|
|
|
