JavaScript Tutotiral : API Reference / PDF
JavaScript Tutotiral : API Reference / PDF
1Introduction...............................................................................................................................30
Syntax...............................................................................................................................................................................................30
Paths..................................................................................................................................................................................................31
Safe path..........................................................................................................................................................................................31
Privileged context........................................................................................................................................................................31
Privileged versus non-privileged context...........................................................................................................................32
User preferences...........................................................................................................................................................................32
Quick bars........................................................................................................................................................................................33
Domain names in code samples.............................................................................................................................................34
2JavaScript API............................................................................................................................35
ADBC.................................................................................................................................................................................................36
ADBC properties.....................................................................................................................................................................36
SQL types............................................................................................................................................................................36
JavaScript types................................................................................................................................................................37
ADBC methods........................................................................................................................................................................38
getDataSourceList...........................................................................................................................................................38
newConnection................................................................................................................................................................38
Alerter...............................................................................................................................................................................................40
Alerter methods......................................................................................................................................................................40
dispatch...............................................................................................................................................................................40
AlternatePresentation................................................................................................................................................................43
AlternatePresentation properties....................................................................................................................................43
active....................................................................................................................................................................................43
type.......................................................................................................................................................................................43
AlternatePresentation methods.......................................................................................................................................44
start.......................................................................................................................................................................................44
stop.......................................................................................................................................................................................44
Annotation......................................................................................................................................................................................45
Annotation types...................................................................................................................................................................45
Annotation properties..........................................................................................................................................................47
alignment...........................................................................................................................................................................47
AP..........................................................................................................................................................................................48
arrowBegin.........................................................................................................................................................................49
arrowEnd.............................................................................................................................................................................50
attachIcon...........................................................................................................................................................................50
author...................................................................................................................................................................................51
borderEffectIntensity.....................................................................................................................................................51
borderEffectStyle.............................................................................................................................................................52
callout..................................................................................................................................................................................52
caretSymbol.......................................................................................................................................................................52
2 JavaScript API (Continued)
Annotation (Continued)
Annotation methods............................................................................................................................................................77
destroy.................................................................................................................................................................................77
getProps..............................................................................................................................................................................78
getStateInModel..............................................................................................................................................................79
setProps...............................................................................................................................................................................79
transitionToState.............................................................................................................................................................80
Annot3D..........................................................................................................................................................................................82
Annot3D properties..............................................................................................................................................................82
activated.............................................................................................................................................................................82
context3D...........................................................................................................................................................................82
innerRect.............................................................................................................................................................................83
name.....................................................................................................................................................................................83
page......................................................................................................................................................................................83
rect........................................................................................................................................................................................84
app.....................................................................................................................................................................................................85
app properties.........................................................................................................................................................................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 methods...........................................................................................................................................................................97
addMenuItem...................................................................................................................................................................97
addSubMenu.....................................................................................................................................................................99
addToolButton...............................................................................................................................................................100
alert....................................................................................................................................................................................101
beep...................................................................................................................................................................................103
beginPriv..........................................................................................................................................................................10
2 JavaScript API (Continued)
app (Continued)
app methods (Continued)
browseForDoc................................................................................................................................................................104
clearInterval....................................................................................................................................................................106
clearTimeOut..................................................................................................................................................................106
endPriv..............................................................................................................................................................................106
execDialog.......................................................................................................................................................................107
execMenuItem...............................................................................................................................................................120
getNthPlugInName......................................................................................................................................................124
getPath.............................................................................................................................................................................124
goBack..............................................................................................................................................................................125
goForward.......................................................................................................................................................................125
hideMenuItem...............................................................................................................................................................126
hideToolbarButton.......................................................................................................................................................126
launchURL.......................................................................................................................................................................127
listMenuItems................................................................................................................................................................127
listToolbarButtons........................................................................................................................................................128
mailGetAddrs.................................................................................................................................................................129
mailMsg............................................................................................................................................................................130
newDoc............................................................................................................................................................................131
newFDF............................................................................................................................................................................133
openDoc..........................................................................................................................................................................133
openFDF...........................................................................................................................................................................136
popUpMenu...................................................................................................................................................................136
popUpMenuEx...............................................................................................................................................................137
removeToolButton.......................................................................................................................................................139
response...........................................................................................................................................................................139
setInterval........................................................................................................................................................................140
setTimeOut......................................................................................................................................................................141
trustedFunction.............................................................................................................................................................143
trustPropagatorFunction...........................................................................................................................................146
app.media....................................................................................................................................................................................150
app.media properties........................................................................................................................................................150
align...................................................................................................................................................................................150
canResize.........................................................................................................................................................................151
closeReason....................................................................................................................................................................151
defaultVisible..................................................................................................................................................................152
ifOffScreen.......................................................................................................................................................................152
layout................................................................................................................................................................................153
monitorType...................................................................................................................................................................153
openCode........................................................................................................................................................................154
over....................................................................................................................................................................................155
pageEventNames..........................................................................................................................................................155
raiseCode.........................................................................................................................................................................156
raiseSystem.....................................................................................................................................................................156
renditionType.................................................................................................................................................................157
status.................................................................................................................................................................................157
trace...................................................................................................................................................................................158
version..............................................................................................................................................................................158
windowType.....................................................................................................................
2 JavaScript API (Continued)
Doc (Continued)
Doc methods (Continued)
movePage........................................................................................................................................................................324
newPage..........................................................................................................................................................................325
openDataObject............................................................................................................................................................325
print...................................................................................................................................................................................326
removeDataObject.......................................................................................................................................................328
removeField....................................................................................................................................................................328
removeIcon.....................................................................................................................................................................329
removeLinks...................................................................................................................................................................329
removeRequirement...................................................................................................................................................330
removeScript..................................................................................................................................................................330
removeTemplate..........................................................................................................................................................330
removeThumbnails......................................................................................................................................................331
removeWeblinks...........................................................................................................................................................331
replacePages..................................................................................................................................................................332
resetForm........................................................................................................................................................................332
saveAs...............................................................................................................................................................................333
scroll..................................................................................................................................................................................335
selectPageNthWord.....................................................................................................................................................336
setAction..........................................................................................................................................................................336
setDataObjectContents..............................................................................................................................................337
setOCGOrder..................................................................................................................................................................339
setPageAction................................................................................................................................................................339
setPageBoxes.................................................................................................................................................................340
setPageLabels................................................................................................................................................................340
setPageRotations..........................................................................................................................................................341
setPageTabOrder..........................................................................................................................................................342
setPageTransitions.......................................................................................................................................................343
spawnPageFromTemplate........................................................................................................................................343
submitForm....................................................................................................................................................................345
syncAnnotScan..............................................................................................................................................................349
Doc.media....................................................................................................................................................................................351
Doc.media properties........................................................................................................................................................351
canPlay..............................................................................................................................................................................351
Doc.media methods...........................................................................................................................................................352
deleteRendition.............................................................................................................................................................352
getAnnot..........................................................................................................................................................................352
getAnnots........................................................................................................................................................................353
getOpenPlayers.............................................................................................................................................................354
getRendition...................................................................................................................................................................355
newPlayer........................................................................................................................................................................355
Embedded PDF..........................................................................................................................................................................357
Embedded PDF properties..............................................................................................................................................357
messageHandler...........................................................................................................................................................357
Embedded PDF methods.................................................................................................................................................358
postMessage...........
2 JavaScript API (Continued)
Error................................................................................................................................................................................................359
Error properties....................................................................................................................................................................360
fileName...........................................................................................................................................................................360
lineNumber.....................................................................................................................................................................360
extMessage.....................................................................................................................................................................360
message...........................................................................................................................................................................361
name..................................................................................................................................................................................361
Error methods.......................................................................................................................................................................361
toString.............................................................................................................................................................................361
event..............................................................................................................................................................................................362
Event type/name combinations....................................................................................................................................362
Document Event Processing...........................................................................................................................................371
Form event processing.....................................................................................................................................................372
Multimedia event processing.........................................................................................................................................372
event properties..................................................................................................................................................................373
change..............................................................................................................................................................................373
Example............................................................................................................................................................................373
changeEx.........................................................................................................................................................................373
commitKey......................................................................................................................................................................375
fieldFull.............................................................................................................................................................................375
keyDown..........................................................................................................................................................................376
modifier............................................................................................................................................................................377
name..................................................................................................................................................................................377
rc.........................................................................................................................................................................................378
richChange......................................................................................................................................................................378
richChangeEx.................................................................................................................................................................379
richValue..........................................................................................................................................................................380
selEnd................................................................................................................................................................................381
selStart..............................................................................................................................................................................381
shift....................................................................................................................................................................................382
source................................................................................................................................................................................382
target.................................................................................................................................................................................383
targetName.....................................................................................................................................................................383
type....................................................................................................................................................................................384
value..................................................................................................................................................................................384
willCommit......................................................................................................................................................................385
EventListener..............................................................................................................................................................................386
EventListener methods.....................................................................................................................................................387
afterBlur............................................................................................................................................................................387
afterClose.........................................................................................................................................................................387
afterDestroy....................................................................................................................................................................388
afterDone.........................................................................................................................................................................388
afterError..........................................................................................................................................................................389
afterEscape......................................................................................................................................................................389
afterEveryEvent.............................................................................................................................................................389
afterFocus........................................................................................................................................................................390
afterPause........................................................................................................................................................................390
afterPlay...........................................................................................................................................................................391
afterReady.....................................
Table of Contents
1Introduction...............................................................................................................................30
Syntax...............................................................................................................................................................................................30
Paths..................................................................................................................................................................................................31
Safe path..........................................................................................................................................................................................31
Privileged context........................................................................................................................................................................31
Privileged versus non-privileged context...........................................................................................................................32
User preferences...........................................................................................................................................................................32
Quick bars........................................................................................................................................................................................33
Domain names in code samples.............................................................................................................................................34
2JavaScript API............................................................................................................................35
ADBC.................................................................................................................................................................................................36
ADBC properties.....................................................................................................................................................................36
SQL types............................................................................................................................................................................36
JavaScript types................................................................................................................................................................37
ADBC methods........................................................................................................................................................................38
getDataSourceList...........................................................................................................................................................38
newConnection................................................................................................................................................................38
Alerter...............................................................................................................................................................................................40
Alerter methods......................................................................................................................................................................40
dispatch...............................................................................................................................................................................40
AlternatePresentation................................................................................................................................................................43
AlternatePresentation properties....................................................................................................................................43
active....................................................................................................................................................................................43
type.......................................................................................................................................................................................43
AlternatePresentation methods.......................................................................................................................................44
start.......................................................................................................................................................................................44
stop.......................................................................................................................................................................................44
Annotation......................................................................................................................................................................................45
Annotation types...................................................................................................................................................................45
Annotation properties..........................................................................................................................................................47
alignment...........................................................................................................................................................................47
AP..........................................................................................................................................................................................48
arrowBegin.........................................................................................................................................................................49
arrowEnd.............................................................................................................................................................................50
attachIcon...........................................................................................................................................................................50
author...................................................................................................................................................................................51
borderEffectIntensity.....................................................................................................................................................51
borderEffectStyle.............................................................................................................................................................52
callout..................................................................................................................................................................................52
caretSymbol.......................................................................................................................................................................52
2 JavaScript API (Continued)
Annotation (Continued)
Annotation methods............................................................................................................................................................77
destroy.................................................................................................................................................................................77
getProps..............................................................................................................................................................................78
getStateInModel..............................................................................................................................................................79
setProps...............................................................................................................................................................................79
transitionToState.............................................................................................................................................................80
Annot3D..........................................................................................................................................................................................82
Annot3D properties..............................................................................................................................................................82
activated.............................................................................................................................................................................82
context3D...........................................................................................................................................................................82
innerRect.............................................................................................................................................................................83
name.....................................................................................................................................................................................83
page......................................................................................................................................................................................83
rect........................................................................................................................................................................................84
app.....................................................................................................................................................................................................85
app properties.........................................................................................................................................................................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 methods...........................................................................................................................................................................97
addMenuItem...................................................................................................................................................................97
addSubMenu.....................................................................................................................................................................99
addToolButton...............................................................................................................................................................100
alert....................................................................................................................................................................................101
beep...................................................................................................................................................................................103
beginPriv..........................................................................................................................................................................10
2 JavaScript API (Continued)
app (Continued)
app methods (Continued)
browseForDoc................................................................................................................................................................104
clearInterval....................................................................................................................................................................106
clearTimeOut..................................................................................................................................................................106
endPriv..............................................................................................................................................................................106
execDialog.......................................................................................................................................................................107
execMenuItem...............................................................................................................................................................120
getNthPlugInName......................................................................................................................................................124
getPath.............................................................................................................................................................................124
goBack..............................................................................................................................................................................125
goForward.......................................................................................................................................................................125
hideMenuItem...............................................................................................................................................................126
hideToolbarButton.......................................................................................................................................................126
launchURL.......................................................................................................................................................................127
listMenuItems................................................................................................................................................................127
listToolbarButtons........................................................................................................................................................128
mailGetAddrs.................................................................................................................................................................129
mailMsg............................................................................................................................................................................130
newDoc............................................................................................................................................................................131
newFDF............................................................................................................................................................................133
openDoc..........................................................................................................................................................................133
openFDF...........................................................................................................................................................................136
popUpMenu...................................................................................................................................................................136
popUpMenuEx...............................................................................................................................................................137
removeToolButton.......................................................................................................................................................139
response...........................................................................................................................................................................139
setInterval........................................................................................................................................................................140
setTimeOut......................................................................................................................................................................141
trustedFunction.............................................................................................................................................................143
trustPropagatorFunction...........................................................................................................................................146
app.media....................................................................................................................................................................................150
app.media properties........................................................................................................................................................150
align...................................................................................................................................................................................150
canResize.........................................................................................................................................................................151
closeReason....................................................................................................................................................................151
defaultVisible..................................................................................................................................................................152
ifOffScreen.......................................................................................................................................................................152
layout................................................................................................................................................................................153
monitorType...................................................................................................................................................................153
openCode........................................................................................................................................................................154
over....................................................................................................................................................................................155
pageEventNames..........................................................................................................................................................155
raiseCode.........................................................................................................................................................................156
raiseSystem.....................................................................................................................................................................156
renditionType.................................................................................................................................................................157
status.................................................................................................................................................................................157
trace...................................................................................................................................................................................158
version..............................................................................................................................................................................158
windowType.....................................................................................................................
2 JavaScript API (Continued)
Doc (Continued)
Doc methods (Continued)
movePage........................................................................................................................................................................324
newPage..........................................................................................................................................................................325
openDataObject............................................................................................................................................................325
print...................................................................................................................................................................................326
removeDataObject.......................................................................................................................................................328
removeField....................................................................................................................................................................328
removeIcon.....................................................................................................................................................................329
removeLinks...................................................................................................................................................................329
removeRequirement...................................................................................................................................................330
removeScript..................................................................................................................................................................330
removeTemplate..........................................................................................................................................................330
removeThumbnails......................................................................................................................................................331
removeWeblinks...........................................................................................................................................................331
replacePages..................................................................................................................................................................332
resetForm........................................................................................................................................................................332
saveAs...............................................................................................................................................................................333
scroll..................................................................................................................................................................................335
selectPageNthWord.....................................................................................................................................................336
setAction..........................................................................................................................................................................336
setDataObjectContents..............................................................................................................................................337
setOCGOrder..................................................................................................................................................................339
setPageAction................................................................................................................................................................339
setPageBoxes.................................................................................................................................................................340
setPageLabels................................................................................................................................................................340
setPageRotations..........................................................................................................................................................341
setPageTabOrder..........................................................................................................................................................342
setPageTransitions.......................................................................................................................................................343
spawnPageFromTemplate........................................................................................................................................343
submitForm....................................................................................................................................................................345
syncAnnotScan..............................................................................................................................................................349
Doc.media....................................................................................................................................................................................351
Doc.media properties........................................................................................................................................................351
canPlay..............................................................................................................................................................................351
Doc.media methods...........................................................................................................................................................352
deleteRendition.............................................................................................................................................................352
getAnnot..........................................................................................................................................................................352
getAnnots........................................................................................................................................................................353
getOpenPlayers.............................................................................................................................................................354
getRendition...................................................................................................................................................................355
newPlayer........................................................................................................................................................................355
Embedded PDF..........................................................................................................................................................................357
Embedded PDF properties..............................................................................................................................................357
messageHandler...........................................................................................................................................................357
Embedded PDF methods.................................................................................................................................................358
postMessage...........
2 JavaScript API (Continued)
Error................................................................................................................................................................................................359
Error properties....................................................................................................................................................................360
fileName...........................................................................................................................................................................360
lineNumber.....................................................................................................................................................................360
extMessage.....................................................................................................................................................................360
message...........................................................................................................................................................................361
name..................................................................................................................................................................................361
Error methods.......................................................................................................................................................................361
toString.............................................................................................................................................................................361
event..............................................................................................................................................................................................362
Event type/name combinations....................................................................................................................................362
Document Event Processing...........................................................................................................................................371
Form event processing.....................................................................................................................................................372
Multimedia event processing.........................................................................................................................................372
event properties..................................................................................................................................................................373
change..............................................................................................................................................................................373
Example............................................................................................................................................................................373
changeEx.........................................................................................................................................................................373
commitKey......................................................................................................................................................................375
fieldFull.............................................................................................................................................................................375
keyDown..........................................................................................................................................................................376
modifier............................................................................................................................................................................377
name..................................................................................................................................................................................377
rc.........................................................................................................................................................................................378
richChange......................................................................................................................................................................378
richChangeEx.................................................................................................................................................................379
richValue..........................................................................................................................................................................380
selEnd................................................................................................................................................................................381
selStart..............................................................................................................................................................................381
shift....................................................................................................................................................................................382
source................................................................................................................................................................................382
target.................................................................................................................................................................................383
targetName.....................................................................................................................................................................383
type....................................................................................................................................................................................384
value..................................................................................................................................................................................384
willCommit......................................................................................................................................................................385
EventListener..............................................................................................................................................................................386
EventListener methods.....................................................................................................................................................387
afterBlur............................................................................................................................................................................387
afterClose.........................................................................................................................................................................387
afterDestroy....................................................................................................................................................................388
afterDone.........................................................................................................................................................................388
afterError..........................................................................................................................................................................389
afterEscape......................................................................................................................................................................389
afterEveryEvent.............................................................................................................................................................389
afterFocus........................................................................................................................................................................390
afterPause........................................................................................................................................................................390
afterPlay...........................................................................................................................................................................391
afterReady.....................................
JavaScript Tutotiral : API Reference / PDF
0 commentaires: