JavaScript for Acrobat API Reference - Adobe Inc.

1 JavaScript for Acrobat API Reference2/1/21 Adobe , Acrobat SDK Documentation. 2020 Adobe Inc. All rights 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 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 .

2 Please note that the content in this guide is protected under copyright 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 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 , the Adobe logo, Acrobat , Distiller, and Reader are either registered trademarks or trademarks of Adobe the United States and/or other other trademarks are the property of their respective to Government End Users. The Software and Documentation are Commercial Items, as that term is defined at 48 , consisting of Commercial Computer Software and Commercial Computer Software Documentation, as such terms are used in 48 or 48 , as applicable.

3 Consistent with 48 or 48 through , as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to 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, USAA dobe Acrobat SDKD eveloping Plug-ins and Applications 31 Getting Started with Acrobat .. 2 Safe 2 Privileged context .. 2 Privileged versus non-privileged context .. 2 User 3 Quick 3 Domain names in code 52 JavaScript API .. 7 Alerter 7 AlternatePresentation ..10 AlternatePresentation properties ..14size .. types ..15 Annotation ..25delay ..26doc .. Acrobat SDKD eveloping Plug-ins and Applications 4fillColor ..35points ..36popupOpen ..42stateModel ..44toggleNoView ..46width.

4 46 Annotation methods ..49 AnnotRichMedia ..51 AnnotRichMedia ..51 Adobe Acrobat SDKD eveloping Plug-ins and Applications ..55 Annot3D properties ..55activated ..59focusRect ..60formsVersion ..60fromPDFC onverters ..67toolbarHorizontal ..67toolbarVertical .. methods ..69addMenuItem .. Acrobat SDKD eveloping Plug-ins and Applications 6clearInterval ..95goBack ..98listMenuItems .. 100mailGetAddrs .. 101newDoc .. 104newFDF .. 104openDoc .. 107popUpMenu .. 121canResize .. 122closeReason .. 123layout .. 128version .. 130 Adobe Acrobat SDKD eveloping Plug-ins and Applications 7alertFileNotFound .. 131argsDWIM .. 133createPlayer .. 133getAltTextData .. 136getAnnotStockEvents .. 137getPlayers .. 138getRenditionSettings .. 141openPlayer .. 141removeStockEvents .. 143 Bookmark .. 144 Bookmark properties .. 144children .. 144doc .. 146 Bookmark 147insertChild .. 150catalog 150catalog methods.

5 152 CatalogJob 152 Certificate .. 154 Certificate 154binary .. 154 Adobe Acrobat SDKD eveloping Plug-ins and Applications 155MD5 Hash .. 155privateKeyValidityStart .. 156subjectCN .. 161 Collab methods .. 161addStateModel .. 162removeStateModel .. 162color .. 163 Color arrays .. 163color properties .. 163color methods .. 165colorConvertAction .. 166colorConvertAction properties .. 166action .. 166alias .. 166colorantName .. 167convertIntent .. 168matchAttributesAny .. 170matchSpaceTypeAll .. 170matchSpaceTypeAny .. 171preserveBlack .. 172useBlackPointCompensation .. 172 Collection .. 173 Collection properties .. 173fields .. 174 Collection 174addField .. 176collectionField .. 177collectionField 177 Adobe Acrobat SDKD eveloping Plug-ins and Applications 178sort .. 178text .. 180 Column 181value .. 182 ColumnInfo 182description .. 184console 184clear.

6 184println .. 184show .. 185 Data .. 186 Data properties .. 186description .. 187size .. 188 Data 188getFieldValue .. 188setFieldValue .. 188 DataSourceInfo .. 190 DataSourceInfo properties .. 190description .. 191dbg properties .. 191dbg methods .. 192cb .. 192q .. 192sb .. 193sn .. 194 Adobe Acrobat SDKD eveloping Plug-ins and Applications 10so .. 195 Dialog methods .. 195enable .. 195end .. 195load .. 196 DirConnection .. 197 DirConnection properties .. 197canDoCustomUISearch .. 198canDoStandardSearch .. 199uiName .. 199 DirConnection 203 Directory 203info .. 203 Directory 207 Doc properties .. 207alternatePresentations .. 210collection .. 211delay .. 212disclosed .. 213docID .. 214documentFileName .. 215filesize .. 216hostContainer .. 216icons .. 217info .. 217innerAppWindowRect .. 219isModal .. 220 Adobe Acrobat SDKD eveloping Plug-ins and Applications 220layout.

7 220media .. 224noautocomplete .. 226outerDocWindowRect .. 227pageWindowRect .. 227permStatusReady .. 228producer .. 228securityHandler .. 229sounds .. 230spellDictionaryOrder .. 231subject .. 231title .. 232viewState .. 232xfa .. 236 Doc methods .. 238addField .. 241addRecipientListCryptFilter .. 245addWatermarkFromFile .. 250bringToFront .. 253 Adobe Acrobat SDKD eveloping Plug-ins and Applications 254createTemplate .. 255deletePages .. 256deleteSound .. 257encryptForRecipients .. 257encryptUsingPolicy .. 262exportAsFDFStr .. 263exportAsText .. 264exportAsXFDF .. 266exportXFAData .. 268extractPages .. 273getAnnots3D .. 274getColorConvertAction .. 274getDataObject .. 277getLegalWarnings .. 282getNthFieldName .. 283getOCGs .. 283getOCGO rder .. 284getPageLabel .. 285getPageNumWords .. 286getPageRotation .. 286getPageTransition .. 287getPreflightAuditTrail.

8 287getSound .. 288getTemplate .. 288getURL .. 291importDataObject .. 291 Adobe Acrobat SDKD eveloping Plug-ins and Applications 292importSound .. 293importTextData .. 296mailDoc .. 298newPage .. 300print .. 303removeLinks .. 304removeRequirement .. 304removeTemplate .. 305removeWeblinks .. 306replacePages .. 306resetForm .. 307saveAs .. 307scroll .. 312setOCGO rder .. 313setPageBoxes .. 314setPageLabels .. 316setPageTransitions .. 317submitForm .. 323timestampSign .. 324validatePreflightAuditTrail .. 330 Adobe Acrobat SDKD eveloping Plug-ins and Applications 14 Embedded PDF .. 332 Embedded PDF properties .. 332messageHandler .. 332 Embedded PDF 334 Error 335extMessage .. 335message .. 336 Error 336event .. 337 Event type/name 337 App/Init .. 337 337 Bookmark/Mouse 338 338 338 338 Doc/Open .. 338 339 Doc/WillPrint .. 339 Doc/WillSave .. 339 339 339 340 340 340 341 Field/Mouse 341 Field/Mouse Enter.

9 342 Field/Mouse 342 Field/Mouse Up .. 342 Field/Validate .. 342 Link/Mouse 343 343 Page/Open .. 343 Page/Close .. 343 344 344 344 Screen/InView .. 344 Screen/Mouse 345 Screen/Mouse Enter .. 345 Screen/Mouse 345 Screen/Mouse Up .. 345 346 Screen/OutView .. 346 Adobe Acrobat SDKD eveloping Plug-ins and Applications 15 Document Event 346 Form event processing .. 347 Multimedia event 347event 348changeEx .. 348commitKey .. 352rc .. 353richChangeEx .. 353richValue .. 355selStart .. 356shift .. 358value .. 359 EventListener .. 360 EventListener 363afterEveryEvent .. 364afterPlay .. 364afterReady .. 365afterScript .. 366afterSeek .. 367afterStatus .. 367afterStop .. 370onEveryEvent .. 371 Adobe Acrobat SDKD eveloping Plug-ins and Applications 372onPlay .. 372onReady .. 372onScript .. 372onSeek .. 373onStatus .. 373onStop .. 374 Events .. 375 Events 375add .. 378 FDF 378deleteOption.

10 379 FDF methods .. 379addContact .. 381mail .. 383signatureSign .. 386 Field versus widget 387 Field 388alignment .. 388borderStyle .. 391buttonScaleHow .. 392calcOrderIndex .. 393charLimit .. 393comb .. 396defaultValue .. 398doNotScroll .. 398delay .. 399doc .. 400editable .. 400 Adobe Acrobat SDKD eveloping Plug-ins and Applications 402fillColor .. 403lineWidth .. 407print .. 408readonly .. 408rect .. 410richValue .. 414textColor .. 415textSize .. 417userName .. 418value .. 418valueAsString .. 419 Field 420buttonGetIcon .. 424clearItems .. 424defaultIsChecked .. 429setFocus .. 431 Adobe Acrobat SDKD eveloping Plug-ins and Applications 18signatureGetModifications .. 434signatureSetSeedValue .. 435signatureSign .. 447 FullScreen 447cursor .. 449timeDelay .. 450useTimer .. 452 Creating global 452 Deleting global properties.