JavaScript for Acrobat API Reference

1 BbcJavaScript for Acrobat API ReferenceAdobe Acrobat SDKA pril 2007 Version 2007 Adobe Systems Incorporated. All rights Acrobat SDK JavaScript for Acrobat API Reference for Microsoft Windows and Mac OS .Edition , April 2007If this guide is distributed 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 Systems Incorporated.

2 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 content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this 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.

3 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, FrameMaker, LiveCycle, PostScript and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other and Mac OS are trademarks of Apple Computer, Inc., registered in the United States and other is a trademark or registered trademark of Sun Microsystems, Inc.

4 In the United States and other and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other other trademarks are the property of their respective Systems Incorporated, 345 Park Avenue, San Jose, California 95110, 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. 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.

5 Unpublished-rights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by Reference .

6 3 ContentsPreface .. 28 What s in this guide? .. 28 Who should read this guide? .. 28 Related documentation .. 281 Introduction .. 30 Syntax .. 31 Safe 31 Privileged context .. 31 Privileged versus non-privileged context .. 32 User preferences .. 32 Quick 33 Domain names in code samples .. 342 JavaScript API .. 35 ADBC .. 36 ADBC properties .. 36 SQL types .. 36 JavaScript 37 ADBC 38getDataSourceList .. 38newConnection .. 38 Alerter .. 40 Alerter 40 AlternatePresentation .. 43 AlternatePresentation properties .. 43active .. 43type .. 43 AlternatePresentation methods .. 44start .. 44stop .. 45 Annotation types.

7 45 Annotation 47alignment .. 47AP .. 51borderEffectIntensity .. 51borderEffectStyle .. 52callout .. Acrobat SDKC ontentsJavaScript for Acrobat API Reference 42 JavaScript API (Continued)Annotation (Continued)Annotation properties (Continued)contents .. 53creationDate .. 53dash .. 54delay .. 54doc .. 56fillColor .. 57inReplyTo .. 58intent .. 58leaderExtend .. 59leaderLength .. 59lineEnding .. 60modDate .. 61noteIcon .. 62noView .. 63opacity .. 64point .. 64points .. 65popupOpen .. 66print .. 67rect .. 68richContents .. 70rotate .. 70seqNum .. 71state .. 72stateModel .. 73subject.

8 73textFont .. 74textSize .. 75toggleNoView .. 75type .. 76vertices .. 76width ..77 Adobe Acrobat SDKC ontentsJavaScript for Acrobat API Reference 52 JavaScript API (Continued)Annotation (Continued)Annotation methods .. 77destroy .. 78getStateInModel .. 79transitionToState .. 80 Annot3D .. 82 Annot3D properties .. 82activated .. 82context3D .. 83rect .. 84app .. 85app 85activeDocs .. 85calculate .. 86constants .. 86focusRect .. 87formsVersion .. 87fromPDFC onverters .. 88fullscreen .. 89language .. 89media .. 90numPlugIns .. 91openInPlace .. 92plugIns .. 93printerNames .. 93runtimeHighlight.

9 94runtimeHighlightColor .. 94thermometer .. 94toolbar .. 95toolbarHorizontal .. 95toolbarVertical .. 96viewerVariation .. 97app methods .. 97addMenuItem .. 100alert .. Acrobat SDKC ontentsJavaScript for Acrobat API Reference 62 JavaScript API (Continued)app (Continued)app methods (Continued) 104clearInterval .. 106clearTimeOut .. 107execMenuItem .. 120getNthPlugInName .. 124getPath .. 124goBack .. 125goForward .. 125hideMenuItem .. 126launchURL .. 127listMenuItems .. 127listToolbarButtons .. 128mailGetAddrs .. 129mailMsg .. 130newDoc .. 131newFDF .. 133openDoc .. 136popUpMenu .. 137removeToolButton.

10 139setInterval .. 143trustPropagatorFunction .. properties .. 150align .. 150canResize .. 151closeReason .. 152layout .. 153monitorType .. 153openCode .. 154over .. 155raiseCode .. 156raiseSystem .. 157status .. 157trace .. 158version .. 158windowType ..159 Adobe Acrobat SDKC ontentsJavaScript for Acrobat API Reference 72 JavaScript API (Continued) (Continued) methods .. 159addStockEvents .. 159alertFileNotFound .. 160argsDWIM .. 161canPlayOrAlert .. 161computeFloatWinRect .. 163createPlayer .. 163getAltTextData .. 166getAnnotStockEvents .. 167getPlayers .. 169getRenditionSettings.