Acrobat and PDFL Developer Guides
Acrobat-PDFL SDK: JavaScript Reference
Acrobat JavaScript API Reference
Version compatibility
Overview
Syntax
Method arguments
Parameter help
Paths
Safe path
Privileged context
Privileged versus non-privileged context
User preferences
Table quick key
Domain names in code samples
Changes Across Versions
Acrobat XI changes
Changes to PrintParams object
Acrobat X changes
New JavaScript version
Impact of Acrobat menu restructuring on JavaScript APIs
New util method
Changes to search object
Changes to SearchExecuteQuery
Function SearchIsLegacySearchAvailable deprecated
Enhancements to PDFOptPDFVersion
Enhancements to Doc object
Enhancements to the getDataObjectContents method
Enhancements to the SaveAs Method
New timestampSign and certifyInvisibleSign Doc methods
Signature support for Emerging PAdES ETSI ESI standard
Adding an invisible timestamp
Adding an invisible Certification
ADBC Support Removed from Documentation
Acrobat 9.0 changes
Acrobat 8.1 changes
Acrobat 8.0 changes
Acrobat 7.0.5 changes
Acrobat 7.0 changes
Introduced in Acrobat 7.0
Modified in Acrobat 7.0
Acrobat 6.0 changes
Introduced in Acrobat 6.0
Modified in Acrobat 6.0
Deprecated in Acrobat 6.0
Introduced in Acrobat 6.0.2
Acrobat 5.0 changes
Introduced in Acrobat 5.0
Modified in Acrobat 5.0
Deprecated in Acrobat 5.0
Modified in Acrobat 5.05
Modified in Adobe Reader 5.1
JavaScript APIs
Alerter
Alerter methods
dispatch
AlternatePresentation
AlternatePresentation properties
active
type
AlternatePresentation methods
start
stop
annotAttachment
annotAttachment properties
contentStream
creationDate
MIMEtype
modDate
name
pathname
size
Annotation
Annotation types
Annotation properties
alignment
attachment
AP
arrowBegin
arrowEnd
attachIcon
author
borderEffectIntensity
borderEffectStyle
callout
cAttachmentPath
caretSymbol
contents
creationDate
dash
delay
doc
doCaption
fillColor
gestures
hidden
inReplyTo
intent
leaderExtend
leaderLength
lineEnding
lock
modDate
name
noteIcon
noView
opacity
overlayText
page
point
points
popupOpen
popupRect
print
quads
rect
readOnly
refType
repeat
richContents
richDefaults
rotate
seqNum
soundIcon
state
stateModel
strokeColor
style
subject
textFont
textSize
toggleNoView
type
vertices
width
Annotation methods
destroy
getProps
getStateInModel
setProps
transitionToState
AnnotRichMedia
AnnotRichMedia properties
activated
context3D
name
page
rect
subtype
AnnotRichMedia methods
callAS
Annot3D
Annot3D properties
activated
context3D
innerRect
name
page
rect
app
app properties
activeDocs
calculate
constants
focusRect
formsVersion
fromPDFConverters
fs
fullscreen
language
media
monitors
numPlugIns
openInPlace
platform
plugIns
printColorProfiles
printerNames
runtimeHighlight
runtimeHighlightColor
thermometer
toolbar
toolbarHorizontal
toolbarVertical
viewerType
viewerVariation
viewerVersion
app methods
addMenuItem
addSubMenu
addToolButton
alert
beep
beginPriv
browseForDoc
clearInterval
clearTimeOut
endPriv
execDialog
execMenuItem
getNthPlugInName
getPath
goBack
goForward
hideMenuItem
hideToolbarButton
launchURL
listMenuItems
listToolbarButtons
loadPolicyFile
mailGetAddrs
mailMsg
newDoc
newCollection
newFDF
openDoc
openFDF
popUpMenu
popUpMenuEx
removeToolButton
response
setInterval
setTimeOut
trustedFunction
trustPropagatorFunction
app.media
app.media properties
align
canResize
closeReason
defaultVisible
ifOffScreen
layout
monitorType
openCode
over
pageEventNames
raiseCode
raiseSystem
renditionType
status
trace
version
windowType
app.media methods
addStockEvents
alertFileNotFound
alertSelectFailed
argsDWIM
canPlayOrAlert
computeFloatWinRect
constrainRectToScreen
createPlayer
getAltTextData
getAltTextSettings
getAnnotStockEvents
getAnnotTraceEvents
getPlayers
getPlayerStockEvents
getPlayerTraceEvents
getRenditionSettings
getURLData
getURLSettings
getWindowBorderSize
openPlayer
removeStockEvents
startPlayer
Bookmark
Bookmark properties
children
color
doc
name
open
parent
style
Bookmark methods
createChild
execute
insertChild
remove
setAction
catalog
catalog properties
isIdle
jobs
catalog methods
getIndex
remove
CatalogJob
CatalogJob properties
path
type
status
Certificate
Certificate properties
binary
issuerDN
keyUsage
MD5Hash
privateKeyValidityEnd
privateKeyValidityStart
SHA1Hash
serialNumber
subjectCN
subjectDN
ubRights
usage
validityEnd
validityStart
Collab
Collab methods
addStateModel
documentToStream
removeStateModel
color
Color arrays
color properties
color methods
convert
equal
colorConvertAction
colorConvertAction properties
action
alias
colorantName
convertIntent
convertProfile
embed
isProcessColor
matchAttributesAll
matchAttributesAny
matchIntent
matchSpaceTypeAll
matchSpaceTypeAny
preserveBlack
useBlackPointCompensation
Collection
Collection properties
fields
initialDoc
initialView
Collection methods
addField
getField
removeField
collectionField
collectionField properties
name
order
readOnly
sort
text
type
Column
Column properties
columnNum
name
type
typeName
value
ColumnInfo
ColumnInfo properties
name
description
type
typeName
console
console methods
clear
hide
println
show
Data
Data properties
creationDate
description
MIMEType
modDate
name
path
size
Data methods
getFieldValue
setFieldValue
DataSourceInfo
DataSourceInfo properties
name
description
dbg
dbg properties
bps
dbg methods
c
cb
q
sb
si
sn
so
sv
Dialog
Dialog methods
enable
end
load
store
DirConnection
DirConnection properties
canList
canDoCustomSearch
canDoCustomUISearch
canDoStandardSearch
groups
name
uiName
DirConnection methods
search
setOutputFields
Directory
Directory properties
info
Directory methods
connect
Embedded PDF
Embedded PDF properties
messageHandler
Embedded PDF methods
postMessage
Error
Error properties
fileName
lineNumber
extMessage
message
name
Error methods
toString
event
Event type/name combinations
App/Init
Batch/Exec
Bookmark/Mouse Up
Console/Exec
Doc/DidPrint
Doc/DidSave
Doc/Open
Doc/WillClose
Doc/WillPrint
Doc/WillSave
External/Exec
Field/Blur
Field/Calculate
Field/Focus
Field/Format
Field/Keystroke
Field/Mouse Down
Field/Mouse Enter
Field/Mouse Exit
Field/Mouse Up
Field/Validate
Link/Mouse Up
Menu/Exec
Page/Open
Page/Close
Screen/Blur
Screen/Close
Screen/Focus
Screen/InView
Screen/Mouse Down
Screen/Mouse Enter
Screen/Mouse Exit
Screen/Mouse Up
Screen/Open
Screen/OutView
Document Event Processing
Form event processing
Multimedia event processing
event properties
change
changeEx
commitKey
fieldFull
keyDown
modifier
name
rc
richChange
richChangeEx
richValue
selEnd
selStart
shift
source
target
targetName
type
value
willCommit
EventListener
EventListener methods
afterBlur
afterClose
afterDestroy
afterDone
afterError
afterEscape
afterEveryEvent
afterFocus
afterPause
afterPlay
afterReady
afterScript
afterSeek
afterStatus
afterStop
onBlur
onClose
onDestroy
onDone
onError
onEveryEvent
onGetRect
onPause
onPlay
onReady
onScript
onSeek
onStatus
onStop
Events
Events methods
add
dispatch
remove
FDF
FDF properties
deleteOption
isSigned
numEmbeddedFiles
FDF methods
addContact
addEmbeddedFile
addRequest
close
mail
save
signatureClear
signatureSign
signatureValidate
Field
Field versus widget attributes
Field properties
alignment
buttonAlignX
buttonAlignY
buttonFitBounds
buttonPosition
buttonScaleHow
buttonScaleWhen
calcOrderIndex
charLimit
comb
commitOnSelChange
currentValueIndices
defaultStyle
defaultValue
doNotScroll
doNotSpellCheck
delay
display
doc
editable
exportValues
fileSelect
fillColor
hidden
highlight
multiline
multipleSelection
name
numItems
page
password
print
radiosInUnison
readonly
rect
required
richText
richValue
rotation
strokeColor
style
submitName
textColor
textFont
textSize
type
userName
value
valueAsString
Field methods
browseForFileToSubmit
buttonGetCaption
buttonGetIcon
buttonImportIcon
buttonSetCaption
buttonSetIcon
checkThisBox
clearItems
defaultIsChecked
deleteItemAt
getArray
getItemAt
getLock
insertItemAt
isBoxChecked
isDefaultChecked
setAction
setFocus
setItems
setLock
signatureGetModifications
signatureGetSeedValue
signatureInfo
signatureSetSeedValue
signatureSign
signatureValidate
FullScreen
FullScreen properties
backgroundColor
clickAdvances
cursor
defaultTransition
escapeExits
isFullScreen
loop
timeDelay
transitions
usePageTiming
useTimer
global
Creating global properties
Deleting global properties
Global object security policy
global methods
setPersistent
subscribe
HostContainer
HostContainer properties
messageHandler
HostContainer methods
postMessage
Icon
Icon Stream
identity
identity properties
corporation
email
loginName
name
Index
Index properties
available
name
path
selected
Index methods
build
Link
Link properties
borderColor
borderWidth
highlightMode
rect
Link methods
setAction
Monitor
Monitor properties
colorDepth
isPrimary
rect
workRect
Monitors
Monitors methods
bestColor
bestFit
desktop
document
filter
largest
leastOverlap
mostOverlap
nonDocument
primary
secondary
select
tallest
widest
Net
Net properties
SOAP
Discovery
HTTP
Net methods
Net.HTTP
Net.HTTP methods
request
OCG
OCG properties
constants
initState
locked
name
state
OCG methods
getIntent
setAction
setIntent
PlayerInfo properties
id
mimeTypes
name
version
PlayerInfo methods
canPlay
canUseData
honors
PlayerInfoList
PlayerInfoList methods
select
PlugIn
PlugIn properties
certified
loaded
name
path
version
PrintParams
PrintParams properties
binaryOK
bitmapDPI
booklet
colorProfile
constants
downloadFarEastFonts
DuplexType
fileName
firstPage
flags
fontPolicy
gradientDPI
interactive
lastPage
nUpAutoRotate
nUpNumPagesH
nUpNumPagesV
nUpPageBorder
nUpPageOrder
NumCopies
pageHandling
pageSubset
printAsImage
printContent
printRange
printerName
psLevel
rasterFlags
reversePages
tileLabel
tileMark
tileOverlap
tileScale
transparencyLevel
usePrinterCRD
useT1Conversion
RDN
ReadStream
Rendition
Rendition properties
altText
doc
fileName
type
uiName
Rendition methods
getPlaySettings
select
testCriteria
Report
Report properties
absIndent
color
size
style
Report methods
breakPage
divide
indent
mail
open
outdent
Report
save
writeText
Row
ScreenAnnot
ScreenAnnot properties
altText
alwaysShowFocus
display
doc
events
extFocusRect
innerDeviceRect
noTrigger
outerDeviceRect
page
player
rect
ScreenAnnot methods
hasFocus
setFocus
search
search properties
attachments
available
bookmarks
docInfo
docText
docXMP
ignoreAccents
ignoreAsianCharacterWidth
indexes
jpegExif
legacySearch
markup
matchCase
matchWholeWord
maxDocs
objectMetadata
proximity
proximityRange
refine
stem
wordMatching
search methods
addIndex
getIndexForPath
query
removeIndex
security
security constants
security properties
handlers
validateSignaturesOnOpen
security methods
chooseRecipientsDialog
chooseSecurityPolicy
exportToFile
getHandler
getSecurityPolicies
importFromFile
importSettings
SecurityHandler
SecurityHandler properties
appearances
digitalIDs
directories
directoryHandlers
docDecrypt
docEncrypt
isLoggedIn
loginName
loginPath
name
signAuthor
signFDF
signInvisible
signValidate
signVisible
uiName
validateFDF
SecurityHandler methods
login
logout
newDirectory
newUser
setPasswordTimeout
SecurityPolicy
SecurityPolicy properties
SignatureInfo
SignatureInfo properties
SignatureInfo object public key security handler properties
status and idValidity properties
Validity Values
Private Validity Values
Modification Detection and Prevention (MDP) Values
SOAP
SOAP properties
wireDump
SOAP methods
connect
queryServices
resolveService
oResult parameter
request
response
streamDecode
streamDigest
streamEncode
streamFromString
stringFromStream
Sound
Sound properties
name
Sound methods
pause
play
stop
Span
Span properties
alignment
fontFamily
fontStretch
fontStyle
fontWeight
strikethrough
subscript
superscript
text
textColor
textSize
underline
spell
spell properties
available
dictionaryNames
dictionaryOrder
domainNames
languages
languageOrder
spell methods
addDictionary
addWord
check
checkText
checkWord
customDictionaryClose
customDictionaryCreate
customDictionaryDelete
customDictionaryExport
customDictionaryOpen
ignoreAll
removeDictionary
removeWord
userWords
TableInfo
Template
Template properties
hidden
name
Template methods
spawn
Thermometer
Thermometer properties
cancelled
duration
text
value
Thermometer methods
begin
end
this
TTS
TTS properties
available
numSpeakers
pitch
soundCues
speaker
speechCues
speechRate
volume
TTS methods
getNthSpeakerName
pause
qSilence
qSound
qText
reset
resume
stop
talk
util
util methods
crackURL
iconStreamFromIcon
printd
printf
printx
readFileIntoStream
scand
spansToXML
streamFromString
stringFromStream
xmlToSpans
XFA
XMLData
XMLData methods
applyXPath
parse
Doc and Doc.Media APIs
Doc
Doc properties
alternatePresentations
author
baseURL
bookmarkRoot
calculate
collection
creationDate
creator
dataObjects
delay
dirty
disclosed
docID
documentFileName
dynamicXFAForm
external
filesize
hidden
hostContainer
icons
info
innerAppWindowRect
innerDocWindowRect
isModal
keywords
layout
media
metadata
modDate
mouseX
mouseY
noautocomplete
numFields
numPages
numTemplates
path
outerAppWindowRect
outerDocWindowRect
pageNum
pageWindowRect
permStatusReady
producer
requiresFullSave
securityHandler
selectedAnnots
sounds
spellDictionaryOrder
spellLanguageOrder
subject
templates
title
URL
viewState
xfa
XFAForeground
zoom
zoomType
Doc methods
addAnnot
addField
addIcon
addLink
addRecipientListCryptFilter
addRequirement
addScript
addThumbnails
addWatermarkFromFile
addWatermarkFromText
addWeblinks
applyRedactions
bringToFront
calculateNow
certifyInvisibleSign
closeDoc
colorConvertPage
createDataObject
createTemplate
deletePages
deleteSound
embedDocAsDataObject
embedOutputIntent
encryptForRecipients
encryptUsingPolicy
exportAsFDF
exportAsFDFStr
exportAsText
exportAsXFDF
exportAsXFDFStr
exportDataObject
exportXFAData
extractPages
flattenPages
getAnnot
getAnnotRichMedia
getAnnot3D
getAnnots
getAnnotsRichMedia
getAnnots3D
getColorConvertAction
getDataObject
getDataObjectContents
getField
getIcon
getLegalWarnings
getLinks
getNthFieldName
getNthTemplate
getOCGs
getOCGOrder
getPageBox
getPageLabel
getPageNthWord
getPageNthWordQuads
getPageNumWords
getPageRotation
getPageTransition
getPreflightAuditTrail
getPrintParams
getSound
getTemplate
getURL
getUserUnitSize
gotoNamedDest
importAnFDF
importAnXFDF
importDataObject
importIcon
importSound
importTextData
importXFAData
mailDoc
mailForm
movePage
newPage
openDataObject
preflight
print
removeDataObject
removeField
removeIcon
removeLinks
removePreflightAuditTrail
removeRequirement
removeScript
removeThumbnails
removeWeblinks
replacePages
resetForm
saveAs
scroll
selectPageNthWord
setAction
setDataObjectContents
setOCGOrder
setPageAction
setPageBoxes
setPageLabels
setPageRotations
setPageTabOrder
setPageTransitions
spawnPageFromTemplate
submitForm
syncAnnotScan
timestampSign
validatePreflightAuditTrail
Doc.media
Doc.media properties
canPlay
Doc.media methods
deleteRendition
getAnnot
getAnnots
getOpenPlayers
getRendition
newPlayer
Preflight APIs
Preflight
Preflight methods
createComplianceProfile
getNthProfile
getNumProfiles
getProfileByName
getProfileByFingerPrint
PreflightAuditTrail
PreflightAuditTrail properties
preflight_executed_date
preflight_results
preflight_results_description
profile_creator
profile_creator_version
profile_fingerprint
profile_format_version
profile_name
PreflightProfile
PreflightProfile properties
name
description
hasFixups
hasChecks
PreflightProfile methods
hasConversion
PreflightResult
PreflightResult properties
numErrors
numWarnings
numInfos
numFixed
numNotFixed
PreflightResult methods
report
Media and Marker APIs
Marker
Marker properties
frame
index
name
time
Markers
Markers properties
player
Markers methods
get
MediaOffset
MediaOffset properties
frame
marker
time
MediaPlayer
MediaPlayer properties
annot
defaultSize
doc
events
hasFocus
id
innerRect
isOpen
isPlaying
markers
outerRect
page
settings
uiSize
visible
MediaPlayer methods
close
open
pause
play
seek
setFocus
stop
triggerGetRect
where
MediaReject
MediaReject properties
rendition
MediaSelection
MediaSelection properties
selectContext
players
rejects
rendition
MediaSettings
MediaSettings properties
autoPlay
baseURL
bgColor
bgOpacity
data
duration
endAt
floating
layout
monitor
monitorType
page
palindrome
players
rate
repeat
showUI
startAt
visible
volume
windowType
Master Doc Search and TOC
Acrobat Developer Home
Document Services SDK
Acrobat Sign SDK
Acrobat SDK
PDF Library SDK
Console
Acrobat-PDFL SDK: JavaScript Reference
»
Search
Please activate JavaScript to enable the search functionality.
