Developing Plug-ins and Applications - Adobe Open Source

1 Developing Plugins and Applications1/28/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.

2 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 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.

3 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. Unpublished-rights reserved under the copyright laws of the United States. Adobe Inc., 345 Park Avenue, San Jose, CA 95110-2704, USA 3 ContentsList of Examples.

4 121 Introduction to Plugin the Acrobat core core API core API PDF Library and plugin Acrobat and Adobe a PDF document in an external searching ..23 Modifying file new annotation adding text to PDF documents ..24 Understanding your target application ..24 Registering plugins for use by the plugin finder ..25 PDF dictionary extensions ..252 Understanding Plugins ..26 About plugin initialization ..26 Plugin loading and ..26 Exporting HFTs and registering for ..28 Summarizing a plugin s life callback ..30 Handling presses ..30 Using plugin prefixes ..30 Obtaining a developer PDF name a developer prefix ..31 Plugin prefixes ..31 Menu items prefixes ..31 Tool prefixes ..31 Toolbar button data identified using second-class << /First 2 /Second << /Third [ 2 3 ] >> >>32 Action prefixes.

5 32 Adobe Acrobat SDKD eveloping Plug-ins and Applications 4 HFT prefixes ..32 Modifying the Acrobat or Adobe Reader user or removing menus and menu items ..32 Modifying toolbars ..33 Controlling the About box and splash help interface and releasing objects ..34 Debugging view screen redrawing ..35 Storing private data in PDF data from PDF document objects ..363 Creating Plugin and PDF Library with platform-specific platform-dependent data ..38 Portability techniques ..39 Windows techniques ..39 Developing Windows and loading plugins ..39 Why a plugin might not and project settings ..40 Interapplication the thread local storage (TLS) modal dialog OS a Mac OS and loading plugins.

6 44 Using memory ..44 Resource file OS-only a sample plugin ..46 Including Acrobat SDK library the PIMain Source file ..47 Adding application and building your plugin ..47 Creating a sample PDF Library of the PDF Library library files ..48 Sample Applications with the Adobe PDF ..50 Mac and ..52 Upgrading existing plugins ..52 Detecting supported Acrobat SDKD eveloping Plug-ins and Applications 5 migrating a PDF Library application from CodeWarrior to Inserting Text into PDF Documents ..54 About inserting text into a PDF a new PDF a new a container ..55 Acquiring fonts ..55 Creating a PDEG raphicState an ASFixedMatrix object ..57 Inserting the PDF a PDF Library application Source Working with Documents and Files.

7 64 Opening PDF a PDF document in an external a the parameters for an external a handler for an external an open dialog box ..68 Displaying a PDF document within a window ..71 Determining the PDF version of a document ..75 PDF version ..75 PDF version the extension level of a document ..75 Getting the extension level of a core API layers ..76 Creating a PDDoc object ..76 Creating a PDDoc object based on an open PDF non-PDF with the PDF/X Creating Menus and Menu menus ..82 About AVmenubar AVMenu AVMenuItem menu commands to menus ..83 Adding a menu command to an existing a menu command to a new menu ..86 Creating menu callback functions ..87 Determining if a menu item can be executed.

8 897 Creating Toolbars and Buttons ..90 About toolbars ..90 About AVToolBar typedefs ..90 About AVToolButton toolbars ..91 Creating toolbar help text for a label text ..94 Adobe Acrobat SDKD eveloping Plug-ins and Applications 6 Creating a sub-menu for a button ..95 Retrieving existing toolbar a button to a toolbar ..96 Exposing a button in a web a button from a toolbar button callback Creating 100 Working with text annotations .. 100 Creating text 100 Retrieving existing 102 Modifying text 103 Working with redaction 104 Creating a redaction annotation .. 105 Modifying an existing redaction annotation .. 105 Applying redaction annotations (removing redacted content) .. 1059 Working with Bookmarks.

9 107 About 107 Creating 108 Defining bookmark 108 Creating a PDViewDestination 109 Creating a AVPageView object .. 110 Assigning an action to a bookmark .. 110 Removing bookmark 111 Opening and closing 111 Retrieving 112 Retrieving the root 112 Retrieving a specific 112 Retrieving all 113 Deleting 11410 Working with Page Views and page 116 About page views .. 117 Displaying page 117 Modifying page contents .. 118 Creating a PDEC ontent object .. 119 Accessing page contents .. 120 Determining page element 120 Modifying text elements .. 12111 Working with searching for words .. 124 About PDWord typedefs .. 124 About PDWordFinder typedefs .. 125 Creating a PDWordFinder 125 Extracting and displaying words.

10 127 Highlighting 12912 Creating 131 Adobe Acrobat SDKD eveloping Plug-ins and Applications 7 Action 131 Annotation handlers .. 132 AVCommand handlers .. 133 Creating an AVCommand 133 Invoking 133 Configuring AVCommands .. 134 Setting input 134 Setting configuration parameters .. 134 Setting AVCommand 135 Running 135 Exposing AVCommands to the batch 136 Adding a handler to the global command 136 Supporting properties .. 137 File format conversion handlers .. 137 File specification 138 Selection 138 Tool 139 Window handlers .. 139 File 140 Progress monitors .. 141 Transition handlers .. 141 Adding message 14213 Registering for Event event notifications .. 143 Unregistering event notifications.