Adobe ACROBAT SDK V8.0 Manual
  1. Manuals
  2. Brands
  3. Adobe Manuals
  4. Software
  5. ACROBAT SDK V8.0
  6. Manual
Adobe ACROBAT SDK V8.0 Manual

Adobe ACROBAT SDK V8.0 Manual

Developing for adobe reader
Hide thumbs
Table of Contents

Advertisement

Quick Links

Developing for Adobe
Reader
®
®
Adobe
Acrobat
SDK
®
®
November 2006
Version 8.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ACROBAT SDK V8.0 and is the answer not in the manual?

Questions and answers

Related Manuals for Adobe ACROBAT SDK V8.0

Summary of Contents for Adobe ACROBAT SDK V8.0

  • Page 1 Developing for Adobe Reader ® ® Adobe Acrobat ® ® November 2006 Version 8.0...
  • Page 2 Adobe Systems Incorporated. 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.

  • Page 3: Table Of Contents

    JavaScript ....................................9 Interapplication communication ............................9 Plug-ins ......................................9 JavaScript APIs........................... 10 Objects, properties and methods............................10 Interapplication Communication ..................... 25 OLE automation ....................................25 DDE messages ....................................27 Apple events ....................................27 Plug-ins............................28 APIs available for Adobe Reader.............................29 Index ............................30...

  • Page 4: Preface

    Adobe Reader, and provides information clarifying how such efforts differ from those intended for Acrobat. It is possible to extend and customize Adobe Reader by using the Adobe Acrobat SDK to write JavaScript™ code, implement interapplication communication, and write plug-ins. This document indicates the relevant subsets of the JavaScript APIs, interapplication communication APIs, and the Acrobat and PDF Library APIs.
  • Page 5 Adobe Reader or render PDF documents. Detailed descriptions of the APIs available for Apple events, Interapplication Communication AppleScript, DDE, or OLE to control Acrobat or Adobe Reader API Reference or render PDF documents. An overview of how to use JavaScript to develop and Developing Acrobat Applications enhance standard workflows in Acrobat or Adobe Reader.

  • Page 6: Introduction

    Acrobat SDK. Supported platforms This section describes the requirements for using the interapplication communication and Acrobat core and extended APIs on all supported platforms. The following platforms are currently supported for development with Adobe Reader: Windows® ● Mac OS ●...

  • Page 7: Linux

    Not all versions of Red Hat Linux will automatically install the GNOME GTK+ Library, which is required for developing plug-ins for Adobe Reader on Linux. To ensure that your Adobe Reader plug-ins will compile, make sure the GNOME GTK+ Library has been installed on your system.

  • Page 8: Aix

    For information about choosing an appropriate technology for your project, see the Overview guide. It is important to consider the role of Adobe LiveCycle® Reader Extensions in your development efforts with JavaScript and plug-ins. Though the APIs available for Adobe Reader are normally limited in both cases, additional APIs can be used for a given PDF document if that document is rights-enabled, meaning that it has additional usage rights.

  • Page 9: Javascript

    JavaScript is a platform-independent scripting language with which you can customize the behavior of PDF documents in Acrobat or Adobe Reader, as well as the behavior of Acrobat or Adobe Reader itself. You will find that using JavaScript is, in many cases, much easier than writing plug-ins.

  • Page 10: Javascript Apis

    The JavaScript debugger available in Acrobat is not normally available in Adobe Reader, though debug messages can be triggered to appear in the console. The complete debugger functionality can be enabled in Adobe Reader on Windows and Mac OS platforms. For details, see Developing Acrobat Applications using JavaScript.
  • Page 11 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Annotation author (Continued) borderEffectIntensity borderEffectStyle callout caretSymbol contents creationDate dash delay doCaption fillColor gestures hidden inReplyTo intent leaderExtend leaderLength lineEnding lock modDate name noteIcon...
  • Page 12 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Annot3D activated context3D innerRect name page rect activeDocs addMenuItem calculate addSubMenu constants addToolButton focusRect alert formsVersion beep fromPDFConverters beginPriv browseForDoc fullscreen clearInterval language clearTimeOut...
  • Page 13 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods app.media status getPlayerStockEvents (Continued) trace getPlayerTraceEvents version getRenditionSettings windowType getURLData getURLSettings getWindowBorderSize openPlayer removeStockEvents startPlayer Bookmark children execute parent Certificate binary issuerDN keyUsage MD5Hash...
  • Page 14 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods console clear hide println show Note: Only is supported println on Linux and UNIX platforms. Data creationDate description MIMEType modDate name path size Dialog...
  • Page 15 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Document keywords getField (Continued) layout getIcon media getLinks modDate getNthFieldName mouseX getNthTemplate mouseY getOCGs noautocomplete getOCGOrder nocache getPageBox numFields getPageLabel numPages getPageNthWord numTemplates getPageNthWordQuads...
  • Page 16 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Error fileName toString lineNumber extMessage message name event change changeEx commitKey fieldFull keyDown modifier name richChange richChangeEx richValue selEnd selStart shift source target targetName...
  • Page 17 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods EventListener onFocus (Continued) onGetRect onPause onPlay onReady onScript onSeek onStatus onStop Field alignment browseForFileToSubmit borderStyle buttonGetCaption buttonAlignX buttonGetIcon buttonAlignY buttonSetCaption buttonFitBounds buttonSetIcon buttonPosition checkThisBox...
  • Page 18 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Field submitName (Continued) textColor textFont textSize type userName value valueAsString FullScreen backgroundColor clickAdvances cursor defaultTransition escapeExits isFullScreen loop timeDelay transitions usePageTiming useTimer Global setPersistent...
  • Page 19 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods MediaOffset frame marker time MediaPlayer annot close defaultSize open pause events play hasFocus seek setFocus innerRect stop isOpen triggerGetRect isPlaying where markers outerRect page...
  • Page 20 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Monitor colorDepth isPrimary rect workRect (Same as Monitors Array bestColor bestFit desktop document filter largest leastOverlap mostOverlap nonDocument primary secondary select tallest widest constants...
  • Page 21 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods PrintParams binaryOK colorOverride constants downloadFarEastFonts fileName firstPage flags fontPolicy interactive lastPage nUpAutoRotate nUpNumPagesH nUpNumPagesV nUpPageBorder nUpPageOrder pageHandling pageSubset printAsImage printContent printerName psLevel reversePages usePrinterCRD...
  • Page 22 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods Search attachments addIndex available getIndexForPath bookmarks query docInfo removeIndex docText docXMP ignoreAccents ignoreAsianCharacterWidth indexes jpegExif legacySearch markup matchCase matchWholeWord maxDocs objectMetadata proximity proximityRange refine...
  • Page 23 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods SOAP wiredump connect queryServices resolveService request response streamDecode streamDigest streamEncode streamFromString stringFromStream Sound name play pause stop Span alignment fontFamily fontStretch fontStyle fontWeight strikethrough...
  • Page 24 Adobe Acrobat SDK JavaScript APIs Developing for Adobe Reader Objects, properties and methods Object Properties Methods available getNthSpeakerName numSpeakers pause pitch qSilence soundCues qSound speaker qText speechCues reset speechRate resume volume stop talk util crackURL iconStreamFromIcon printd printf printx scand...

  • Page 25: Interapplication Communication

    Interapplication Communication Only a limited subset of the complete IAC functionality is available for Adobe Reader. For detailed descriptions of the syntax and usage of the IAC APIs discussed in this chapter, see the Interapplication Communication API Reference and Developing Applications using Interapplication Communication.
  • Page 26 Adobe Acrobat SDK Interapplication Communication Developing for Adobe Reader OLE automation PDF browser controls are available through the interface, which provides AxAcroPDFLib.AxAcroPDF the following methods used to programmatically control the PDF document window: GoBackwardStack ● GoForwardStack ● GotoFirstPage ● GotoLastPage ●...

  • Page 27: Dde Messages

    FilePrint ● FilePrintEx ● FilePrintSilent ● FilePrintSilentEx ● FilePrintTo ● FilePrintToEx ● Apple events On Mac OS, you may use Apple events and AppleScript. Adobe Reader supports only the following required Apple events: open ● print ● quit ● ●...

  • Page 28: Plug-Ins

    Developing Plug-ins and Applications to make specific changes to your plug-in code in order for Adobe Reader to recognize and load it. For information on what you can and cannot do with Reader-enabled plug-ins, see the Reader Integration Key License Program.

  • Page 29: Apis Available For Adobe Reader

    APIs available for Adobe Reader APIs available for Adobe Reader Host Function Tables (HFTs) are tables of function pointers, essentially providing a means by which plug-ins call methods in Adobe Reader. The following HFTs are available for development with Adobe Reader: AcroView ●...

  • Page 30: Index

    Index ActiveX document 25 Mac OS 6 additional usage rights 8, 10, 28 Macintosh 6 Adobe LiveCycle Reader Extensions 8, 10, 28 AIX 6, 8 Apple events 9, 25 OLE automation 9, 25 AppleScript 9, 27 PDF browser controls 25...

This manual is also suitable for:

Acrobat sdk 8.0

Table of Contents