Acrobat SDK Release Notes


Published on

Published in: Technology
  • Be the first to comment

  • Be the first to like this

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

Acrobat SDK Release Notes

  1. 1. Acro b at 7 . 0 . 5 S D K R e l e a s e N o te s About These Release Notes These release notes are an introduction to the Acrobat® 7.0.5 Software Development Kit. They are broken down into the following topics: ● What’s New in the Acrobat 7.0.X SDK ● Contacting Adobe Solutions Network ● Registering Plug-in Prefixes ● Adobe Dialog Manager ● Supported Development Environments ● Supported Operating Systems ● Tools ● Known Issues In This Release For an overview of the documentation and frequently asked questions, please see the Acrobat SDK User’s Guide and Acrobat Developer FAQ documents in the Getting Started folder. For information specific to development for Adobe® Reader®, see Developing for Adobe Reader. NOTE: To uninstall Acrobat SDK 7.0.5 on Microsoft® Windows®, go to the Control Panel and select Add/Remove Programs. NOTE: To uninstall Acrobat SDK 7.0.5 on a Macintosh®, drag the sdk folder to Trash, navigate to /Library/Receipts, and delete the SDKInstaller.pkg file (which is located in the /[UserHomeDir]/Library/Receipts/ folder). 1
  2. 2. Acrobat 7.0.5 SDK Release Notes What’s New in the Acrobat 7.0.X SDK This section describes what is new in the Acrobat SDK since 6.0. The Acrobat 7.0.5 SDK includes: ● an updated plug-in wizard ● new Interapplication Communication samples including ActiveX Visual Basic .NET and Visual C# .NET samples. The Acrobat 7.0.5 SDK now provides support for more development environments. These include: ● Microsoft® Visual Studio .NET ● Interapplication Communication support for Visual C# .NET and Visual Basic .NET ● support for the Mach-O runtime architecture on Macintosh® OS X for plug-ins In addition, developers can now implement: ● late initialization of plug-ins to allow Acrobat to launch more quickly ● 64-bit numbers to allow reading and writing of files larger than 2 gigabytes ● ActiveX control for display of PDF documents in external application windows (on Windows only) ● automated silent creation of PDF documents (Windows only) For collaboration, Adobe Reader 7.0 users can participate in document review processes, and there is extensive and increased Macintosh support. For engineering applications, the Acrobat SDK now allows association of metadata with specific objects in a PDF, and there are new APIs for non-scaling watermarks as well as wireframe drawings. There is support for XML forms authoring using Adobe LiveCycleΤΜ Designer. For Acrobat Forms, there is now: ● data collection with Microsoft Excel and various file formats ● new security policies and associated Acrobat JavaScript support ● searching and indexing ● support for SOAP and WSDL for enterprise workflows For more information, see the Acrobat SDK User’s Guide. In addition, there is now a Show Permissions sample plug-in that provides useful information about the Acrobat functionality, API availability, and permitted PDF operations for the active PDF document The SnippetRunner plug-in sample includes a Java-based user interface located within the SnippetRunner directory. Its functionality is contained in CommonInterface.jar. For detailed information on its usage, see the Guide to SDK Samples. For more information on samples, see the Guide to SDK Samples. 2
  3. 3. Acrobat 7.0.5 SDK Release Notes The Acrobat 7.0.5 SDK documentation highlights more extensive JavaScript features, updates to the capabilities in PDF Open Parameters, extensive updates to the repository types and administration of Acrobat Online Collaboration including Macintosh support, extensive updates to Interapplication Communication, updates to the Forms tutorials, and updates to the SDK documents. Changes to the content or names of Acrobat SDK documents are indicated below in Table 1: Table 1: Acrobat 6 and 7 Document Map Acrobat 6 Documents Acrobat 7 Document Core API Overview Now includes Extended APIs and PDF Library-specific APIs. It has been renamed the Acrobat and PDF Library API Overview Core API Reference Now part of the Acrobat and PDF Library API Reference AcroColor API Reference Catalog API Consultant API DigSig API Forms API PDF Library Supplement to the Core API Search API Spelling API Weblink API Getting Started Now part of the Acrobat SDK User’s Guide Acrobat SDK Development Overview Now part of the Acrobat SDK Plug-in Guide Plug-in Tutorial Upgrading Plug-ins From Acrobat 5 to Acrobat 6 AcroJS - Multimedia Now part of the Acrobat JavaScript Scripting Reference NOTE: AVCommand information, which was formerly available in the Core API Reference, is now available in the Headers/SDK/AVCmdDefs.h header file under the SDK installation directory. 3
  4. 4. Acrobat 7.0.5 SDK Release Notes Contacting Adobe Solutions Network Developer support is available as part of the Adobe Solutions Network. You may purchase developer support cases individually or in 5 and 10 packs. ● In the U.S. and Canada, and outside Europe, the Middle East, Africa, and Japan, contact: ● Adobe Solutions Network Adobe Systems Incorporated P.O. Box 609 Klamath Falls, OR 97601 ● For program information: Tel: +1-800-685-3510(US/Canada only) or +1-206-675-6145 Fax: +1-800-955-1610 ● For membership questions: E-mail: Web: ● In Europe, the Middle East, and Africa, contact: ● Adobe Solutions Network P.O. Box 12356 Edinburgh EH11 4GJ Scotland, United Kingdom ● For program information: Tel: +44 131 458 6800 Fax: +44 131 458 6801 ● For membership questions: E-mail: Web: In Japan, contact: ● Adobe Solutions Network Adobe Systems Co., Ltd. P.O. Box 43, Bunkyo Green Court Post Office 2-28-8 Hon-Komagome, Bunkyo-ku Tokyo 113-0021 Japan ● For program information: Tel: +81-3-5740-2620 Fax: +81-3-5740-2621 ● For membership questions: E-mail: Web: Registering Plug-in Prefixes Adobe has a Web page that developers can use for registering plug-in prefixes: In addition, to submit a proposal for first-class PDF names, use the following Web page: NOTE: The email address,, should no longer be used. See Appendix E of the PDF Reference for more information about the distinction between first-class, second-class and third-class names. 4
  5. 5. Acrobat 7.0.5 SDK Release Notes Adobe Dialog Manager The Adobe Dialog Manager (ADM) Programmer’s Guide and Reference is updated and corrected to match the latest version of ADM. The public ADM API available to developers in Acrobat 7.0 is essentially the same as that in Acrobat 6.0. Note that the SDK no longer supports the IADM wrappers. Direct use of the ADM C calling semantics is recommended. The use of ADM on the Macintosh operating system requires that plug-ins be “carbonized” (Acrobat 5.0) or use the plist (Acrobat 6.0 or higher) functionality. To download the Carbon™ SDK, see NOTE: Though the ADM functionality is visible in the headers, it is only supported on Windows and Macintosh platforms, and should not be used on any other platforms. Supported Development Environments The Acrobat 7.0.5 SDK supports the following compilers: ● Microsoft Windows 32-bit: Visual Studio .NET 2003 ● Macintosh operating system: Metrowerks CodeWarrior 9.2 and 9.3 NOTE: Evaluation versions of these development environments are not supported. Compiling the 7.0.5 SDK samples is supported using CodeWarrior 9.2 and 9.3 on the Mac OS X versions 10.2.8 – 10.3.9. If you are using CodeWarrior 9.5 or 9.6 on Mac OS X 10.4 and are experiencing compilation errors while building the SnippetRunner sample, make sure you recompile the BSD precompiled header (MacHeadersMach- O), followed by the MSL precompiled header, after updating your CodeWarrior application from 9.2 or 9.3 to 9.5 or 9.6. Please refer to your CodeWarrior patching documentation to determine how to rebuild these precompiled headers. Supported Operating Systems The Acrobat 7.0.5 SDK supports the following operating systems: ● Microsoft Windows: Windows 2000 with SP2, Windows XP Professional or Home Edition or Tablet PC Edition ● Macintosh: Mac OS X versions 10.2.8 - 10.3.9, 10.4 (see Supported Development Environments for more information) ● Linux: See Developing for Adobe Reader for supported versions 5
  6. 6. Acrobat 7.0.5 SDK Release Notes Tools API Locator The API locator is a new tool that enables you to browse and search all APIs and their descriptions supported by Acrobat in a hierarchical manner, and links each API to its use in source code provided in the Acrobat SDK. Visual Studio Plug-in Wizard The Plug-in Wizard is a rapid development tool that is used to generate a skeleton Visual C++ .NET project. The feature set implemented by the tool includes simple user interface elements, HFT support and notification hooks. Verify URLs Plug-in (Macintosh only) VerifyURLs is a tool that scans a document for all of the link annotations with "World Wide Web Link" actions and verifies that the URL associated with those annotations points to valid resources. Plug-in Loader Plug-in Loader allows you to engage in plug-in debugging sessions without having to quit and restart Acrobat. Reader Enabling This tool is used to enable your plug-ins for Adobe Reader. For more information, see Adobe Reader-enabled Plug-ins. Show Permissions This tool checks operation permissions on PDF files. For more information, see the Guide to SDK Samples. 6
  7. 7. Acrobat 7.0.5 SDK Release Notes Known Issues In This Release ● (Acrobat JavaScript) Any URI action that uses the javascript: <client-side JavaScript> protocol specifier fails unconditionally without raising an exception. Such a protocol can be introduced, for example, by the Open a Web link action of a form button or link created through the Acrobat user interface, or through the pdfmark operator. ● (Acrobat and PDF Library API Reference) The PDPageLabelNew method throws a pdErrBadBaseObj exception if NULL is passed to its style parameter. ● The PDSysFontAcquirePlatformData method should return a data structure that contains, among its elements, paths to the system font being specified in the parameters of the method. Instead, it returns NULL for the two elements fontPath and afmPath. ● The PDBookmarkGetIndent method should return the indentation level of aBookmark in its containing tree. The root and its direct children have an indentation level of 0. ● The WWWOpenURL and WWWOpenURLWithParams methods use the HTTP GET method to upload the data for the cFormData parameter. ● If the AVDocPrintOverrideData structure is used to force 1-bit monochrome or 8- bit gray, the preview feature in Acrobat 7.0 still shows the result in full color. ● To use AVPageViewInvertQuad in plug-ins that must run on versions 5 and lower, you should add the following code to AVCompat.cpp and call the AVPageViewInvertQuadCompat routine instead. The new routine adds a wrapper to change the size of the arguments down for Acrobat 5.0. The Quad parameter was changed from 16-bit to 32-bit for Acrobat 6.0 but the compatibility code to handle this change was inadvertantly left out of the compatibility file. typedef struct _oldQuad { ASInt16 tlh, tlv; ASInt16 trh, trv; ASInt16 blh, blv; ASInt16 brh, brv; } oldQuad; void AVPageViewInvertQuadCompat(AVPageView pageView, const Quad *quad, ASBool highlight) { if (gAcroViewVersion >= AcroViewHFT_VERSION_6) AVPageViewInvertQuad(pageView, quad, highlight); //call 6.0+ version else { oldQuad oldq; oldq.tlh = StepDown(quad->tlh); oldq.tlv = StepDown(quad->tlv); oldq.trh = StepDown(quad->trh); = StepDown(quad->trv); oldq.blh = StepDown(quad->blh); 7
  8. 8. Acrobat 7.0.5 SDK Release Notes oldq.blv = StepDown(quad->blv); oldq.brh = StepDown(quad->brh); oldq.brv = StepDown(quad->brv); AVPageViewInvertQuad(pageView, (const Quad *)&oldq, highlight); //call earlier version at same location } } ● When using Interapplication Communication under Acrobat 5.0, if you called Lock, the user could still use Acrobat. This is no longer the case. ● AFLayoutIconText in FormsHFT.h should not be used. ● AFLayoutTextEx in FormsHFT.h should not be used. ● AFPDFieldValueChanged in FormsHFT.h should not be used. ● ASFileSysGetStorageFreeSpace returns 0 if the path supplied to it is greater than 127 characters. The PDPageMarkFlags were inadvertantly left out of PDExpT.h. They will be added back in for a future release. They are documented in the Acrobat and PDF Library API Reference. enum { kPDPageEmitColorBars = 0x0001, kPDPageEmitRegMarks = 0x0002, kPDPageEmitCropMarks = 0x0004, kPDPageEmitBleedMarks = 0x0008, kPDPageEmitPageInfo = 0x0010, kPDPageEmitTrimMarks = 0x0020, kPDPageEmitSlurMarks = 0x0040 }; typedef ASUns32 PDPageMarkFlags; The following should not be used. They will be removed from the header files in a future release: ● ASFileSysGetPlatformThing ● PDSElementInsertMCAsKidEx ● WinAppLockViewer ● ASTextEvalProc ● PDSysFontGetScript ● PDScript ● AVAppGetPMPageFormat ● AVAppGetPMPrintSettings ● ASFileClearOutstandingMReads ● ASFileMReadRequest ● ASFileSysSetModeProc 8
  9. 9. Acrobat 7.0.5 SDK Release Notes ● kASFileDoCaching ● AVMouseEvent ● PDTextSelectEnumRTFTextProc ● AVAppGetPrefAtom ● AVAppGetPrefBool ● AVAppGetPrefCab ● AVAppGetPrefDouble ● AVAppGetPrefInt ● AVAppGetPrefPathName ● AVAppGetPrefString ● AVAppGetPrefText ● ASCabGetPointerRaw ● ASCabPutPointerRaw ● ASCabDetachPointerRaw ● PDPageArea ● PDTextAnnotIsOpen and PDTextAnnotSetOpen do not correctly determine and set whether a text annotation is open. Beginning with Acrobat 4.0 (PDF 1.3), text annotations (and other annotations) have an associated Popup annotation which maintains the open state of the popup window. PDTextAnnotIsOpen and PDTextAnnotSetOpen work correctly when passed the popup annotation itself. It is possible to use Cos-level routines to find the /Popup entry in the annotation dictionary, which is itself a dictionary containing an /Open entry. ● AppleScript: Opening the Acrobat 5.0 scripting dictionary - There is a problem under certain Macintosh configurations. If you attempt to open the Acrobat scripting dictionary when Acrobat is not running, either directly from the Script Editor or by dragging the Acrobat 5.0 icon onto the Script Editor icon, the Script Editor is unable to open the dictionary. The Script Editor may appear to hang; in reality it will display a dialog after several minutes, indicating that the dictionary can't be opened. To avoid this problem, launch Acrobat first. ● AppleScript samples: Note that you need to use the pathname instead of the name of the document when referring to a PDF document that has been given a custom (as opposed to the default) title. This is a title that has been specified using the File > Document Properties > Description panel. This bug does not apply to documents that show the default name of the file (in the title bar). 9
  10. 10. Acrobat 7.0.5 SDK Release Notes ● ASFixedToFloat macro does not calculate a float, as its name suggests. Rather it returns a double. The result is that the following statement, in Microsoft Visual C++, produces a compiler warning and one must cast the result to silence the warning: float fl = ASFixedToFloat(f) ● For the methods PDSElementGetAlt, PDSElementGetActualText, PDSElementGetLanguage, and PDSElementGetTitle, you should be aware that there is a bug in the code that attempts to incorrectly NULL-terminate strings. Therefore, buffers passed must be one byte bigger than required. This extra byte can be ignored on return from the call. ● If Plug-in Loader is used to unload the Search plug-in and Search is subsequently launched, Acrobat crashes on both Macintosh and Windows systems. 10