JavaScript for Acrobat API Reference - Adobe Inc.

[Pages:731]JavaScript for Acrobat API Reference

2/1/21 Adobe, Inc.

Adobe Acrobat SDK Documentation. ? 2020 Adobe Inc. All rights reserved.

If this guide is distributed by Adobe with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement.

This guide is governed by the Adobe Acrobat SDK License Agreement and may be used or copied only in accordance with the terms of this agreement. Except as permitted by any such agreement, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe. Please note that the content in this guide is protected under copyright law.

Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permission required from the copyright owner.

Any references to company names, company logos, and user names in sample material or sample forms included in this documentation and/or software are for demonstration purposes only and are not intended to refer to any actual organization or persons.

Adobe, the Adobe logo, Acrobat, Distiller, and Reader are either registered trademarks or trademarks of Adobe the United States and/or other countries.

All other trademarks are the property of their respective owners.

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 Inc., 345 Park Avenue, San Jose, CA 95110-2704, USA

Adobe Acrobat SDK

Developing Plug-ins and Applications

3

1 Getting Started with Acrobat JavaScript................................................................................... 1

Syntax ................................................................................................................................................................................................. 1 Paths.................................................................................................................................................................................................... 2 Safe path............................................................................................................................................................................................ 2 Privileged context .......................................................................................................................................................................... 2 Privileged versus non-privileged context ............................................................................................................................. 2 User preferences............................................................................................................................................................................. 3 Quick bars.......................................................................................................................................................................................... 3 Domain names in code samples............................................................................................................................................... 5

2 JavaScript API .............................................................................................................................. 6

Alerter................................................................................................................................................................................................. 7 Alerter methods........................................................................................................................................................................ 7 dispatch................................................................................................................................................................................. 7

AlternatePresentation ................................................................................................................................................................10 AlternatePresentation properties ....................................................................................................................................10 active ....................................................................................................................................................................................10 type ....................................................................................................................................................................................... 10 AlternatePresentation methods .......................................................................................................................................10 start .......................................................................................................................................................................................11 stop .......................................................................................................................................................................................11

annotAttachment......................................................................................................................................................................... 12 annotAttachment properties.............................................................................................................................................12 contentStream .................................................................................................................................................................. 12 creationDate ...................................................................................................................................................................... 13 MIMEtype............................................................................................................................................................................ 13 modDate .............................................................................................................................................................................13 name..................................................................................................................................................................................... 13 pathname ...........................................................................................................................................................................14 size ........................................................................................................................................................................................14

Annotation......................................................................................................................................................................................15 Annotation types ...................................................................................................................................................................15 Annotation properties..........................................................................................................................................................17 alignment ...........................................................................................................................................................................18 attachment......................................................................................................................................................................... 19 AP ..........................................................................................................................................................................................19 arrowBegin ......................................................................................................................................................................... 20 arrowEnd............................................................................................................................................................................. 21 attachIcon........................................................................................................................................................................... 21 author................................................................................................................................................................................... 22 borderEffectIntensity .....................................................................................................................................................22 borderEffectStyle .............................................................................................................................................................23 callout ..................................................................................................................................................................................23 cAttachmentPath.............................................................................................................................................................23 caretSymbol....................................................................................................................................................................... 24 contents ..............................................................................................................................................................................24 creationDate ...................................................................................................................................................................... 25 dash ......................................................................................................................................................................................25 delay .....................................................................................................................................................................................26 doc ........................................................................................................................................................................................26 doCaption ........................................................................................................................................................................... 27

Adobe Acrobat SDK

Developing Plug-ins and Applications

4

fillColor ................................................................................................................................................................................27 gestures ............................................................................................................................................................................... 28 hidden..................................................................................................................................................................................28 inReplyTo ............................................................................................................................................................................ 29 intent .................................................................................................................................................................................... 29 leaderExtend .....................................................................................................................................................................30 leaderLength .....................................................................................................................................................................30 lineEnding ..........................................................................................................................................................................30 lock........................................................................................................................................................................................31 modDate .............................................................................................................................................................................31 name..................................................................................................................................................................................... 32 noteIcon ..............................................................................................................................................................................32 noView ................................................................................................................................................................................. 33 opacity .................................................................................................................................................................................33 overlayText......................................................................................................................................................................... 34 page ...................................................................................................................................................................................... 34 point .....................................................................................................................................................................................35 points ...................................................................................................................................................................................36 popupOpen .......................................................................................................................................................................36 popupRect .......................................................................................................................................................................... 37 print ......................................................................................................................................................................................37 quads....................................................................................................................................................................................37 rect ........................................................................................................................................................................................38 readOnly..............................................................................................................................................................................38 refType ................................................................................................................................................................................. 38 repeat ................................................................................................................................................................................... 39 richContents ......................................................................................................................................................................39 richDefaults ........................................................................................................................................................................ 40 rotate .................................................................................................................................................................................... 41 seqNum ...............................................................................................................................................................................41 soundIcon ........................................................................................................................................................................... 41 state ......................................................................................................................................................................................42 stateModel .........................................................................................................................................................................42 strokeColor ......................................................................................................................................................................... 42 style ....................................................................................................................................................................................... 43 subject .................................................................................................................................................................................43 textFont ............................................................................................................................................................................... 44 textSize ................................................................................................................................................................................44 toggleNoView ...................................................................................................................................................................45 type ....................................................................................................................................................................................... 45 vertices ................................................................................................................................................................................46 width ....................................................................................................................................................................................46 Annotation methods ............................................................................................................................................................47 destroy ................................................................................................................................................................................. 47 getProps .............................................................................................................................................................................. 47 getStateInModel ..............................................................................................................................................................48 setProps............................................................................................................................................................................... 49 transitionToState .............................................................................................................................................................49 AnnotRichMedia ...........................................................................................................................................................................51 AnnotRichMedia properties...............................................................................................................................................51 activated .............................................................................................................................................................................51

Adobe Acrobat SDK

Developing Plug-ins and Applications

5

context3D ........................................................................................................................................................................... 51 name..................................................................................................................................................................................... 52 page ...................................................................................................................................................................................... 52 rect ........................................................................................................................................................................................52 subtype................................................................................................................................................................................52 AnnotRichMedia methods..................................................................................................................................................53 callAS .................................................................................................................................................................................... 53 Annot3D ..........................................................................................................................................................................................55 Annot3D properties ..............................................................................................................................................................55 activated .............................................................................................................................................................................55 context3D ........................................................................................................................................................................... 55 innerRect ............................................................................................................................................................................. 56 name..................................................................................................................................................................................... 56 page ...................................................................................................................................................................................... 56 rect ........................................................................................................................................................................................56 app ..................................................................................................................................................................................................... 58 app properties.........................................................................................................................................................................58 activeDocs ..........................................................................................................................................................................58 calculate ..............................................................................................................................................................................59 constants ............................................................................................................................................................................59 focusRect ............................................................................................................................................................................60 formsVersion .....................................................................................................................................................................60 fromPDFConverters ........................................................................................................................................................60 fs ............................................................................................................................................................................................. 61 fullscreen ............................................................................................................................................................................61 language .............................................................................................................................................................................62 media ...................................................................................................................................................................................62 monitors .............................................................................................................................................................................. 63 numPlugIns ........................................................................................................................................................................ 63 openInPlace .......................................................................................................................................................................64 platform............................................................................................................................................................................... 64 plugIns .................................................................................................................................................................................64 printColorProfiles.............................................................................................................................................................65 printerNames ....................................................................................................................................................................65 runtimeHighlight .............................................................................................................................................................66 runtimeHighlightColor ..................................................................................................................................................66 thermometer .....................................................................................................................................................................66 toolbar .................................................................................................................................................................................67 toolbarHorizontal ............................................................................................................................................................67 toolbarVertical ..................................................................................................................................................................67 viewerType ......................................................................................................................................................................... 68 viewerVariation ................................................................................................................................................................68 viewerVersion.................................................................................................................................................................... 69 app methods ...........................................................................................................................................................................69 addMenuItem ...................................................................................................................................................................69 addSubMenu ..................................................................................................................................................................... 71 addToolButton.................................................................................................................................................................. 72 alert ....................................................................................................................................................................................... 74 beep......................................................................................................................................................................................75 beginPriv ............................................................................................................................................................................. 76 browseForDoc...................................................................................................................................................................76

Adobe Acrobat SDK

Developing Plug-ins and Applications

6

clearInterval .......................................................................................................................................................................78 clearTimeOut ..................................................................................................................................................................... 78 endPriv................................................................................................................................................................................. 78 execDialog.......................................................................................................................................................................... 79 execMenuItem .................................................................................................................................................................. 92 getNthPlugInName ......................................................................................................................................................... 95 getPath ................................................................................................................................................................................95 goBack .................................................................................................................................................................................96 goForward .......................................................................................................................................................................... 97 hideMenuItem ..................................................................................................................................................................97 hideToolbarButton .......................................................................................................................................................... 97 launchURL ..........................................................................................................................................................................98 listMenuItems ...................................................................................................................................................................98 listToolbarButtons ...........................................................................................................................................................99 loadPolicyFile ................................................................................................................................................................. 100 mailGetAddrs ................................................................................................................................................................. 100 mailMsg............................................................................................................................................................................ 101 newDoc ............................................................................................................................................................................ 102 newCollection................................................................................................................................................................ 104 newFDF ............................................................................................................................................................................ 104 openDoc .......................................................................................................................................................................... 105 openFDF........................................................................................................................................................................... 107 popUpMenu ................................................................................................................................................................... 108 popUpMenuEx............................................................................................................................................................... 108 removeToolButton....................................................................................................................................................... 110 response........................................................................................................................................................................... 110 setInterval........................................................................................................................................................................ 111 setTimeOut...................................................................................................................................................................... 112 trustedFunction............................................................................................................................................................. 113 trustPropagatorFunction ........................................................................................................................................... 116 app.media .................................................................................................................................................................................... 121 app.media properties ........................................................................................................................................................ 121 align ................................................................................................................................................................................... 121 canResize ......................................................................................................................................................................... 122 closeReason .................................................................................................................................................................... 122 defaultVisible.................................................................................................................................................................. 123 ifOffScreen....................................................................................................................................................................... 123 layout ................................................................................................................................................................................ 124 monitorType................................................................................................................................................................... 124 openCode........................................................................................................................................................................ 125 over .................................................................................................................................................................................... 125 pageEventNames.......................................................................................................................................................... 126 raiseCode ......................................................................................................................................................................... 127 raiseSystem ..................................................................................................................................................................... 127 renditionType................................................................................................................................................................. 127 status ................................................................................................................................................................................. 128 trace ................................................................................................................................................................................... 128 version .............................................................................................................................................................................. 129 windowType................................................................................................................................................................... 129 app.media methods........................................................................................................................................................... 129 addStockEvents............................................................................................................................................................. 130

Adobe Acrobat SDK

Developing Plug-ins and Applications

7

alertFileNotFound ........................................................................................................................................................ 130 alertSelectFailed............................................................................................................................................................ 131 argsDWIM ........................................................................................................................................................................ 131 canPlayOrAlert............................................................................................................................................................... 132 computeFloatWinRect ................................................................................................................................................ 132 constrainRectToScreen............................................................................................................................................... 133 createPlayer .................................................................................................................................................................... 133 getAltTextData .............................................................................................................................................................. 135 getAltTextSettings........................................................................................................................................................ 136 getAnnotStockEvents ................................................................................................................................................. 137 getAnnotTraceEvents.................................................................................................................................................. 137 getPlayers ........................................................................................................................................................................ 137 getPlayerStockEvents.................................................................................................................................................. 138 getPlayerTraceEvents.................................................................................................................................................. 138 getRenditionSettings .................................................................................................................................................. 139 getURLData..................................................................................................................................................................... 139 getURLSettings.............................................................................................................................................................. 140 getWindowBorderSize................................................................................................................................................ 141 openPlayer ...................................................................................................................................................................... 141 removeStockEvents ..................................................................................................................................................... 143 startPlayer........................................................................................................................................................................ 143 Bookmark ..................................................................................................................................................................................... 144 Bookmark properties ......................................................................................................................................................... 144 children ............................................................................................................................................................................ 144 color................................................................................................................................................................................... 144 doc ..................................................................................................................................................................................... 145 name.................................................................................................................................................................................. 145 open................................................................................................................................................................................... 146 parent................................................................................................................................................................................ 146 style.................................................................................................................................................................................... 146 Bookmark methods............................................................................................................................................................ 147 createChild ...................................................................................................................................................................... 147 execute ............................................................................................................................................................................. 147 insertChild ....................................................................................................................................................................... 148 remove.............................................................................................................................................................................. 148 setAction.......................................................................................................................................................................... 149 catalog........................................................................................................................................................................................... 150 catalog properties............................................................................................................................................................... 150 isIdle................................................................................................................................................................................... 150 jobs..................................................................................................................................................................................... 150 catalog methods ................................................................................................................................................................. 150 getIndex ........................................................................................................................................................................... 151 remove.............................................................................................................................................................................. 151 CatalogJob................................................................................................................................................................................... 152 CatalogJob properties....................................................................................................................................................... 152 path.................................................................................................................................................................................... 152 type.................................................................................................................................................................................... 152 status ................................................................................................................................................................................. 152 Certificate ..................................................................................................................................................................................... 154 Certificate properties ......................................................................................................................................................... 154 binary ................................................................................................................................................................................ 154

Adobe Acrobat SDK

Developing Plug-ins and Applications

8

issuerDN ........................................................................................................................................................................... 154 keyUsage.......................................................................................................................................................................... 155 MD5Hash ......................................................................................................................................................................... 155 privateKeyValidityEnd................................................................................................................................................. 155 privateKeyValidityStart ............................................................................................................................................... 156 SHA1Hash........................................................................................................................................................................ 156 serialNumber.................................................................................................................................................................. 156 subjectCN ........................................................................................................................................................................ 156 subjectDN ........................................................................................................................................................................ 157 ubRights........................................................................................................................................................................... 157 usage................................................................................................................................................................................. 158 validityEnd....................................................................................................................................................................... 159 validityStart..................................................................................................................................................................... 160 Collab............................................................................................................................................................................................. 161 Collab methods ................................................................................................................................................................... 161 addStateModel .............................................................................................................................................................. 161 documentToStream..................................................................................................................................................... 162 removeStateModel ...................................................................................................................................................... 162 color ............................................................................................................................................................................................... 163 Color arrays ........................................................................................................................................................................... 163 color properties ................................................................................................................................................................... 163 color methods ...................................................................................................................................................................... 164 convert.............................................................................................................................................................................. 164 equal.................................................................................................................................................................................. 165 colorConvertAction .................................................................................................................................................................. 166 colorConvertAction properties ...................................................................................................................................... 166 action ................................................................................................................................................................................ 166 alias .................................................................................................................................................................................... 166 colorantName ................................................................................................................................................................ 167 convertIntent ................................................................................................................................................................. 167 convertProfile................................................................................................................................................................. 167 embed............................................................................................................................................................................... 168 isProcessColor ................................................................................................................................................................ 168 matchAttributesAll....................................................................................................................................................... 168 matchAttributesAny .................................................................................................................................................... 169 matchIntent .................................................................................................................................................................... 170 matchSpaceTypeAll ..................................................................................................................................................... 170 matchSpaceTypeAny .................................................................................................................................................. 171 preserveBlack ................................................................................................................................................................. 172 useBlackPointCompensation ................................................................................................................................... 172 Collection ..................................................................................................................................................................................... 173 Collection properties ......................................................................................................................................................... 173 fields .................................................................................................................................................................................. 173 initialDoc.......................................................................................................................................................................... 173 initialView ........................................................................................................................................................................ 174 Collection methods............................................................................................................................................................ 174 addField ........................................................................................................................................................................... 174 getField............................................................................................................................................................................. 175 removeField.................................................................................................................................................................... 176 collectionField ............................................................................................................................................................................ 177 collectionField properties ................................................................................................................................................ 177

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download