bbc
JavaScript
for Acrobat
®
API Reference
Adobe
®
Acrobat
®
SDK
8.0
© 2006 Adobe Systems Incorporated. All rights reserved.
Adobe
®
Acrobat
®
SDK 8.0 JavaScript for Acrobat API Reference Microsoft
®
Windows
®
Macintosh
®
Edition 1.0 2006 10
Adobe
Systems Incorporated
Adobe Adobe Acrobat Distiller FrameMaker LiveCycle PostScript Reader
Apple Mac OS Apple Inc.
JavaScript Sun Microsystems, Inc.
Microsoft Windows Microsoft Corporation
Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.
Notice to U.S. Government End Users.The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. 2.101,
consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R.
12.212 or 48 C.F.R. 227.7202, as applicable.Consistent with 48 C.F.R. 12.212 or 48 C.F.R. 227.7202-1 through 227.7202-4, as applicable,
the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only
as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions
herein.Unpublished-rights reserved under the copyright laws of the United States.Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA
95110-2704, USA.For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the
provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212),
and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The
affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.
3
........................................................................................................................................ 28
.................................................................................................................................. 28
........................................................................................................................................................ 28
......................................................................................................................................... 28
1 ............................................................................................................................................... 30
............................................................................................................................................................... 30
............................................................................................................................................................... 31
.................................................................................................................................................... 31
.............................................................................................. 31
.................. 32
............................................................................................................................................. 32
................................................................................................................................................ 32
.................................................................................................. 34
2 JavaScript API ............................................................................................................................. 35
ADBC ............................................................................................................................................................ 36
ADBC ................................................................................................................................ 36
SQL ................................................................................................................................................ 36
JavaScript ...................................................................................................................................... 37
ADBC .................................................................................................................................... 38
getDataSourceList .............................................................................................................................. 38
newConnection ................................................................................................................................... 38
Alerter ........................................................................................................................................................... 40
Alerter ................................................................................................................................... 40
dispatch .............................................................................................................................................. 40
AlternatePresentation ................................................................................................................................... 43
AlternatePresentation ........................................................................................................ 43
active .................................................................................................................................................. 43
type ..................................................................................................................................................... 43
AlternatePresentation ........................................................................................................... 44
start ..................................................................................................................................................... 44
stop ..................................................................................................................................................... 44
Annotation ..................................................................................................................................................... 45
............................................................................................................................................... 45
Annotation ......................................................................................................................... 47
alignment ............................................................................................................................................ 47
AP ....................................................................................................................................................... 48
arrowBegin ......................................................................................................................................... 49
arrowEnd ............................................................................................................................................ 50
attachIcon ........................................................................................................................................... 50
author ................................................................................................................................................. 51
borderEffectIntensity ........................................................................................................................... 51
borderEffectStyle ................................................................................................................................ 52
callout ................................................................................................................................................. 52
caretSymbol ........................................................................................................................................ 52
Adobe Acrobat SDK
JavaScript for Acrobat API Reference 4
2 JavaScript API
Annotation
Annotation
contents .............................................................................................................................................. 53
creationDate ....................................................................................................................................... 53
dash .................................................................................................................................................... 54
delay ................................................................................................................................................... 54
doc ...................................................................................................................................................... 55
doCaption ........................................................................................................................................... 56
fillColor ................................................................................................................................................ 56
gestures .............................................................................................................................................. 57
hidden ................................................................................................................................................. 57
inReplyTo ........................................................................................................................................... 58
intent ................................................................................................................................................... 58
leaderExtend ...................................................................................................................................... 59
leaderLength ....................................................................................................................................... 59
lineEnding ........................................................................................................................................... 60
lock ..................................................................................................................................................... 60
modDate ............................................................................................................................................. 61
name ................................................................................................................................................... 61
noteIcon .............................................................................................................................................. 62
noView ................................................................................................................................................ 63
opacity ................................................................................................................................................ 63
page .................................................................................................................................................... 64
point .................................................................................................................................................... 64
points .................................................................................................................................................. 65
popupOpen ......................................................................................................................................... 66
popupRect .......................................................................................................................................... 66
print ..................................................................................................................................................... 67
quads .................................................................................................................................................. 67
rect ...................................................................................................................................................... 68
readOnly ............................................................................................................................................. 68
refType ............................................................................................................................................... 68
richContents ....................................................................................................................................... 69
richDefaults ......................................................................................................................................... 70
rotate .................................................................................................................................................. 70
seqNum .............................................................................................................................................. 71
soundIcon ........................................................................................................................................... 71
state .................................................................................................................................................... 72
stateModel .......................................................................................................................................... 72
strokeColor ......................................................................................................................................... 72
style .................................................................................................................................................... 73
subject ................................................................................................................................................ 73
textFont ............................................................................................................................................... 74
textSize ............................................................................................................................................... 75
toggleNoView ..................................................................................................................................... 75
type ..................................................................................................................................................... 76
vertices ............................................................................................................................................... 76
width ................................................................................................................................................... 77
Adobe Acrobat SDK
JavaScript for Acrobat API Reference 5
2 JavaScript API
Annotation
Annotation ............................................................................................................................. 77
destroy ................................................................................................................................................ 77
getProps ............................................................................................................................................. 78
getStateInModel ................................................................................................................................. 79
setProps ............................................................................................................................................. 79
transitionToState ................................................................................................................................ 80
Annot3D ........................................................................................................................................................ 82
Annot3D ............................................................................................................................ 82
activated ............................................................................................................................................. 82
context3D ........................................................................................................................................... 82
innerRect ............................................................................................................................................ 83
name ................................................................................................................................................... 83
page .................................................................................................................................................... 83
rect ...................................................................................................................................................... 84
app ................................................................................................................................................................ 85
app .................................................................................................................................... 85
activeDocs .......................................................................................................................................... 85
calculate ............................................................................................................................................. 86
constants ............................................................................................................................................ 86
focusRect ............................................................................................................................................ 87
formsVersion ...................................................................................................................................... 87
fromPDFConverters ............................................................................................................................ 88
fs ......................................................................................................................................................... 88
fullscreen ............................................................................................................................................ 89
language ............................................................................................................................................. 89
media .................................................................................................................................................. 90
monitors .............................................................................................................................................. 90
numPlugIns ......................................................................................................................................... 91
openInPlace ........................................................................................................................................ 91
platform ............................................................................................................................................... 92
plugIns ................................................................................................................................................ 92
printColorProfiles ................................................................................................................................ 93
printerNames ...................................................................................................................................... 93
runtimeHighlight .................................................................................................................................. 94
runtimeHighlightColor ......................................................................................................................... 94
thermometer ....................................................................................................................................... 94
toolbar ................................................................................................................................................. 95
toolbarHorizontal ................................................................................................................................ 95
toolbarVertical ..................................................................................................................................... 96
viewerType ......................................................................................................................................... 96
viewerVariation ................................................................................................................................... 97
viewerVersion ..................................................................................................................................... 97
app ........................................................................................................................................ 97
addMenuItem ...................................................................................................................................... 97
addSubMenu ...................................................................................................................................... 99
addToolButton .................................................................................................................................. 100
alert ................................................................................................................................................... 101
beep .................................................................................................................................................. 103
beginPriv ........................................................................................................................................... 104
Adobe Acrobat SDK
JavaScript for Acrobat API Reference 6
2 JavaScript API
app
app
browseForDoc .................................................................................................................................. 104
clearInterval ...................................................................................................................................... 106
clearTimeOut .................................................................................................................................... 106
endPriv ............................................................................................................................................. 106
execDialog ........................................................................................................................................ 107
execMenuItem .................................................................................................................................. 120
getNthPlugInName ........................................................................................................................... 122
getPath ............................................................................................................................................. 122
goBack .............................................................................................................................................. 123
goForward ........................................................................................................................................ 123
hideMenuItem ................................................................................................................................... 124
hideToolbarButton ............................................................................................................................ 124
launchURL ........................................................................................................................................ 124
listMenuItems ................................................................................................................................... 125
listToolbarButtons ............................................................................................................................. 126
mailGetAddrs .................................................................................................................................... 127
mailMsg ............................................................................................................................................ 128
newDoc ............................................................................................................................................. 129
newFDF ............................................................................................................................................ 130
openDoc ........................................................................................................................................... 131
openFDF ........................................................................................................................................... 133
popUpMenu ...................................................................................................................................... 134
popUpMenuEx .................................................................................................................................. 135
removeToolButton ............................................................................................................................ 136
response ........................................................................................................................................... 137
setInterval ......................................................................................................................................... 138
setTimeOut ....................................................................................................................................... 139
trustedFunction ................................................................................................................................. 140
trustPropagatorFunction ................................................................................................................... 143
app.media ................................................................................................................................................... 148
app.media ....................................................................................................................... 148
align .................................................................................................................................................. 148
canResize ......................................................................................................................................... 149
closeReason ..................................................................................................................................... 149
defaultVisible .................................................................................................................................... 150
ifOffScreen ........................................................................................................................................ 150
layout ................................................................................................................................................ 151
monitorType ...................................................................................................................................... 151
openCode ......................................................................................................................................... 152
over ................................................................................................................................................... 153
pageEventNames ............................................................................................................................. 153
raiseCode ......................................................................................................................................... 154
raiseSystem ...................................................................................................................................... 154
renditionType .................................................................................................................................... 155
status ................................................................................................................................................ 155
trace .................................................................................................................................................. 156
version .............................................................................................................................................. 156
windowType ...................................................................................................................................... 157