Annot object properties and methods
|
All properties and methods
|
Yes
|
None
|
Only forms with a fixed layout support the
annotation layer.
|
app object properties
|
calculate
|
No
|
None
|
Designer includes the execCalculate method
which initiates the calculate event.
execCalculate
|
language
|
Yes
|
xfa.host.language
|
See the language property.
language
|
monitors
|
Yes
|
None
|
|
platform
|
Yes
|
xfa.host.platform
|
See the platform property.
platform
|
plugins
|
Yes
|
None
|
|
toolbar
|
Yes
|
None
|
|
viewerType
|
Yes
|
xfa.host.appType
|
See the appType property.
appType
|
viewerVariation
|
Yes
|
xfa.host.variation
|
See the variation property.
variation
|
viewerVersion
|
Yes
|
xfa.host.version
|
See the version property.
version
|
app object methods
|
addMenuItem
|
Yes
|
None
|
|
addSubMenu
|
Yes
|
None
|
|
addToolButton
|
Yes
|
None
|
|
alert
|
Yes
|
xfa.host.messageBox()
|
See the messageBox method.
messageBox
|
beep
|
Yes
|
xfa.host.beep()
|
See the beep method.
beep
|
browseForDoc
|
Yes
|
None
|
|
clearInterval
|
Yes
|
None
|
|
clearTimeOut
|
Yes
|
None
|
|
execDialog
|
Yes
|
None
|
|
execMenuItem
|
Yes
|
None
|
Executes the specified menu command. Use
this method in Designer for File menu commands.
|
getNthPluginName
|
Yes
|
None
|
|
getPath
|
Yes
|
None
|
|
goBack
|
Yes
|
None
|
|
goForward
|
Yes
|
None
|
|
hideMenuItem
|
Yes
|
None
|
|
hideToolbarButton
|
Yes
|
None
|
|
launchURL
|
Yes
|
None
|
Designer includes the gotoURL method
that loads a specified URL into the client application, such as Acrobat
or Adobe Reader.
gotoURL
|
listMenuItems
|
Yes
|
None
|
|
listToolbarButtons
|
Yes
|
None
|
|
mailGetAddrs
|
Yes
|
None
|
|
mailMsg
|
Yes
|
None
|
|
newDoc
|
Yes
|
None
|
This method can only be executed during
batch, console, or menu events.
|
newFDF
|
No
|
None
|
|
openDoc
|
Yes
|
None
|
|
openFDF
|
No
|
None
|
|
popUpMenuEx
|
Yes
|
None
|
|
popUpMenu
|
Yes
|
None
|
|
removeToolButton
|
Yes
|
None
|
|
response
|
Yes
|
xfa.host.response()
|
See the response method.
response
|
setInterval
|
Yes
|
None
|
|
setTimeOut
|
Yes
|
None
|
|
trustedFunction
|
Yes
|
None
|
|
trustPropagatorFunction
|
Yes
|
None
|
This method is only available during batch,
console, and application initialization.
|
Bookmark object properties and methods
|
All properties and methods
|
Yes
|
None
|
|
doc object properties
|
author
|
Yes
|
None
|
|
baseURL
|
Yes
|
None
|
|
bookmarkRoot
|
Yes
|
None
|
|
calculate
|
No
|
None
|
|
dataObjects
|
Yes
|
None
|
|
delay
|
No
|
None
|
|
dirty
|
Yes
|
None
|
This JavaScript script for Designer saves
a copy of a form and tests whether the form has changed:
var sOrigXML = xfa.data.saveXML;
if (sOrigXML != xfa.data.saveXML)
{...}
|
disclosed
|
Yes
|
None
|
|
documentFileName
|
Yes
|
None
|
|
dynamicXFAForm
|
Yes
|
None
|
|
external
|
Yes
|
None
|
|
filesize
|
Yes
|
None
|
|
hidden
|
Yes
|
None
|
|
icons
|
Yes
|
None
|
|
keywords
|
Yes
|
None
|
|
layout
|
Yes
|
None
|
|
media
|
Yes
|
None
|
|
metadata
|
Yes
|
xfa.form.desc
|
See the desc object.
desc
|
modDate
|
Yes
|
None
|
|
mouseX
mouseY
|
Yes
|
None
|
|
noautocomplete
|
Yes
|
None
|
|
nocache
|
Yes
|
None
|
|
numFields
|
Yes
|
xfa.layout.pageContent()
|
The pageContent method
returns a list of all objects of a particular type. However, you
must execute the method for design views and master pages to scan
the entire form.
pageContent
|
numPages
|
Yes
|
xfa.host.numPages
or
xfa.layout.absPageCount()
xfa.layout.pageCount()
|
The numPages property returns
the page count for the rendered form in the client. See also the absPageCount and pageCount methods.
numPages
absPageCount
pageCount
|
pageNum
|
Yes
|
xfa.host.currentPage
|
See the currentPage property.
currentPage
|
pageNum--
|
Yes
|
xfa.host.currentPage--
or
xfa.host.pageUp()
|
See the currentPage property
or the pageUp method.
currentPage
pageUp
|
pageNum++
|
Yes
|
xfa.host.currentPage++
or
xfa.host.pageDown()
|
See the currentPage property
or the pageDown method.
currentPage
pageDown
|
path
|
Yes
|
None
|
|
securityHandler
|
Yes
|
None
|
|
templates
|
No
|
None
|
Use subform objects in Designer, and use
properties and methods to add, remove, move, and set subform instances.
Add
and remove subform instances using scripting
|
title
|
Yes
|
xfa.host.title
|
See title.
|
doc object methods
|
addAnnot
|
Yes
|
None
|
|
addField
|
No
|
None
|
You must use forms that have a fixed layout
in Designer, and then use the instanceManager object
to add, remove, and set the number of instances of a particular
object.
instanceManager
For more information,
see Add
and remove subform instances using scripting.
|
addIcon
|
Yes
|
None
|
|
addLink
|
No
|
None
|
|
addRecipientListCryptFilter
|
Yes
|
None
|
|
addScript
|
Yes
|
None
|
|
addThumbnails
|
No
|
None
|
|
addWatermarkFromFile
|
Yes
|
None
|
|
addWatermarkFromText
|
Yes
|
None
|
|
addWeblinks
|
Yes
|
None
|
|
appRightsSign
|
Yes
|
None
|
|
appRightsValidate
|
Yes
|
None
|
|
bringToFront
|
Yes
|
None
|
|
calculateNow
|
No
|
xfa.form.recalculate(1);
or
execCalculate()
|
recalculate
The recalculate method
forces a specific set of scripts on calculate events
to initiate. Boolean value indicates whether True (default)
- all calculation scripts initiate; or False -
only pending calculation scripts initiate.
Designer calculate object
controls whether a form filler can override a field’s calculated
value.
execCalculate
Alternatively,
you can use the execCalculate method for each object
for which you want to force a recalculation.
|
closeDoc
|
Yes
|
None
|
|
createDataObject
|
Yes
|
None
|
|
createTemplate
|
No
|
None
|
Designer forms do not have an equivalent
to the concept of an Acrobat template. You must use subform objects
in Designer.
|
deletePages
|
No
|
None
|
instanceManager
In Designer,
you can use the instanceManager object to remove
the subform object that represents a page of your form.
For more information,
see Add
and remove subform instances using scripting.
|
embedDocAsDataObject
|
Yes
|
None
|
|
encryptForRecipients
|
Yes
|
None
|
|
encryptUsingPolicy
|
Yes
|
None
|
|
exportAsText
|
Yes
|
None
|
This method is only available in the JavaScript
Console of the JavaScript Debugger in Acrobat or during batch processing.
|
exportAsFDF
|
No
|
xfa.host.exportData()
|
exportData
The exportData method
exports an XML or XDP file instead of an FDF file.
|
exportAsXFDF
|
No
|
xfa.host.exportData()
|
exportData
The exportData method
exports an XML or XDP file instead of an FDF file.
|
exportDataObject
|
Yes
|
None
|
|
exportXFAData
|
No
|
xfa.host.exportData()
|
exportData
The exportData method
exports an XML or XDP file instead of an FDF file.
|
extractPages
|
No
|
None
|
|
flattenPages
|
No
|
None
|
|
getAnnot
|
Yes
|
None
|
|
getAnnots
|
Yes
|
None
|
|
getDataObjectContents
|
Yes
|
None
|
|
getField("FieldName")
|
Yes
|
xfa.resolveNode
("FieldName")
|
resolveNode
The resolveNode method accesses
the specified object in the source XML of the form.
|
getLegalWarnings
|
Yes
|
None
|
|
getLinks
|
No
|
None
|
|
getNthFieldName
|
Yes
|
You must loop through all objects with a
similar class name until you reach thenth occurrence.
|
className
See the className property.
|
getNthTemplate
|
No
|
None
|
|
getOCGs
|
Yes
|
None
|
|
getOCGOrder
|
Yes
|
None
|
|
getPageBox
|
Yes
|
None
|
|
getPageLabel
|
Yes
|
None
|
|
getPageNthWord
|
Yes
|
None
|
|
getPageNthWordQuads
|
Yes
|
None
|
|
getPageNumWords
|
Yes
|
None
|
|
getPageRotation
|
Yes
|
None
|
|
getPrintParams
|
Yes
|
None
|
|
getTemplate
|
No
|
None
|
|
getURL
|
Yes
|
xfa.host.gotoURL(
"http://www.adobe.com");
|
See the gotoURL method.
gotoURL
|
gotoNamedDest
|
No
|
None
|
|
importAnFDF
|
No
|
None
|
|
importAnXFDF
|
Yes
|
None
|
|
importDataObject
|
Yes
|
None
|
|
importIcon
|
Yes
|
None
|
|
importTextData
|
Yes
|
None
|
|
importXFAData
|
No
|
xfa.host.importData
("filename.xdp");
|
See the importData method.
importData
|
insertPages
|
No
|
None
|
|
mailDoc
|
Yes
|
None
|
|
mailForm
|
No
|
None
|
|
movePage
|
No
|
None
|
|
newPage
|
No
|
None
|
|
openDataObject
|
Yes
|
None
|
|
print
|
Yes
|
xfa.host.print();
|
See the print method.
print
|
removeDataObject
|
Yes
|
None
|
|
removeField
|
No
|
None
|
|
removeIcon
|
Yes
|
None
|
|
removeLinks
|
No
|
None
|
|
removeScript
|
Yes
|
None
|
|
removeTemplate
|
No
|
None
|
|
removeThumbnails
|
No
|
None
|
|
removeWeblinks
|
Yes
|
None
|
|
replacePages
|
No
|
None
|
|
resetForm
|
No
|
xfa.host.resetData()
or
xfa.event.reset()
|
The resetData method resets
all field values on a form to the default values. The reset method
resets all properties within the event model.
resetData
reset
|
saveAs
|
Yes
|
None
|
In Designer, the file must be saved at the
application level. These scripts are examples of saving at the application
level:
app.executeMenuItem
("SaveAs");
or
var myDoc = event.target; myDoc.saveAs();
|
spawnPageFromTemplate
|
No
|
None
|
|
setAction
|
No
|
None
|
|
setPageLabel
|
Yes
|
None
|
|
setPageRotation
|
No
|
None
|
|
setPageTabOrder
|
No
|
None
|
In Designer, select Edit > Tab Order to
set the tab order.
|
setScript
|
No
|
None
|
|
submitForm
|
Yes
|
Use one of the submit button objects in
Designer.
|
|
event object properties
|
change
|
Yes
|
xfa.event.change
|
change
See the change property.
|
targetName
|
Yes
|
xfa.event.target
|
target
See the target property.
|
field object properties
|
comb
|
No
|
None
|
|
charLimit
|
No
|
this.value.#text.maxChars
|
In forms that have a fixed layout, character
limit can be set in the Designer workspace. You can set fields on
forms whose layout expands to accommodate all data.
maxChars
|
display = display.noView
|
No
|
See Changing the presence of a form design object.
|
presence
You can also set the presence property
in the Designer workspace.
You cannot use the prePrint event
to change the presence of an object prior to printing.
|
display = display.noPrint
|
No
|
See Changing the presence of a form design object.
|
presence
You can also set the presence property
in the Designer workspace.
You cannot use the prePrint event
to change the presence of an object prior to printing.
|
defaultValue
|
No
|
None
|
Set the default field value in the Designer
workspace.
|
exportValues
|
No
|
None
|
Set the export value in the Designer workspace.
|
fillColor
|
No
|
xfa.form.Form1.
NumericField1.fillColor
|
fillColor
See the fillColor property.
|
hidden
|
No
|
this.presence = "invisible" this.
presence = "visible"
|
presence
You can also set the presence property
in the Designer workspace.
|
multiline
|
No
|
this.ui.textEdit.multiLine
= "1";
|
multiLine
See the multiLine property.
|
password
|
No
|
None
|
Designer contains a Password Field that
you can use for passwords on a form.
|
page
|
No
|
None
|
Not applicable for Designer forms.
|
print
|
No
|
this.relevant = "-print";
|
relevant
See the relevant property.
|
radiosInUnison
|
No
|
None
|
Grouped radio buttons in Designer are mutually
exclusive by default.
|
rect
|
Yes
|
You can get the height and width of a Designer
form field by using the following reference syntax:
this.h;
this.w;
Alternatively, you can retrieve the x and
y coordinates of an object using the following reference syntax:
this.x;
this.y;
|
h, x, y
See the h, w, x,
and y properties.
|
required
|
No
|
this.mandatory = "error";
or
this.validate.nullTest = "error";
|
mandatory, nullTest
See the mandatory and nullTest properties.
|
textColor
|
No
|
this.fontColor
|
fontColor
See the fontColor property.
|
textSize
|
No
|
this.font.size
|
size
See the size property.
|
textFont
|
No
|
this.font.typeface
|
typeface
See the typeface property.
|
value
|
No
|
this.rawValue
|
rawValue
See the rawValue property.
value
Designer fields have a value property;
it is not the equivalent of the Acrobat value property.
|
field object methods
|
clearItems
|
No
|
DropDownList1.clearItems();
|
clearItems
The clearItems method
only applies to Drop-down List and List Box objects in Designer.
|
deleteItemAt
|
No
|
None
|
|
getItemAt
|
No
|
None
|
|
insertItemAt
|
No
|
DropDownList1.addItem
.....)
|
addItem
See the addItem method.
|
isBoxChecked
|
No
|
if(CheckBox1.rawValue
== 1)....
|
rawValue
See the rawValue property.
|
isDefaultChecked
|
No
|
None
|
|
setAction
|
No
|
None
|
Not applicable for Designer forms.
|
setFocus
|
Yes
|
xfa.host.setFocus
("TextField1.somExpression")
|
setFocus
The setFocus method
requires that the specified object have a unique name with respect
to other objects on your form.
|
setItems
|
No
|
None
|
|
setLock
|
Yes
|
None
|
|
signatureGetModifications
|
Yes
|
None
|
|
signatureGetSeedValue
|
Yes
|
None
|
|
signatureInfo
|
Yes
|
None
|
|
signatureSetSeedValue
|
Yes
|
None
|
|
signatureSign
|
Yes
|
None
|
|
signatureValidate
|
Yes
|
None
|
|
search object method
|
search.query("<your text>");
|
Yes
|
None
|
The “..” (double period) FormCalc shortcut
syntax allows you to search for objects within the XML Form Object
Model.
For more information, see FormCalc reference syntax shortcuts.
|
SOAP object method
|
All properties and methods
|
Yes
|
None
|
|
