javascript_api_reference

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0 751

Report object properties:
search object style

security object properties:
SecurityHandler object docInfo
docText
SOAP object docXMP
bookmarks
ignoreAsianCharacterWidth
jpegExif
legacySearch
markup
matchWholeWord
wordMatching

methods:
chooseRecipientsDialog
getSecurityPolicies
importFromFile

properties:
digitalIDs
directories
directoryHandlers
signAuthor
signFDF

methods:
newDirectory

properties:
wireDump

methods:
connect
request
response
streamDecode
streamEncode
streamFromString
stringFromStream

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0 752

Span object properties:
alignment
spell object fontFamily
fontStretch
Thermometer object fontStyle
fontWeight
util object text
textColor
textSize
strikethrough
subscript
superscript
underline

properties:
languages
languageOrder

methods:
customDictionaryClose
customDictionaryCreate
customDictionaryExport
customDictionaryOpen
ignoreAll

properties:
cancelled
duration
value
text

methods:
begin
end

methods:
printd
spansToXML
xmlToSpans

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Modified in Acrobat 6.0 753

Modified in Acrobat 6.0

Changed or enhanced objects, methods, and properties
The following properties and methods were changed or enhanced:

app object methods:
Doc object addMenuItem
alert
event object listMenuItems
Field object listToolbarButtons
global object response

properties:
layout
zoomType

methods:
createDataObject
exportAsFDF
exportAsXFDF
exportDataObject
flattenPages
getField (see Extended Methods)
getURL
importDataObject
importIcon
print
saveAs
spawnPageFromTemplate
submitForm

properties:
changeEx

properties:
name

methods:
buttonImportIcon
signatureInfo
signatureSign
signatureValidate

Persistent global data only applies to variables of type Boolean,
Number or String. Acrobat 6.0 has reduced the maximum size of global
persistent variables from 32 KB to 2-4 KB. Any data added to the string
after this limit is dropped.

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Deprecated in Acrobat 6.0 754

search object methods:
SecurityHandler object query

Templatet object The following were introduced in Acrobat 5.0 as properties and
methods of the PPKLite Signature Handler Object. In Acrobat 6.0, they
are properties and methods of the SecurityHandler object. All of
these have new descriptions, and some have additional parameters.

Note: When signing using JavaScript methods, the user’s digital
signature profile must be a .pfx file, not an .apf, as in earlier
versions of Acrobat. To convert an .apf profile to the new .pfx
type, use the UI (click Advanced > Manage Digital IDs > My
Digital ID Files > Select My Digital ID File) to import the .apf
profile.

properties:
appearances
isLoggedIn
loginName
loginPath
name
signInvisible
signVisible
uiName

methods:
login
logout
newUser
setPasswordTimeout

methods:
spawn

Extended Methods

The Document.getField method was extended in Acrobat 6.0 so that it retrieves the Field object of
individual widgets. See the Field object for a discussion of widgets and how to work with them.

Deprecated in Acrobat 6.0

search object properties:
spell object soundex
thesaurus

methods:
addDictionary
removeDictionary

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 755

Introduced in Acrobat 6.0.2

The following objects, properties and methods were introduced in Acrobat 6.0.2:

XFA object

The following table lists the objects, properties and methods of the Multimedia plug-in. In Acrobat 6.0.2,
multimedia JavaScript was documented in a separate document called the “Acrobat Multimedia
JavaScript Reference”.

app object properties:
app.media object media
monitors

properties:
align
canResize
closeReason
defaultVisible
ifOffScreen
layout
monitorType
openCode
over
pageEventNames
raiseCode
raiseSystem
renditionType
status
trace
version
windowType

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 756

app.media object methods:
(Continued) addStockEvents
alertFileNotFound
Doc object alertSelectFailed
Doc.media object argsDWIM
canPlayOrAlert
event object computeFloatWinRect
constrainRectToScreen
createPlayer
getAltTextData
getAltTextSettings
getAnnotStockEvents
getAnnotTraceEvents
getPlayers
getPlayerStockEvents
getPlayerTraceEvents
getRenditionSettings
getURLData
getURLSettings
getWindowBorderSize
openPlayer
removeStockEvents
startPlayer

properties:
innerAppWindowRect
innerDocWindowRect
media
outerAppWindowRect
outerDocWindowRect
pageWindowRect

properties:
canPlay

methods:
deleteRendition
getAnnot
getAnnots
getRendition
newPlayer

A new Screen type used with Multimedia along with associated event
names.

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 757

Events object methods:
EventListener object add
dispatch
Marker object remove

methods:
afterBlur
afterClose
afterDestroy
afterDone
afterError
afterEscape
afterEveryEvent
afterFocus
afterPause
afterPlay
afterReady
afterScript
afterSeek
afterStatus
afterStop
onBlur
onClose
onDestroy
onDone
onError
onEscape
onEveryEvent
onFocus
onGetRect
onPause
onPlay
onReady
onScript
onSeek
onStatus
onStop

properties:
frame
index
name
time

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 758

Markers object properties:
MediaOffset object player
MediaPlayer object
methods:
MediaReject object get
MediaSelection object
properties:
frame
marker
time

properties:
annot
defaultSize
doc
events
hasFocus
id
innerRect
iisOpen
isPlaying
markers
outerRect
page
settings
uiSize
visible

methods:
close
open
pause
play
seek
setFocus
stop
triggerGetRect
where

properties:
rendition

properties:
selectContext
players
rejects
rendition

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 759

MediaSettings object properties:
autoPlay
Monitor object baseURL
Monitors object bgColor
bgOpacity
endAt
floating
duration
floating
layout
monitor
monitorType
page
palindrome
players
rate
repeat
showUI
startAt
visible
volume
windowType

properties:
colorDepth
isPrimary
rect
workRect

methods:
bestColor
bestFit
desktop
document
filter
largest
leastOverlap
mostOverlap
nonDocument
primary
secondary
select
tallest
widest

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 6.0.2 760

PlayerInfo object properties:
id
PlayerInfoList object mimeTypes
Rendition object name
version
ScreenAnnot object
methods:
canPlay
canUseData

methods:
select

properties:
altText
doc
fileName
type
uiName

methods:
getPlaySettings
select
testCriteria

properties:
altText
alwaysShowFocus
display
doc
events
extFocusRect
innerDeviceRect
noTrigger
outerDeviceRect
page
player
rect

methods:
hasFocus
setFocus

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Acrobat 5.0 changes 761

Acrobat 5.0 changes

Introduced in Acrobat 5.0

ADBC object methods:
Annotation object getDataSourceList
newConnection

properties:
alignment
AP
arrowBegin
arrowEnd
author
contents
doc
fillColor
hidden
modDate
name
noView
page
point
points
popupRect
print
rect
readOnly
rotate
strokeColor
textFont
type
soundIcon
width

methods:
destroy
getProps
setProps

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 762

app object properties:
activeDocs
Bookmark object fs
plugIns
color object viewerVariation
Connection object
methods:
addMenuItem
addSubMenu
clearInterval
clearTimeOut
listMenuItems
listToolbarButtons
newDoc
openDoc
popUpMenu
setInterval
setTimeOut

properties:
children
color
doc
name
open
parent
style

methods:
createChild
execute
insertChild
remove

methods:
convert
equal

methods:
getColumnList
getTableList
console

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 763

Data object properties:
creationDate
Doc object modDate
MIMEType
name
path
size

properties:
bookmarkRoot
disclosed (5.0.5)
icons
info
layout
securityHandler
selectedAnnots
sounds
templates
URL

methods:
addAnnot
addField
addIcon
addThumbnails
addWeblinks
bringToFront
closeDoc
createDataObject
createTemplate
deletePages
deleteSound
exportAsXFDF
exportDataObject
extractPages
flattenPages
getAnnot
getAnnots
getDataObject
getIcon
getPageBox
getPageLabel
getPageNthWord
getPageNthWordQuads
getPageRotation
getPageTransition

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 764

Doc object getSound
(Continued) importAnXFDF
importDataObject
event object importIcon
Field object importSound
importTextData
insertPages
movePage
print
removeDataObject
removeField
removeIcon
removeTemplate
removeThumbnails
removeWeblinks
replacePages
saveAs
selectPageNthWord
setPageBoxes
setPageLabels
setPageRotations
setPageTransitions
submitForm
syncAnnotScan

properties:
changeEx
keyDown
targetName

properties:
buttonAlignX
buttonAlignY
buttonPosition
buttonScaleHow
buttonScaleWhen
currentValueIndices
doNotScroll
doNotSpellCheck
exportValues
fileSelect
multipleSelection
rect
strokeColor
submitName
valueAsString

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 765

Field object methods:
(Continued) browseForFileToSubmit
buttonGetCaption
FullScreen object buttonGetIcon
buttonSetCaption
global object buttonSetIcon
identity object checkThisBox
Index object defaultIsChecked
isBoxChecked
isDefaultChecked
setAction
signatureInfo
signatureSign
signatureValidate

properties:
backgroundColor
clickAdvances
cursor
defaultTransition
escapeExits
isFullScreen
loop
timeDelay
transitions
usePageTiming
useTimer

methods:
subscribe

properties:
corporation
email
loginName
name

properties:
available
name
path
selected

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 766

PlayerInfo object properties:
PPKLite Signature Handler certified
Object (now listed under the loaded
SecurityHandler object) name
path
Report object version

search object properties:
appearances
isLoggedIn
loginName
loginPath
name
signInvisible
signVisible
uiName

methods:
login
logout
newUser
setPasswordTimeout

properties:
absIndent
color
absIndent

methods:
breakPage
divide
indent
outdent
open
mail
writeText
save
writeText

properties:
available
indexes
markup
maxDocs
proximity
refine
soundex
stem

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Introduced in Acrobat 5.0 767

search object methods:
(Continued) addIndex
security object getIndexForPath
spell object query
removeIndex
Statement object
properties:
Template object handlers
validateSignaturesOnOpen

methods:
getHandler

properties:
available
dictionaryNames
dictionaryOrder
domainNamess

methods:
addDictionary
addWord
check
checkText
checkWord
removeDictionary
removeWord
userWords

properties:
columnCount
rowCount

methods:
execute
getColumn
getColumnArray
getRow
nextRow

properties:
hidden
name

methods:
spawn

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Modified in Acrobat 5.0 768

Modified in Acrobat 5.0

The console can act as an editor and can execute JavaScript code.

The following properties and methods have been changed or enhanced:

app object language
Doc object execMenuItem
exportAsFDF
event object print
Field object submitForm
type
util object textFont
value
buttonImportIcon
getItemAt
printd

The section related to event object has been greatly enhanced to facilitate better understanding of the
Acrobat JavaScript Event model.

Deprecated in Acrobat 5.0

The following properties and methods have been deprecated:

app object fullscreen
Doc object numPlugIns
getNthPlugInName
Field object author
TTS object creationDate
creationDate
keywords
modDate
numTemplates
producer
title
getNthTemplate
spawnPageFromTemplate
hidden
soundCues
speechCues

Adobe Acrobat SDK New Features and Changes
JavaScript for Acrobat API Reference Modified in Acrobat 5.05 769

Modified in Acrobat 5.05

● A new symbol was added to the quick bar denoting which methods are missing from Acrobat
Approval.

● In the Doc object, the property disclosed was added.

Modified in Adobe Reader 5.1

Access to the following properties and methods was changed for the Adobe 5.1 Reader:

Annotation properties: modDate rect
object alignment name readOnly
AP noView rotate
Doc arrowBegin page strokeColor
object arrowEnd point textFont
author points type
Template contents popupRect soundIcon
object doc print width
fillColor
hidden importAnXFDF
importDataObject
methods: mailDoc
destroy mailForm
getProps spawnPageFromTemplate
setProps submitForm
syncAnnotScan
properties:
selectedAnnots

methods:
addAnnot
addField
exportAsFDF
exportAsXFDF
getAnnot
getAnnots
getNthTemplate
importAnFDF

methods:
spawn